Get payout
Quick Reference
WhatRetrieve a single payout
WhyCheck the current status and details of a payout you created
Reading Time3 min
DifficultyBeginner
PrerequisitesAuthentication → A payout_uuid and the funding wallet_uuid
GET
/api/v1/bank/wallet/payout/{payout_uuid}/{wallet_uuid}/Bearer TokenGet a payout scoped to a walletThe payout is scoped to its funding wallet: both payout_uuid and wallet_uuid go in the URL path. If the payout does not belong to the wallet, the API returns errors.wallet.payout_not_found.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
payout_uuid | string (UUID) | Yes | Payout to retrieve |
wallet_uuid | string (UUID) | Yes | Wallet that funded the payout |
Request headers
| Header | Value | Required |
|---|---|---|
Authorization | Bearer {A55_ACCESS_TOKEN} | Yes |
Response fields
Returns the same payout object as Create payout.
| Field | Type | Description |
|---|---|---|
payout_uuid | string | Internal payout identifier |
external_id | string | Provider's payout id |
status | string | Current payout status (pending, issued, realized, returned, canceled, error, expired) |
type_payout | string | Payout rail used |
amount | number (float) | Payout amount |
fee | number (float) | Provider fee |
currency | string | ISO 4217 currency |
description | string | Payout description |
beneficiary_name | string | Beneficiary name |
transaction_reference | string | Idempotency key used |
submitted_date | string | Date sent to the provider |
confirmed_date | string | Date confirmed |
payment_code | string | Cash pickup code (cash payouts only) |
authorization_code | string | Provider authorization code, when available |
destination | object | Echo of the destination data |
message | array | Provider/processing messages |
created | string | ISO 8601 creation timestamp |
updated | string | ISO 8601 last update timestamp |
Error responses
| Status | Code | Description |
|---|---|---|
| 401 | unauthorized | Invalid or expired Bearer token |
| 404 | errors.wallet.not_found | Wallet not found |
| 404 | errors.wallet.payout_not_found | Payout not found, or it does not belong to the wallet |
Code examples
- cURL
- Python
- Node.js
curl -s "https://sandbox.api.a55.tech/api/v1/bank/wallet/payout/9b1f0c88-3a3c-4f2f-9d6e-1f0a2d4e88c1/f47ac10b-58cc-4372-a567-0e02b2c3d479/" \
-H "Authorization: Bearer $A55_ACCESS_TOKEN"
import requests
import os
token = os.environ["A55_ACCESS_TOKEN"]
base = os.environ.get("A55_API_URL", "https://sandbox.api.a55.tech")
payout_uuid = "9b1f0c88-3a3c-4f2f-9d6e-1f0a2d4e88c1"
wallet_uuid = "f47ac10b-58cc-4372-a567-0e02b2c3d479"
payout = requests.get(
f"{base}/api/v1/bank/wallet/payout/{payout_uuid}/{wallet_uuid}/",
headers={"Authorization": f"Bearer {token}"},
).json()
print(f"Payout {payout['payout_uuid']} — status: {payout['status']}")
const token = process.env.A55_ACCESS_TOKEN;
const base = process.env.A55_API_URL || "https://sandbox.api.a55.tech";
const payoutUuid = "9b1f0c88-3a3c-4f2f-9d6e-1f0a2d4e88c1";
const walletUuid = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
const payout = await fetch(
`${base}/api/v1/bank/wallet/payout/${payoutUuid}/${walletUuid}/`,
{ headers: { Authorization: `Bearer ${token}` } }
).then((r) => r.json());
console.log(`Payout ${payout.payout_uuid} — status: ${payout.status}`);