CHcheckout
Balances

Retrieve top-up instructions

Use this endpoint to retrieve the bank details required to top up a sub-account, along with the payment reference that attributes an incoming payment to that sub-account. <br/>Note: The sub-account is referred to as currency account in the API.

get/entities/{entityId}/currency-accounts/{currencyAccountId}/top-up-instructions

Request

Response

Top-up instructions retrieved successfully.

currency_account_idstring required

The unique identifier of the sub-account that the instructions apply to.

currencystring required

The currency that funds must be sent in, as a three-letter <a href="https://www.checkout.com/docs/resources/codes/currency-codes" target="_blank">ISO 4217 currency code</a>. <br/><br/> This is the sub-account's holding currency, returned as holding_currency by the <a href="https://api-reference.checkout.com/#operation/getEntityBalances">Retrieve entity balances</a> endpoint.

payment_referencestring required

The reference that must be quoted on the payment. It is how an incoming payment is attributed to the sub-account. A payment sent without this reference may not be credited.

Example response

{
  "currency_account_id": "ca_g5y7d6jo4e2urgforcbf2ey5jm",
  "currency": "USD",
  "payment_reference": "TP-ABC123",
  "bank_details": {
    "domestic": {
      "beneficiary_account_name": "Acme Inc",
      "beneficiary_address": "1 Example Street, Exampleville, EX, 00000, US",
      "bank_name": "Example Bank",
      "bank_address": "1 Example Street, Exampleville, EX, 00000, US",
      "account_number": "1234567890",
      "sort_code": "000000",
      "routing_number": "000000000",
      "iban": "GB00EXAM00000000000000",
      "swift_code": "TESTUS00XXX"
    },
    "international": {
      "beneficiary_account_name": "Acme Inc",
      "beneficiary_address": "1 Example Street, Exampleville, EX, 00000, US",
      "bank_name": "Example Bank",
      "bank_address": "1 Example Street, Exampleville, EX, 00000, US",
      "account_number": "1234567890",
      "sort_code": "000000",
      "routing_number": "000000000",
      "iban": "GB00EXAM00000000000000",
      "swift_code": "TESTUS00XXX"
    }
  }
}

Changes

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