Create bulk payout

POST

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

Last modified:2025-12-03 10:51:05

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

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.staging.vrtx.sa/payouts/bulk' \
--header 'idempotency-key;' \
--form 'file=@""'

Responses

🟢200OK

application/json

Default Response

Body

Examples

example1example2

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

🟠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

Modified at 2025-12-03 10:51:05

Get payout status

Get bulk payout status