API ReferenceCustomersAPI IntegrationPayments

Get Bank Transfer Instructions

Beta

Retrieve bank transfer instructions for a payment.

Requirements:

  • Payment must be created with Payment v3 API (not v1/v2)
  • Payment must use bank transfer method (not wallet-funded)

Authentication: Bearer token required

Path parameters

customer_idstringRequired
Unique identifier for the customer who initiated the payment. This is the customer ID of the person or entity that created the payment transaction.
payment_idstringRequired
Unique identifier for a payment created using the Payment v3 API.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

from_countrystringRequired

Country code where the payment is being sent from. 3-letter ISO country code. See ISO 3166-1 on Wikipedia.

Response

Successful response with bank transfer instructions
payment_methodenum

Indicates the type of transfer:

  • domestic_transfer: For transfers within the same country (e.g., EFT, Wire).
  • international_transfer: For cross-border transfers requiring SWIFT/IBAN.
Allowed values:
amountobject

The exact currency and amount that the third party must transfer to the bank details provided in this response. The third party should send amount.value in amount.currency to the specified bank account. Amount must be sent with 2 decimal precision.

Example: If amount shows {"currency": "GBP", "value": 1000.45}, the third party should transfer exactly £1,000.45 GBP to the bank account details provided.

Example: If amount shows {"currency": "GBP", "value": 1000.45} the third party should transfer exactly £1,000.45 GBP to the bank account details provided.

account_detailsobject
bank_detailsobject
payment_referenceobject

Errors