Skip to main content
POST
/
api
/
v2
/
payouts
/
batch
Create a batch of up to 200 payouts. Per-item failures are reported individually
curl --request POST \
  --url https://api.pawpayments.com/api/v2/payouts/batch \
  --header 'Content-Type: application/json' \
  --header 'X-Uniq-Id: <x-uniq-id>' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "items": [
    {
      "address": "<string>",
      "amount": 1,
      "fiat_currency": "<string>",
      "asset": "<string>",
      "ref": "<string>"
    }
  ]
}
'
{
  "ok": true,
  "result": {
    "batch_id": "b_2026_001",
    "items": [
      {
        "order_id": "65f1c3a4e8b1c2d3a4b5c6e0",
        "status": "pending"
      },
      {
        "error": "Insufficient balance",
        "order_id": null,
        "status": "failed"
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.pawpayments.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Headers

​
X-Uniq-Id
string
required

UUIDv4 for idempotency.

Body

application/json
​
items
BatchPayoutItem · object[]
required
Required array length: 1 - 200 elements

Response

Created

​
ok
boolean
required
​
result
BatchPayoutResult · object
required
Example:
{
  "batch_id": "b_2026_001",
  "items": [
    {
      "order_id": "65f1c3a4e8b1c2d3a4b5c6e0",
      "status": "pending"
    },
    {
      "error": "Insufficient balance",
      "order_id": null,
      "status": "failed"
    }
  ]
}