Skip to main content

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

​
id
string
required

The unique identifier for the payout token.

Example:

"potk_xxxxxxxxxxxxx"

​
created_at
string<date-time>
required

The datetime the payout token was created.

Example:

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

​
company
object
required

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

​
nickname
string | null
required

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

Example:

"My Business Account"

​
currency
string
required

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

Example:

"USD"

​
is_default
boolean
required

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

​
account_reference
string | null
required

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.

Example:

"****1234"

​
institution_name
string | null
required

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

Example:

"Chase Bank"

​
destination
object
required

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