CHcheckout
Payment instruments

Get payment instrument details

Retrieve the details of a specific payment instrument used for sub-entity payouts.

get/accounts/entities/{entityId}/payment-instruments/{id}

Request

Response

Payment instrument details

idstring

The ID of the sub-entity's payment instrument.

status'pending' | 'verified' | 'unverified'

The status of your sub-entity's payment instrument. The status indicates the instrument's stage of verification, and whether it can be used for payouts.

instrument_idstring

The payment instrument's ID. Only available once the instrument status is verified.

labelstring required

A reference that you can use to identify the payment instrument

type'bank_account' | 'card_token' required

The instrument type

currencystring ISO 4217 required

The account's currency, as a 3-letter ISO currency code

_linksobject

Example response

{
  "id": "ppi_qn4nis4k3ykpzzu7cvtuvhqqga",
  "status": "verified",
  "instrument_id": "src_wmlfc3zyhqzehihu7giusaaawu",
  "label": "Peter's Personal Account",
  "currency": "GBP"
}

Changes

No recorded changes to this operation across all 1 revision of this API.