Requests And Response Types

Decimal

Decimal 123.45 equals to unscaled=12345 and exponent=-2 (e.g. unscaled * 10^exponent, 123.45 = 12345 * 10^-2)

FieldTypeLabelDescription
unscaledint64
exponentint32

Blockchain

NameNumberDescription
BLOCKCHAIN_UNSPECIFIED0
BLOCKCHAIN_BSC10
BLOCKCHAIN_TRON100

Stablecoin

NameNumberDescription
STABLECOIN_UNSPECIFIED0
STABLECOIN_USDT10

PaymentDetails

FieldTypeLabelDescription
sepaPaymentDetails.SepaSEPA (Single Euro Payments Area) - Euro bank transfers across European countries
swiftPaymentDetails.SwiftSWIFT (Society for Worldwide Interbank Financial Telecommunication) - International wire transfers Global (200+ countries)
stablecoinPaymentDetails.StablecoinStablecoin - Cryptocurrency transfers pegged to fiat currencies Global
achPaymentDetails.AchACH (Automated Clearing House) - Electronic bank-to-bank transfers United States
wirePaymentDetails.WireWire - Domestic electronic funds transfer United States
fpsPaymentDetails.FpsFPS (Faster Payments Service) United Kingdom
mpesaPaymentDetails.MPesaM-Pesa - Mobile money transfer and payment service Kenya, Tanzania, Mozambique, DRC, Lesotho, Ghana, Egypt, South Africa
gcashPaymentDetails.GCashGCash - Mobile wallet and payment platform Philippines
indian_bank_transferPaymentDetails.IndianBankTransferIndian Bank Transfer - Domestic electronic funds transfer (IMPS/NEFT/RTGS) India
pesonetPaymentDetails.PesonetPESONet - Real-time domestic payments system Philippines
instapayPaymentDetails.InstapayInstapay - Real-time domestic payments system Philippines
pakistan_bank_transferPaymentDetails.PakistanBankTransferPakistan Bank Transfer - Domestic bank transfers using Pakistani IBAN Pakistan
pakistan_mobile_walletPaymentDetails.PakistanMobileWalletPakistan Mobile Wallet - JazzCash, Easypaisa, SadaPay, NayaPay and other wallets Pakistan
pixPaymentDetails.PixPIX - Brazilian instant payment system Brazil

PaymentDetails.Ach

FieldTypeLabelDescription
routing_numberstring
account_numberstring
account_holder_namestring
account_typePaymentDetails.Ach.AchAccountType

PaymentDetails.Fps

FieldTypeLabelDescription
sort_codestring
account_numberstring
beneficiary_namestring
referencestring

PaymentDetails.GCash

FieldTypeLabelDescription
beneficiary_namestring
beneficiary_phonestringRecipient phone
payment_referencestring

PaymentDetails.IndianBankTransfer

FieldTypeLabelDescription
account_ifscPaymentDetails.IndianBankTransfer.AccountIFSC1) ACCOUNT + IFSC (NEFT/RTGS/IMPS P2A)
impsPaymentDetails.IndianBankTransfer.IMPS2) IMPS P2P (MOBILE + MMID)
beneficiary_namestringBeneficiary name
beneficiary_typestringBeneficiary type
payment_referencestring

PaymentDetails.IndianBankTransfer.AccountIFSC

FieldTypeLabelDescription
account_numberstringBeneficiary bank account number
ifscstringIFSC code (11 characters: 4 letters + ‘0’ + 6 alphanumeric).

PaymentDetails.IndianBankTransfer.IMPS

Method 2: IMPS P2P (Mobile + MMID)

FieldTypeLabelDescription
beneficiary_phonestringIndian mobile number (10 digits, starting from 6–9).
mmidstringMMID: 7-digit Mobile Money Identifier.

PaymentDetails.Instapay

FieldTypeLabelDescription
recipient_institutionstringRecipient institution: receiving bank or e‑money issuer selected from an InstaPay list.
recipient_identifierstringRecipient identifier (one of): Account number, or Mobile number, or Email address, or QR code (scanned/uploaded “InstaPay QR”).
recipient_account_namestringRecipient account name: the name as registered on the account or wallet (may be auto-displayed but is logically required for correct routing/confirmation).
purpose_of_transferstringoptionalPurpose of Transfer (Optional/Mandatory depending on bank)

PaymentDetails.MPesa

FieldTypeLabelDescription
beneficiary_phonestringPhone number in international format without + sign Examples: 254708374149 (Kenya), 255712345678 (Tanzania), 256712345678 (Uganda) Required: Yes
account_referencestringAccount reference (max 12 chars, alphanumeric) Required: Yes

PaymentDetails.PakistanBankTransfer

Pakistan Bank Transfer - Domestic transfers using Pakistani IBAN Pakistan uses 24-character IBAN: PK + 2 check digits + 4-char bank code + 16-char account number

FieldTypeLabelDescription
ibanstringPakistani IBAN (24 characters: PK + 2 check digits + 4-char bank identifier + 16-char account) Example: PK36SCBL0000001123456702
beneficiary_namestringBeneficiary’s full name
beneficiary_cnicstringoptional(Optional) Beneficiary CNIC (13 digits, no dashes) — sometimes required by receiving banks
payment_referencestringPayment reference/description

PaymentDetails.PakistanMobileWallet

Pakistan Mobile Wallet - JazzCash, Easypaisa, SadaPay, NayaPay and other wallets Transfers are made using the mobile number linked to the wallet account; CNIC is required for verification

FieldTypeLabelDescription
wallet_providerPaymentDetails.PakistanMobileWallet.PakistanWalletProviderWallet provider
mobile_numberstringMobile number linked to the wallet (Pak local 03XXXXXXXXX or international 923XXXXXXXXX)
cnicstringCNIC (Computerized National Identity Card) - 13 digits without dashes
beneficiary_namestringBeneficiary’s full name as registered with the wallet
payment_referencestringoptionalPayment reference/description (optional)

PaymentDetails.Pesonet

FieldTypeLabelDescription
recipient_financial_institutionstringRecipient institution: receiving bank or participating non‑bank chosen from a PESONet list.
recipient_identifierstringRecipient identifier: Account number (some banks also allow email/mobile).
recipient_account_namestring
purpose_of_transferstringoptionalPurpose of Transfer (Optional/Mandatory depending on bank)
recipient_address_emailstringoptionalRecipient’s Address/Email (Optional/Mandatory depending on bank)

PaymentDetails.Pix

PIX - Brazilian instant payment system PIX allows transfers using a Pix key (CPF, CNPJ, email, phone, or random EVP) or traditional bank account details (bank code, branch, account number)

FieldTypeLabelDescription
key_typePaymentDetails.Pix.KeyTypePix key type - determines the format of pix_key_value
key_valuestringPix key value - format depends on pix_key_type: - CPF: 11 digits (e.g., “12345678901”) - CNPJ: 14 digits (e.g., “12345678000195”) - EMAIL: valid email address - PHONE: international format with country code (e.g., “+5511999999999”) - EVP: 32-character UUID (e.g., “123e4567-e89b-12d3-a456-426614174000”)
beneficiary_namestringBeneficiary’s full name
beneficiary_tax_idstringoptional(Optional) Beneficiary’s CPF (11 digits) or CNPJ (14 digits) for verification
payment_referencestringoptional(Optional) Payment description/reference

PaymentDetails.Sepa

FieldTypeLabelDescription
ibanstring
beneficiary_namestring
payment_referencestring

PaymentDetails.Stablecoin

FieldTypeLabelDescription
blockchainBlockchain
stablecoinStablecoin
addressstring

PaymentDetails.Swift

FieldTypeLabelDescription
swift_codestringBeneficiary’s bank SWIFT/BIC code (8 or 11 characters)
account_numberstringBeneficiary’s account number (format varies by country) Could be IBAN, account number, or other format
beneficiary_namestringBeneficiary’s full name
beneficiary_addressstringBeneficiary’s address
payment_referencestring

PaymentDetails.Wire

FieldTypeLabelDescription
bank_namestring
bank_addressstring
swift_codestring
account_numberstring
beneficiary_namestring
beneficiary_addressstring
wire_referencestring

PaymentDetails.Ach.AchAccountType

NameNumberDescription
ACH_ACCOUNT_TYPE_UNSPECIFIED0
ACH_ACCOUNT_TYPE_CHECKING10
ACH_ACCOUNT_TYPE_SAVINGS20

PaymentDetails.PakistanMobileWallet.PakistanWalletProvider

NameNumberDescription
PAKISTAN_WALLET_PROVIDER_UNSPECIFIED0
PAKISTAN_WALLET_PROVIDER_JAZZCASH10
PAKISTAN_WALLET_PROVIDER_EASYPAISA20
PAKISTAN_WALLET_PROVIDER_SADAPAY30
PAKISTAN_WALLET_PROVIDER_NAYAPAY40
PAKISTAN_WALLET_PROVIDER_OTHER100

PaymentDetails.Pix.KeyType

NameNumberDescription
KEY_TYPE_UNSPECIFIED0
KEY_TYPE_CPF10CPF - Cadastro de Pessoas Físicas (Individual Taxpayer Registry) - 11 digits
KEY_TYPE_CNPJ20CNPJ - Cadastro Nacional da Pessoa Jurídica (Business Tax ID) - 14 digits
KEY_TYPE_EMAIL30Email address
KEY_TYPE_PHONE40Phone number in international format
KEY_TYPE_EVP50EVP - Random key (UUID format)

PaymentMethodType

NameNumberDescription
PAYMENT_METHOD_TYPE_UNSPECIFIED0
PAYMENT_METHOD_TYPE_SEPA10
PAYMENT_METHOD_TYPE_SWIFT20
PAYMENT_METHOD_TYPE_CARD30only pay in
PAYMENT_METHOD_TYPE_STABLECOIN40only pay out
PAYMENT_METHOD_TYPE_ACH50
PAYMENT_METHOD_TYPE_WIRE60
PAYMENT_METHOD_TYPE_FPS70
PAYMENT_METHOD_TYPE_M_PESA80
PAYMENT_METHOD_TYPE_G_CASH90
PAYMENT_METHOD_TYPE_INDIAN_BANK_TRANSFER100
PAYMENT_METHOD_TYPE_PESONET110
PAYMENT_METHOD_TYPE_INSTAPAY120
PAYMENT_METHOD_TYPE_PAKISTAN_BANK_TRANSFER130Pakistan domestic bank transfer via IBAN
PAYMENT_METHOD_TYPE_PAKISTAN_MOBILE_WALLET140Pakistan mobile wallet (JazzCash, Easypaisa, etc.) - sometimes also called ID Wallet
PAYMENT_METHOD_TYPE_PIX150PIX - Brazilian instant payment system