Skip to main content
GET
/
v2
/
payouts
List payouts with opaque cursor pagination
curl --request GET \
  --url https://api.example.com/v2/payouts \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "amount": "100.50",
      "beneficiary": {
        "accounts": [
          {
            "createdAt": "2024-01-15T10:30:00Z",
            "currency": "EUR",
            "data": {
              "bic": "DEUTDEFF",
              "iban": "DE89370400440532013000"
            },
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "status": "active",
            "type": "iban",
            "updatedAt": "2024-01-15T10:35:00Z"
          }
        ],
        "createdAt": "2024-01-15T10:30:00Z",
        "email": "john.doe@example.com",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "John Doe",
        "status": "active",
        "updatedAt": "2024-01-15T10:35:00Z"
      },
      "createdAt": "2024-01-15T10:30:00Z",
      "currency": "EUR",
      "fee": "2.50",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "route": "sepa_inst",
      "status": "processing",
      "type": "fiat",
      "updatedAt": "2024-01-15T10:35:00Z",
      "balanceAfter": "98.87",
      "clientRef": "PAYOUT-REF-12345",
      "completedAt": "2024-01-15T10:40:00Z",
      "description": "Payment for services rendered",
      "failureCategory": "payment_not_approved",
      "failureReason": "Insufficient funds",
      "fxRate": "970.87378641",
      "inputAmount": "1.13",
      "inputCurrency": "EUR",
      "payoutAccountData": {
        "account": 123456789,
        "bankCode": "044",
        "crAccount": "0123456789"
      },
      "payoutAccountId": "123e4567-e89b-12d3-a456-426614174000",
      "processedAt": "2024-01-15T10:32:00Z",
      "providerReference": "TXN123456789",
      "reference": "January invoice",
      "uetr": "4afd0a57-03af-4138-9341-373a78891ea9"
    }
  ],
  "hasMore": true,
  "nextCursor": "eyJ2IjoxLCJjcmVhdGVkQXQiOiIyMDI2LTAxLTAxVDAwOjAwOjAwLjAwMFoiLCJpZCI6IjEyM2U0NTY3LWU4OWItNDJkMy1hNDU2LTQyNjYxNDE3NDAwMCJ9",
  "object": "payout.list"
}

Authorizations

​
Authorization
string
header
required

Enter Auth0 JWT token

Query Parameters

​
cursor
string

Opaque cursor returned by the previous page

​
limit
number
default:20

Number of items per page

Required range: 1 <= x <= 100
​
beneficiaryId
string<uuid>
​
status
enum<string>[]
Available options:
created,
queued,
processing,
paid,
failed,
cancelled
​
country
array[]

ISO 3166-1 alpha-2 country codes

Example:
["DE", "GB"]
​
route
enum<string>[]
Available options:
sepa_inst,
sepa_credit,
paysend,
bank_transfer,
ach,
fedwire,
swift,
crypto
​
provider
string
Maximum string length: 100
​
startDate
string<date-time>
​
endDate
string<date-time>
​
minAmount
string
Example:

"100.00"

​
maxAmount
string
Example:

"1000.00"

Response

​
data
object[]
required
​
hasMore
boolean
required

Whether more items exist after this page

Example:

true

​
nextCursor
string | null
required

Opaque cursor for the next page, or null when there are no more items

Example:

"eyJ2IjoxLCJjcmVhdGVkQXQiOiIyMDI2LTAxLTAxVDAwOjAwOjAwLjAwMFoiLCJpZCI6IjEyM2U0NTY3LWU4OWItNDJkMy1hNDU2LTQyNjYxNDE3NDAwMCJ9"

​
object
enum<string>
required

Stable resource-specific collection discriminator

Available options:
payout.list
Pattern: ^[a-z][a-z0-9_]*\.list$
Example:

"payout.list"