Global Payout Batches

List global payout batches

get/v1/global-payout-batches

Query parameters

limitnumber

Number of results to return (1-1000). Use with offset for traditional pagination.

offsetnumber

Number of results to skip. Use with limit for traditional pagination.

page_sizenumber

Number of results per page (1-1000). Use with starting_after for cursor-based pagination.

starting_afterstring

Cursor for pagination. Use the ID of the last item from the previous page to get the next page. Use with page_size for cursor-based pagination.

onBehalfOfstring

Example:cus_abc123

Filter by customer ID (onBehalfOf).

Filter by batch status.

Headers

X-API-Keystring

API key

Response

Global payout batches retrieved

totalnumber

limitnumber

offsetnumber

Example response

{
  "data": [
    {
      "id": "pb_abc123",
      "organizationId": "org_abc123",
      "onBehalfOf": "cus_abc123",
      "source": {
        "currency": "USDT",
        "paymentRail": "ETHEREUM"
      },
      "status": "DRAFT",
      "paymentReason": "PAYMENT_FOR_GOODS_AND_SERVICES",
      "items": [
        {
          "id": "pbi_abc123",
          "amount": {
            "currency": "USD",
            "exponent": 2,
            "value": "12345",
            "displayValue": "123.45"
          },
          "counterpartyId": "cp_abc123",
          "destination": {
            "type": "EXTERNAL_WALLET",
            "currency": "USDT",
            "paymentRail": "ETHEREUM",
            "accountId": "ewa_abc123",
            "address": "0x1234567890abcdef1234567890abcdef12345678"
          },
          "transferId": "tfr_abc123",
          "status": "PENDING",
          "clientReferenceId": "payroll_line_42",
          "developerFeeFixed": 100,
          "developerFeePercent": 0.015
        }
      ]
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.