Skip to navigation

Bank / E-wallet Transfer

Bank / E-wallet Transfer lets partners pay to a bank account, an e-wallet or mobile-money number, a PIX or Bre-B key, or a till/paybill number instead of a scanned QR. The entry point is POST /lookupPaymentCode, which creates a PENDING transaction (same shape as decodeQr). Downstream flow is unchanged: lookupPaymentCode → getQuotation → executePayout. Sender identity always comes from the registered customer_id — do not send sender.

View as Markdown

Flow

  1. POST /lookupPaymentCode with the typed destination. This validates the destination and creates a PENDING transaction (same shape as decodeQr).
  2. POST /getQuotation with the returned tx_id and the amount.
  3. POST /executePayout with a fresh X-Idempotency-Key header.

The destination itself never carries an amount; the amount is set at quotation time.

Request fields

FieldRequiredNotes
country_codeyesSee the table below
payment_destinationyesThe typed destination: key, phone, or account number
payment_methodyesFixed per country, see below
payment_destination_codesome countriesSee notes per country
customer_idyesRegistered customer; sender identity always comes from it

Destinations by country

Countrypayment_methodpayment_destinationNotes
Philippines (PH)bank_transferMobile number for a wallet, account number for a bankpayment_destination_code: the bank_list_code from listBanks?country_code=PH (wallets such as GCash and Maya are listed alongside banks); recipient.name required
Indonesia (ID)ewallet or bank_transferPhone number of the wallet, or a 6–30 digit bank account numberE-wallet payment_destination_code: DANA, OVO, GOPAY, or SHOPEEPAY; OVO needs at least 10,000 IDR. Bank transfer payment_destination_code: the 3-digit code or swift_code from listBanks?country_code=ID (the account must have IDR enabled). That list is informational; any 3-digit bank code or SWIFT is accepted
Brazil (BR)payment_keyPIX key: phone (+55 format), email, CPF/CNPJ, or random key
Peru (PE)ewalletPhone numberpayment_destination_code: YAPE or PLIN
Bolivia (BO)bank_transferBank account numberRequires account_type (SAVINGS or CHECKING), bank code, and recipient name
Colombia (CO)payment_keyBre-B key
Nigeria (NG)bank_transferAccount or mobile wallet numberInstitution code from listBanks
Ghana (GH)bank_transferAccount or mobile wallet numberInstitution code from listBanks
Zambia (ZM)bank_transferBank account numberBank code from listBanks; banks only
Kenya (KE)payment_keyTill or paybill numberOptional payment_destination_code: TILL or PAYBILL. Paybills need account_reference, the account, bill or customer number the paybill expects; it is returned in missing_fields when absent and the payout is refused without it
Tanzania (TZ)payment_keyTill or paybill numberOptional payment_destination_code: TILL or PAYBILL
Uganda (UG)payment_keyTill or paybill numberOptional payment_destination_code: TILL or PAYBILL

Destinations are validated at lookupPaymentCode time; an invalid or unknown destination fails there, before any quotation or payout.