Lookup Payment Code
Resolves a bank or e-wallet transfer destination or merchant / account identifier into the same decode flow as decodeQr: creates a PENDING transaction and returns tx_id.
Use this endpoint when the payer types a destination instead of scanning a QR. Scanned EMV / local QR strings should continue to use decodeQr.
Authentication
- REQUIRED: Basic Auth
Authorization: Basic base64(client_id:client_secret).
Two request contracts
1. Bank / e-wallet transfer destinations (ID, AR, BR, PE, BO, CO, NG, GH, ZM)
Required:
customer_idcountry_codepayment_method— must match the corridor:AR,BR,CO→payment_keyID→ewalletorbank_transferPE→ewalletBO,NG,GH,ZM→bank_transferpayment_destination— the typed destination (PIX key, phone, bank account, BREB key, Indonesia wallet phone or 6–30 digit bank account, or NG/GH/ZM account / mobile-money number). Legacy alias:qr_string.
payment_destination_code is required for:
IDe-wallet —DANA,OVO,GOPAY, orSHOPEEPAY(OVO minimum 10,000 IDR)IDbank transfer — 3-digit national bank code or SWIFT.GET /listBanks?country_code=IDreturns the published list (code,short_name,swift_code) for accounts with IDR enabled. Lookup accepts any 3-digit code or SWIFT, including codes not in that list.PE—YAPEorPLINBR— must bePIXCO— must beBREBBO— bank code (seeGET /listBanks?country_code=BO)NG/GH/ZM— bank or mobile-money network code (e.g.058,MTN)
Bolivia-only extras when payment_method is bank_transfer:
account_type—SAVINGSorCHECKINGrecipient—name_first,name_last,ic_number
Sender is never accepted on the request; it is always derived from the registered customer.
2. Merchant / account lookup (KE, TZ, VN)
Required:
customer_idcountry_code—KE,TZ, orVNmerchant_id— till/paybill (KE/TZ) or bank account number (VN)
Optional:
account_reference— paybill bill reference (KE/TZ) or bank BIN (VN)
Shared optional fields
amount,currencypartner_transaction_idpartner_app_id(1–64 chars[a-zA-Z0-9_-])wallet_identifier
Response
Same curated public shape as decodeQr (tx_id, is_dynamic, amount, country, currency, fees when amount > 0, missing_fields, etc.).
Payout flow: lookupPaymentCode → getQuotation → executePayout.
Authentication
Basic Auth: base64(client_id:client_secret)
Query parameters
Decimal places for monetary fields in the response (USD amounts, fees, exchange rates). Default 2, which rounds sub-cent fees to 0. Use dp=4 or higher to reconcile against exact deducted totals: at full precision amount_usd + percentage_fee + fixed_fee equals the amount deducted from your balance. Rounding is applied to the response only; all stored values and balance deductions always use full precision.
Request
ISO alpha-2. Required. Bank / e-wallet transfer destinations: ID, AR, BR, PE, BO, CO, NG, GH, ZM. Merchant lookup: KE, TZ, VN. Indonesia bank codes come from GET /listBanks?country_code=ID and require IDR on the account.
Required for bank and e-wallet transfer destinations. Must match the corridor (see endpoint description).
Destination string (account number, phone or key) for bank and e-wallet transfer corridors. Legacy alias: qr_string.
Rail or institution code: PIX, BREB, YAPE/PLIN, Indonesia e-wallet code (DANA, OVO, GOPAY, SHOPEEPAY) or 3-digit bank code / SWIFT from listBanks?country_code=ID, Bolivia bank code, or NG/GH/ZM bank/network code.
Till/paybill (KE/TZ) or bank account number (VN). Used by the merchant lookup contract.
Paybill account reference (KE/TZ, required for Kenya paybills) or bank BIN (VN).
Optional local-currency amount. When > 0, pricing may be computed on the response.
Optional partner sub-app id (1–64 chars, [a-zA-Z0-9_-]).
Legacy alias for payment_destination on bank and e-wallet transfer corridors. Prefer payment_destination.
Response
OK — same shape as decodeQr
Africa (KE/TZ) till or paybill number when returned.
Africa (KE/TZ) verified merchant display name when returned.
Africa (KE/TZ) payment destination type when returned.
Africa (KE/TZ) merchant metadata when returned.
