Payouts

Create a batch of payouts

Creates up to 200 pending payouts that share one batch_id. Every row is checked before any payout is created, so one invalid row creates nothing. The business approves each payout from its payout wallet. Rate limit: 20 per minute per API key, counted separately from other endpoints.

POST
/api/v1/payouts/batch

Authorization

bearerAuth
headerAuthorizationBearer <token>

A live API key, sk_live_ followed by 32 base58 characters.

Header Parameters

Idempotency-Key?string

A unique string of 1 to 255 characters for this operation. A key belongs to the business across every endpoint for 24 hours, so give each operation its own key, for example invoice-order-1042 and refund-order-1042, not the order id alone. A retry with the same key on the same endpoint and with the same body returns the stored response with the header Idempotent-Replayed: true. The same key with a different body or on another endpoint returns 409 idempotency_conflict. Errors are not stored, so a request that failed can be retried with the same key, even with a corrected body. While the first request with a key is still running, a retry gets 409 idempotency_conflict with Retry-After: 1.

Length1 <= length <= 255

Request Body

application/json
  1. body
payouts*array<>
Items1 <= items <= 200

Response Body

The created payouts.

application/json
  1. response
object*string
id*string

Batch id (starts with bat_).

data*array<>
Example Request
curl -X POST 'https://example.com/api/v1/payouts/batch' \  -H 'Content-Type: application/json' \  -d '{  "payouts": [    {      "recipient": "string",      "asset_id": "string",      "amount": "string"    }  ]}'
Example Response
{  "object": "payout_batch",  "id": "string",  "data": [    {      "id": "string",      "object": "refund",      "status": "pending",      "invoice_id": "string",      "batch_id": "string",      "amount": "string",      "source_asset": "string",      "asset_id": "string",      "recipient": "string",      "tx_hash": "string",      "failure_reason": "string",      "sign_url": "http://example.com",      "created_at": "2019-08-24T14:15:22Z"    }  ]}