Fetch Payout

This lets you fetch the details of an existing payout

GET /v3/payout/{id}

Fetch payout

cURL

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

200

Transfer with Tazapay

{
  "status": "success",
  "message": "",
  "data": {
    "amount": 44000,
    "balance_transaction": "btr_d35sqe74qcl8im850",
    "beneficiary": "bnf_d35spsnl8imrh3gv0",
    "beneficiary_details": {
      "address": {},
      "date_of_birth": "",
      "destination": "",
      "destination_details": {
        "tazapay_account": {
          "deposit_address": "ce4f51ue@tzp"
        },
        "type": "tazapay_account"
      },
      "documents": [],
      "email": "[e-mail]",
      "is_doc_verification_required": false,
      "name": "T Co., Limited",
      "name_local": "",
      "national_identification_number": "",
      "party_classification": "",
      "phone": {},
      "registration_number": "",
      "status": "active",
      "tax_id": "",
      "type": "business",
      "verification_status": "succeeded"
    },
    "charge_type": "",
    "confirmation_documents": [],
    "created_at": "2025-09-18T09:13:28.633167Z",
    "currency": "USD",
    "destination_fx_quote": "fx_d35sqe7figo4dsvt00",
    "documents": [],
    "holding_currency": "USD",
    "holding_fx_quote": "fx_d35sfigo4p2dsvsvg",
    "holding_fx_transaction": {
      "exchange_rate": 1,
      "final": {
        "amount": 44000,
        "currency": "USD"
      },
      "id": "fx_d35sqe7figo4p2dsvsvg",
      "initial": {
        "amount": 44000,
        "currency": "USD"
      },
      "object": "fx_transaction"
    },
    "id": "pot_d5sqe7cl8imrh4810",
    "local": {
      "fund_transfer_network": "ach"
    },
    "logistics_tracking_details": [],
    "metadata": null,
    "mt103": "",
    "object": "payout",
    "on_behalf_of": "",
    "payout_fx_transaction": {
      "exchange_rate": 1,
      "final": {
        "amount": 44000,
        "currency": "USD"
      },
      "id": "fx_d35sqe7figo4psvt00",
      "initial": {
        "amount": 44000,
        "currency": "USD"
      },
      "object": "fx_transaction"
    },
    "payout_quote": "",
    "purpose": "PYR003",
    "quote": "poq_d5sqe7cl8imrh4811",
    "reference_id": "TZP-ACC-2024-1892",
    "statement_descriptor": "Trading Payment",
    "status": "succeeded",
    "status_description": "",
    "tracking_details": {
      "tracking_number": "TZP-001-2024-9876",
      "tracking_type": "internal"
    },
    "transaction_description": "Payment for goods acc 001",
    "type": "tazapay_account",
    "available_balance": 150000000,
    "is_balance_sufficient": true
  }
}

Authorizations

Authorization · string · header · required

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

Path Parameters

id · string · required

ID of the existing payout

Response

200

application/json

200

status · string

Status of API request

Example:

"success"

message · string

Message returned as part of the API response

Example:

""

data · object

Show child attributes