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

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[]