Sign in

v8

OpenAPI 3.1.02026-08-033623795.0 MB
Payout methods

Retrieve payout method

Retrieves the details of an existing payout method.

Required permissions:

  • payout:destination:read
get/payout_methods/{id}

Path parameters

idstring required
Example:potk_xxxxxxxxxxxxx

The unique identifier of the payout method to retrieve.

Response

A successful response

account_referencestring nullable 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.

created_atstring date-time required

The datetime the payout token was created.

currencystring required

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

idstring required

The unique identifier for the payout token.

institution_namestring nullable required

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

is_defaultboolean required

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

nicknamestring nullable required

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

Example response

{
  "account_reference": "****1234",
  "company": {
    "id": "biz_xxxxxxxxxxxxxx"
  },
  "created_at": "2023-12-01T05:00:00.401Z",
  "currency": "USD",
  "id": "potk_xxxxxxxxxxxxx",
  "institution_name": "Chase Bank",
  "nickname": "My Business Account"
}