Skip to main content
GET
/
v1
/
payouts
List payouts
curl --request GET \
  --url https://api.example.com/v1/payouts \
  --header 'Authorization: Bearer <token>'
{
  "hasMore": true,
  "payouts": [
    {
      "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"
    }
  ],
  "nextCursor": "2024-01-15T10:30:00.000Z__a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Documentation Index

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

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

Authorizations

​
Authorization
string
header
required

Enter Auth0 JWT token

Query Parameters

​
beneficiaryId
string<uuid>

Filter by beneficiary ID

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
status
string

Filter by status (comma-separated)

Example:

"processing,paid"

​
country
string

Filter by country code (comma-separated)

Example:

"DE,GB"

​
route
string

Filter by payment route (comma-separated)

Example:

"sepa_inst,sepa_credit"

​
provider
string

Filter by provider/account holder name

Example:

"Ivy"

​
startDate
string<date-time>

Start date for date range filter (ISO 8601)

Example:

"2024-01-01T00:00:00Z"

​
endDate
string<date-time>

End date for date range filter (ISO 8601)

Example:

"2024-12-31T23:59:59Z"

​
minAmount
number

Minimum amount filter

Example:

100

​
maxAmount
number

Maximum amount filter

Example:

1000

​
cursor
string

Cursor for pagination (composite: timestamp__uuid)

Example:

"2024-01-15T10:30:00.000Z__a1b2c3d4-e5f6-7890-abcd-ef1234567890"

​
limit
number
default:20

Number of items per page

Required range: 1 <= x <= 100
Example:

20

Response

List of payouts

​
hasMore
boolean
required

Whether there are more payouts to load

Example:

true

​
payouts
object[]
required

List of payouts

​
nextCursor
string

Next cursor for pagination (composite: timestamp__uuid)

Example:

"2024-01-15T10:30:00.000Z__a1b2c3d4-e5f6-7890-abcd-ef1234567890"