Create bulk payout

POST

https://api.staging.vrtx.sa/payouts/bulk

Last modified:2026-04-20 16:17:26

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

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Header Params

Body Params multipart/form-dataRequired

Responses

🟢200OK

application/json

Default Response

Body

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

🟠405Method Not Allowed

🟠409Conflict

🟠410Gone

🟠422Unprocessable Entity

🟠429Too Many Requests

🔴500Internal Server Error

🔴501Not Implemented

🔴503Service Unavailable

🔴504Gateway Timeout

🔴505HTTP Version Not Supported

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.staging.vrtx.sa/payouts/bulk' \
--header 'idempotency-key;' \
--header 'Authorization: Bearer <token>' \
--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 2026-04-20 16:17:26

Get payout status

Get bulk payout status