Skip to main content
GET
/
payouts
/
{payout_id}
Get Payout
curl --request GET \
  --url https://api.zopay.cash/connect/v1/payouts/{payout_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "timeline": [
    {
      "at": "2023-11-07T05:31:56Z",
      "tx_hash": "<string>"
    }
  ],
  "fees_paid_usd": "<string>",
  "final_recipient_amount": "<string>"
}
Status + timeline for an existing payout. Sandbox returns a fully-delivered timeline so partners see the happy-path shape immediately; production reads transaction_saga_events for the real progression. Either way the shape is identical. Cross-tenant lookups collapse to 404 payout_not_found in production. Sandbox doesn’t enforce tenant scoping (there is no real payout to scope) and returns a canned body for any well-formed id.

Authorizations

​
Authorization
string
header
required

Paste your Connect API key (sk_live_… for production, sk_test_… for sandbox) without the Bearer prefix. Mint and rotate keys from the admin panel.

Headers

​
authorization
string | null

Path Parameters

​
payout_id
string
required

Response

Successful Response

Response body for GET /payouts/:id.

Extends the execute response with the timeline + actual fees + final amount once known.

​
id
string
required
​
status
enum<string>
required
Available options:
pending,
broadcast,
delivered,
failed
​
timeline
ConnectPayoutTimelineEntry · object[]
required
​
fees_paid_usd
string
required

Actual fee paid, may differ from the quoted fee_total_usd for routes where the gas oracle came in cheaper / more expensive than expected. Stable after status=delivered.

​
final_recipient_amount
string
required

Actual amount that landed at the destination. Equals the quoted recipient_gets for native routes; for bridge routes it may differ marginally.