Initiate Bulk Payout

POST

https://api.crisscross.money/v1/payout/initiate/bulk

POST

/v1/payout/initiate/bulk

$ curl -X POST https://api.crisscross.money/v1/payout/initiate/bulk \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "payouts": [
>     {
>       "merchantId": "merchant_987654321",
>       "merchantReference": "order_123456789",
>       "destinationValue": {
>         "minorAmount": 250000,
>         "currency": "NGN"
>       },
>       "paymentMethodId": "banktransfer",
>       "paymentLocation": "NGA",
>       "sender": {
>         "fullName": "Jane Doe",
>         "identity": "passport",
>         "identityNumber": "A12345678"
>       }
>     }
>   ]
> }'

1 {
2   "message": "Bulk payout batch accepted and is being processed.",
3   "batchId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4   "monitorUrl": "https://api.crisscross.money/v1/payout/batch/3fa85f64-5717-4562-b3fc-2c963f66afa6/status"
5 }

Initiates many payouts in a single request by providing a list of payout objects, each in the same shape accepted by Initiate Payout. The batch is processed asynchronously — use the returned batchId and monitorUrl to track progress.

Each item in payouts is validated independently. If any item fails validation, the entire request is rejected with a 422 so you can correct the input and resubmit the whole batch.

Initiates many payouts in a single request by providing a list of payout objects, each in the same shape accepted by [Initiate Payout](#operation/initiatePayout). The batch is processed asynchronously — use the returned `batchId` and `monitorUrl` to track progress. Each item in `payouts` is validated independently. If any item fails validation, the entire request is rejected with a `422` so you can correct the input and resubmit the whole batch.

Authentication

AuthorizationBearer

OAuth 2.0 access token issued by the CrissCross authorisation server.

Request

This endpoint expects an object.

payoutslist of objectsRequired

List of payout objects to initiate. Each item uses the same shape as the single Initiate Payout request.

batchIdstringOptionalformat: "uuid"

Optional client-supplied batch ID. If omitted, one will be generated and returned in the response.

Response

Bulk payout accepted for processing.

messagestring

Human-readable confirmation that the batch was accepted.

batchIdstring

Identifier for the accepted batch.

monitorUrlstring

URL you can poll to monitor batch progress.

Errors

400

Bad Request Error

401

Unauthorized Error

422

Unprocessable Entity Error

500

Internal Server Error