Skip to main content
GET
Retrieve payout method
Required permissions:
  • payout:destination:read

Autorisaties

Authorization
string
header
vereist

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Scopes

payout:destination:read

Padparameters

id
string
vereist

The unique identifier of the payout method to retrieve.

Voorbeeld:

"potk_xxxxxxxxxxxxx"

Respons

A successful response

A configured payout destination where a user receives earned funds, such as a bank account or digital wallet.

account_reference
string | null
vereist

A masked identifier for the payout destination, such as the last four digits of a bank account or an email address. Null if no reference is available.

Voorbeeld:

"****1234"

company
object | null
vereist

The company associated with this payout destination. Null if not linked to a specific company.

created_at
string<date-time>
vereist

The datetime the payout token was created.

Voorbeeld:

"2023-12-01T05:00:00.401Z"

currency
string
vereist

The three-letter ISO currency code that payouts are delivered in for this destination.

Voorbeeld:

"USD"

destination
object | null
vereist

The payout destination configuration linked to this token. Null if not yet configured.

id
string
vereist

The unique identifier for the payout token.

Voorbeeld:

"potk_xxxxxxxxxxxxx"

institution_name
string | null
vereist

The name of the bank or financial institution receiving payouts. Null if not applicable or not provided.

Voorbeeld:

"Frost Bank"

is_default
boolean
vereist

Whether this is the default payout destination for the associated payout account.

nickname
string | null
vereist

A user-defined label to help identify this payout destination. Not sent to the provider. Null if no nickname has been set.

Voorbeeld:

"Ops checking"