List Payouts

Returns a paginated list of the payouts of your account, newest first. Every filter is optional and all the filters that are sent are combined.

GET /v3/payout

List Payouts

cURL

curl --request GET \
  --url https://service-sandbox.tazapay.com/v3/payout \
  --header 'Authorization: Basic <encoded-value>'

200

{
  "status": "success",
  "message": "",
  "data": {
    "object": "list",
    "has_more": false,
    "results": [
      {
        "amount": 3000000,
        "balance_transaction": "btr_dhuvflvi5frlneafr0",
        "beneficiary": "bnf_d0dla9u8dpp4edio0",
        "beneficiary_details": {
          "address": null,
          "date_of_birth": "",
          "destination": "",
          "destination_details": {
            "bank": {
              "account_type": "",
              "bank_codes": {
                "swift_code": "FBDEFF"
              },
              "bank_name": "ER VOLKSBANK EG",
              "branch_name": "",
              "country": "DE",
              "currency": "EUR",
              "firc_required": false,
              "iban": "DE535019045650474185",
              "purpose_code": "",
              "transfer_type": "any"
            },
            "type": "bank"
          },
          "documents": [],
          "email": "",
          "name": "GMBH",
          "name_local": "",
          "national_identification_number": "",
          "party_classification": "",
          "phone": {
            "calling_code": "49"
          },
          "registration_number": "",
          "tax_id": "",
          "type": "business"
        },
        "charge_type": "",
        "confirmation_documents": [],
        "created_at": "2025-09-16T08:27:41.832Z",
        "currency": "EUR",
        "documents": [],
        "holding_currency": "USD",
        "holding_fx_quote": "fx_d34hc7loipp34fmg",
        "holding_fx_transaction": {
          "exchange_rate": 0.846438,
          "final": {
            "amount": 3000000,
            "currency": "EUR"
          },
          "id": "fx_d34flc7loipp34fmg",
          "initial": {
            "amount": 3544266,
            "currency": "USD"
          },
          "object": "fx_transaction"
        },
        "id": "pot_d34hlvi5frlneafo0",
        "local": {
          "fund_transfer_network": "sepa"
        },
        "logistics_tracking_details": [],
        "metadata": null,
        "mt103": "",
        "object": "payout",
        "on_behalf_of": "",
        "payout_fx_transaction": {
          "exchange_rate": 1,
          "final": {
            "amount": 3000000,
            "currency": "EUR"
          },
          "id": "fx_d34huvflc7pp34fm0",
          "initial": {
            "amount": 3000000,
            "currency": "EUR"
          },
          "object": "fx_transaction"
        },
        "purpose": "PYR001",
        "reference_id": "DE-LOG-2024-0909",
        "statement_descriptor": "Logistics Payment",
        "status": "succeeded",
        "status_description": "",
        "failure": null,
        "tracking_details": {
          "tracking_number": "098771252590P9A",
          "tracking_type": "UTR"
        },
        "transaction_description": "Payment for logistic services 9-09",
        "type": "local"
      }
    ]
  }
}

Authorizations

Authorization · string · header · required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

limit · integer<int32> · default: 10

Number of payouts to return, from 1 to 100. Default is 10.

Required range: 1 <= x <= 100

starting_after · string

A payout ID (starts with pot_) used as a cursor. Returns the payouts created after this payout, oldest first. Cannot be used together with ending_before.

ending_before · string

A payout ID (starts with pot_) used as a cursor. Returns the payouts created before this payout, newest first. Cannot be used together with starting_after.

created.gt · string<date-time>

Returns payouts created after this time (RFC 3339, e.g. 2026-10-01T00:00:00Z).

created.gte · string<date-time>

Returns payouts created at or after this time. Cannot be used together with created.gt.

created.lt · string<date-time>

Returns payouts created before this time.

created.lte · string<date-time>

Returns payouts created at or before this time. Cannot be used together with created.lt.

type · enum<string>

Filter by the type of the payout.

Available options: local, swift, wallet, local_payment_network, tazapay_account

local.fund_transfer_network · string

Filter local payouts by the fund transfer network, exact match and case insensitive, e.g. sepa.

swift.charge_type · enum<string>

Filter swift payouts by the charge type.

Available options: shared, ours

beneficiary · string

Filter by the beneficiary ID (starts with bnf_).

status · enum<string>

Filter by the status of the payout.

Available options: requires_approval, requires_action, requires_funding, requires_confirmation, compliance_hold, approval_hold, initiator_bank_hold, processing, succeeded, failed, cancelled, reversed

on_behalf_of · string

Filter by the entity the payouts were made on behalf of (starts with ent_).

Response

200

application/json

List of payouts.

status · string

Status of API request

message · string

Message returned as part of the API response

data · object

Show child attributes