Create bulk payout

POST

/payouts/bulk

Last modified:2025-12-02 10:06:51

Uploads a CSV file to storage and kicks off a payout batch. Clients must supply an idempotency key via the idempotency-key header.

Request

Header Params

Body Params multipart/form-data

Responses

🟢200Success

application/json

Default Response

Body

🟠400400

🟠401401

🟠403403

🟠404404

🟠405405

🟠409409

🟠410410

🟠422422

🟠429429

🔴500500

🔴501501

🔴503503

🔴504504

🔴505505

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/payouts/bulk' \
--header 'idempotency-key;' \
--form 'file=@""'

Response Example

200 - example1

{
    "batch_id": "batch_01HZY6ZQ4J8ZKFE20QG93DYD3A",
    "original_file_name": "merchant-payouts-nov-2024.csv",
    "status": "PROCESSING",
    "created_at": "2024-11-19T10:00:00.000Z"
}

Modified at 2025-12-02 10:06:51

Get payout status

Get bulk payout status