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

Autorisationer

Authorization
string
header
påkrævet

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

Sti-parametre

id
string
påkrævet

The unique identifier of the payout method to retrieve.

Eksempel:

"potk_xxxxxxxxxxxxx"

Svar

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
påkrævet

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.

Eksempel:

"****1234"

company
object | null
påkrævet

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

created_at
string<date-time>
påkrævet

The datetime the payout token was created.

Eksempel:

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

currency
string
påkrævet

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

Eksempel:

"USD"

destination
object | null
påkrævet

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

id
string
påkrævet

The unique identifier for the payout token.

Eksempel:

"potk_xxxxxxxxxxxxx"

institution_name
string | null
påkrævet

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

Eksempel:

"Frost Bank"

is_default
boolean
påkrævet

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

nickname
string | null
påkrævet

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

Eksempel:

"Ops checking"