Skip to main content
GET
/
v1
/
payouts
/
{id}
/
receipt
Get payout receipt
curl --request GET \
  --url https://api.example.com/v1/payouts/{id}/receipt \
  --header 'Authorization: Bearer <token>'
{
  "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"
      }
    ],
    "country": "DE",
    "createdAt": "2024-01-15T10:30:00Z",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "John Doe",
    "status": "active",
    "type": "individual",
    "updatedAt": "2024-01-15T10:30:00Z",
    "address": "Hauptstraße 123",
    "addressLine2": "Apt 4B, 3rd Floor",
    "city": "Berlin",
    "countrySubdivision": "NY",
    "email": "john.doe@example.com",
    "middleName": "James",
    "notes": "Regular client, prefers SEPA Instant",
    "postcode": "10115"
  },
  "createdAt": "2024-01-15T10:30:00Z",
  "currency": "EUR",
  "fee": "2.50",
  "payoutId": "123e4567-e89b-12d3-a456-426614174000",
  "receiptNumber": "RCP-2024-001-123456",
  "route": "sepa_inst",
  "status": "paid",
  "completedAt": "2024-01-15T10:40:00Z",
  "processedAt": "2024-01-15T10:32:00Z",
  "reference": "PAYOUT-2024-001"
}

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

Path Parameters

​
id
string<uuid>
required

Unique identifier for the payout

Example:

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

Response

Payout receipt

​
amount
string
required

Amount of the payout (as string to avoid floating-point precision issues)

Example:

"100.50"

​
beneficiary
object
required

Beneficiary information

​
createdAt
string<date-time>
required

Creation timestamp

Example:

"2024-01-15T10:30:00Z"

​
currency
enum<string>
required

Currency code (ISO 4217). Default enabled currencies: EUR, USD, GBP, USDC, EURC, NGN. Contact your account manager to enable additional currencies.

Available options:
EUR,
USD,
GBP,
USDC,
EURC,
NGN,
XOF,
XAF,
GHS
Example:

"EUR"

​
fee
string
required

Fee charged for the payout (as string to avoid floating-point precision issues)

Example:

"2.50"

​
payoutId
string<uuid>
required

Unique identifier for the payout

Example:

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

​
receiptNumber
string
required

Unique receipt number

Example:

"RCP-2024-001-123456"

​
route
enum<string>
required

Payment route used

Available options:
sepa_inst,
sepa_credit,
paysend,
bank_transfer,
ach,
fedwire
Example:

"sepa_inst"

​
status
enum<string>
required

Status of the payout

Available options:
created,
queued,
processing,
paid,
failed,
cancelled
Example:

"paid"

​
completedAt
string<date-time>

Completion timestamp

Example:

"2024-01-15T10:40:00Z"

​
processedAt
string<date-time>

Processing start timestamp

Example:

"2024-01-15T10:32:00Z"

​
reference
string

Reference for the payout

Example:

"PAYOUT-2024-001"