İçeriğe geç
Apex Settlement
Incoming payouts

Get an incoming payout

Gereken izincustomer:readAPI referansındaki uç nokta açıklamaları İngilizcedir.
GET
/v1/incoming-payouts/{id}

One Payout another Customer sent this Customer, as GET /v1/incoming-payouts lists it: who sent it, what arrives, the purpose the sender declared, where it stands and, once delivered, whether it was credited to the Customer's balance or paid to its bank account.

Requires the customer:read permission. A Platform may call it for one of its End Customers with Apex-End-Customer.

Yetkilendirme

ApiKey
headerYetkilendirmeBearer <API key>

A Customer API key, created by a Customer admin in the Customer panel and shown once: Authorization: Bearer ak_live_… in production, ak_test_… elsewhere. A key holds a subset of its creator's permissions and may be limited to named IP addresses and an expiry date. Keys never manage people, other keys or approval rules, and never approve a Payout.

Yol parametreleri

id*string

The Payout's id.

Biçimuuid

Başlık parametreleri

Apex-End-Customer?string

A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers end_customer_not_found.

Biçimuuid

Yanıt gövdesi

OK

application/json
  1. response
account_hint*string

account_hint is the last four characters of the account paid; empty for a balance credit.

amount*

amount is what arrives.

created_at*string
Biçimdate-time
delivered_at*|

delivered_at is when the last Leg, the one that pays the account or credits the balance, settled; null until the Payout is delivered.

Biçimdate-time
delivered_to*string

delivered_to is where the Payout ends: balance (credited to this Customer's balance) or bank_account (paid to its Receiving Account).

Değerin yeri"balance""bank_account"
id*string
purpose*string
Değerin yeri"services""payroll""supplier""goods""digital_goods"
sender_name*string
status*string
Değerin yeri"on_the_way""delivered""delayed""returned"
updated_at*string
Biçimdate-time
Örnek istek
curl -X GET 'http://localhost:3480/v1/incoming-payouts/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Örnek yanıt
{  "account_hint": "4321",  "amount": {    "amount": "277664.5",    "asset": "PKR"  },  "created_at": "2026-11-12T09:30:02Z",  "delivered_at": "2026-11-12T09:41:17Z",  "delivered_to": "bank_account",  "id": "0e1f2a3b-4c5d-4e6f-8a7b-9c0d1e2f3a4b",  "purpose": "services",  "sender_name": "Tom Becker",  "status": "delivered",  "updated_at": "2026-11-12T09:41:17Z"}