Skip to main content
GET
Get a payout bank account
Requires scope: manage:pay-outs — see Required scopes. Returns a single payout bank account. The account number is masked to the last 4 digits — the full number is never retrievable through the API.

Authorizations

Headers

x-tenant-id
string<uuid>

Which tenant the request is scoped to, among those your token grants. Omit it when the token grants exactly one tenant; it is required when the token grants more than one. A supplied value must exactly match a tenant the token grants.

Absent when required, blank, malformed, or naming a tenant the token does not grant — each gets the same generic 403 forbidden, which reveals neither whether a tenant exists nor which ones you may use. Send the header once: a repeated header is rejected the same way.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

Path Parameters

partyId
string<uuid>
required

Unique party identifier

payoutBankAccountId
string<uuid>
required

Unique payout bank account identifier

Response

Payout bank account (masked)

success
boolean

Indicates whether the request was successful

result
object

Masked view of an allow-listed payout bank account.