CHcheckout
Payment instruments

Add a payment instrument

Create a bank account payment instrument for your sub-entity. You can use this payment instrument as a payout destination.

post/accounts/entities/{id}/payment-instruments

Request

Request body

typestring required

The type of instrument

labelstring required

A reference that you can use to identify the payment instrument

currencystring required

The three-letter <a href="https://www.checkout.com/docs/resources/codes/currency-codes" target="blank">ISO currency code</a> of the account's currency.

instrument_detailsobject required

Details of the payment instrument being created

Example request

{
  "type": "bank_account",
  "label": "Peter's Personal Account",
  "currency": "GBP"
}

Response

Created

idstring

Example response

{
  "id": "ppi_qn4nis4k3ykpzzu7cvtuvhqqga"
}

Changes

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