Skip to main content
GET
List payout routes
Requires scope: manage:pay-outs — see Required scopes. Lists the account’s pay-out routes. Poll this to see a route reach ACTIVE before requesting a pay-out over it.
depositAddress is included only for an ACTIVE route on a SELF_CUSTODY account. It is the address a customer sends to in order to trigger a PUSH pay-out.
Provider identity is never exposed.

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

accountId
string<uuid>
required

Unique account identifier

Query Parameters

payoutBankAccountId
string<uuid>

Restrict the list to routes for a single payout bank account

Response

List of payout routes

success
boolean

Indicates whether the request was successful

result
object[]