Create Bulk Payout

1min
A simple RESTful endpoint that allows you to initiate multiple payouts in a single call.
Please refer to Create Payout﻿ for details about the Payout object.
Create multiple payouts in a single call
POST
Request
Body Parameters
source_id
required
String
ID of the source Payout Account
payouts
required
Array
An array of payout objects. Please go to Create Payout section for more information.
JSON
{
    "source_id": "8292cb17-0ca4-42ce-b8b3-a7eba3af038f",
    "payouts": [
        {
            "amount": 20000,
            "currency": "SAR",
            "purpose": "personal",
            "destination": {
                "name": "Abdulaziz",
                "mobile": "0544424173",
                "type": "bank",
                "iban": "SA0380000000608010167519",
                "country": "KSA",
                "city": "Riyadh"
            }
        },
        {
            "amount": 50000,
            "currency": "SAR",
            "purpose": "personal",
            "destination": {
                "name": "Abdulaziz",
                "mobile": "0544424173",
                "type": "bank",
                "iban": "SA0380000000608010167519",
                "country": "KSA",
                "city": "Riyadh"
            }
        }
    ]
}
{
    "source_id": "8292cb17-0ca4-42ce-b8b3-a7eba3af038f",
    "payouts": [
        {
            "amount": 20000,
            "currency": "SAR",
            "purpose": "personal",
            "destination": {
                "name": "Abdulaziz",
                "mobile": "0544424173",
                "type": "bank",
                "iban": "SA0380000000608010167519",
                "country": "KSA",
                "city": "Riyadh"
            }
        },
        {
            "amount": 50000,
            "currency": "SAR",
            "purpose": "personal",
            "destination": {
                "name": "Abdulaziz",
                "mobile": "0544424173",
                "type": "bank",
                "iban": "SA0380000000608010167519",
                "country": "KSA",
                "city": "Riyadh"
            }
        }
    ]
}
Responses
200
[
    {
        "id": "5f896f5f-bb40-4265-8b6d-1eb4fcd4d4d1",
        "source_id": "8292cb17-0ca4-42ce-b8b3-a7eba3af038f",
        "status": "queued",
        "amount": 20000,
        "currency": "SAR",
        "purpose": "personal",
        "comment": null,
        "message": null,
        "destination": {
            "city": "Riyadh",
            "iban": "SA0380000000608010167519",
            "name": "Abdulaziz",
            "type": "bank",
            "mobile": "0544424173",
            "country": "KSA"
        }
    },
    {
        "id": "4f912b3d-ec49-4202-a46a-fc8c1aa4cb07",
        "source_id": "8292cb17-0ca4-42ce-b8b3-a7eba3af038f",
        "status": "queued",
        "amount": 50000,
        "currency": "SAR",
        "purpose": "personal",
        "comment": null,
        "message": null,
        "destination": {
            "city": "Riyadh",
            "iban": "SA0380000000608010167519",
            "name": "Abdulaziz",
            "type": "bank",
            "mobile": "0544424173",
            "country": "KSA"
        }
    }
]
[
    {
        "id": "5f896f5f-bb40-4265-8b6d-1eb4fcd4d4d1",
        "source_id": "8292cb17-0ca4-42ce-b8b3-a7eba3af038f",
        "status": "queued",
        "amount": 20000,
        "currency": "SAR",
        "purpose": "personal",
        "comment": null,
        "message": null,
        "destination": {
            "city": "Riyadh",
            "iban": "SA0380000000608010167519",
            "name": "Abdulaziz",
            "type": "bank",
            "mobile": "0544424173",
            "country": "KSA"
        }
    },
    {
        "id": "4f912b3d-ec49-4202-a46a-fc8c1aa4cb07",
        "source_id": "8292cb17-0ca4-42ce-b8b3-a7eba3af038f",
        "status": "queued",
        "amount": 50000,
        "currency": "SAR",
        "purpose": "personal",
        "comment": null,
        "message": null,
        "destination": {
            "city": "Riyadh",
            "iban": "SA0380000000608010167519",
            "name": "Abdulaziz",
            "type": "bank",
            "mobile": "0544424173",
            "country": "KSA"
        }
    }
]
﻿
﻿
Updated 27 Aug 2024
Did this page help you?
Create Payout
Fetch Payout