Requests And Response Types

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)
achPaymentDetails.AchACH (Automated Clearing House) - Electronic bank-to-bank transfers United States
domestic_wirePaymentDetails.DomesticWireDomesticWire - US domestic wire transfer United States
fpsPaymentDetails.FpsFPS (Faster Payments Service) United Kingdom
mpesaPaymentDetails.MPesaDeprecated. M-Pesa - Mobile money transfer and payment service Kenya, Tanzania, Mozambique, DRC, Lesotho, Ghana, Egypt, South Africa deprecated in favor of AfricanMobileMoney
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
african_mobile_moneyPaymentDetails.AfricanMobileMoneyAfrican Money - Kenya payment method
napsPaymentDetails.CnapsThe China National Advanced Payment System
nipPaymentDetails.NipNIP - Nigeria Instant Payment system Nigeria
rtpPaymentDetails.RtpRTP - Real-Time Payments United States
chilean_bank_transferPaymentDetails.ChileanBankTransferChilean domestic bank transfer Chile
peru_bank_transferPaymentDetails.PeruBankTransferPeruvian domestic bank transfer Peru
argentinian_bank_transferPaymentDetails.ArgentinianBankTransferArgentinian domestic bank transfer via CBU/CVU Argentina
mexican_bank_transferPaymentDetails.MexicanBankTransferMexican domestic bank transfer via SPEI/CLABE Mexico
colombian_achPaymentDetails.ColombianAchColombian ACH bank transfer Colombia
colombian_brebPaymentDetails.ColombianBrebColombian Bre-B high-speed payment rail Colombia
gipPaymentDetails.GipGIP - Ghana Interbank Payment (GhIPSS) Ghana
uaeftsPaymentDetails.UaeftsUAEFTS - UAE Funds Transfer System United Arab Emirates
vietqrPaymentDetails.VietQrVietQR - QR-addressed bank transfer Vietnam
napasPaymentDetails.NapasNAPAS 247 - instant transfer by account or card Vietnam
fastPaymentDetails.FastFAST - instant payment via IBAN or KOLAS proxy Turkey
promptpayPaymentDetails.PromptPayPromptPay - proxy-addressed instant transfer Thailand
thai_bank_transferPaymentDetails.ThaiBankTransferThai domestic bank transfer (ORFT/BAHTNET) Thailand
indonesian_bank_transferPaymentDetails.IndonesianBankTransferIndonesian domestic bank transfer (BI-FAST and other rails) Indonesia
indonesian_e_walletPaymentDetails.IndonesianEWalletIndonesian e-wallet Indonesia
provider_definedPaymentDetails.ProviderDefinedProvider-defined opaque envelope - format agreed off-network
sptrPaymentDetails.SptrSPTR - real-time gross settlement system Angola

PaymentDetails.Ach

FieldTypeLabelDescription
routing_numberstring
account_numberstringThe NACHA entry detail record defines the account number as alphanumeric; US account numbers containing letters are valid.
account_holder_namestring
account_typePaymentDetails.Ach.AchAccountType
payment_referencestringPayment reference/description (optional)

PaymentDetails.AfricanMobileMoney

FieldTypeLabelDescription
networkPaymentDetails.AfricanMobileMoney.NetworkThe phone network
beneficiary_phonestringPhone number in international format without + sign Required: Yes
account_referencestringAccount reference (max 12 chars, alphanumeric) Required: Yes
beneficiary_namestringBeneficiary name

PaymentDetails.ArgentinianBankTransfer

Argentinian domestic bank transfer via CBU or CVU. CUIT/CUIL of the beneficiary is carried in Travel Rule Data, not here.

FieldTypeLabelDescription
account_numberstringCBU (traditional bank account) or CVU (virtual account, starts with “000”), exactly 22 digits.

PaymentDetails.ChileanBankTransfer

Chilean domestic bank transfer Uses RUT (national taxpayer ID) as the beneficiary identifier.

FieldTypeLabelDescription
document_numberstringRUT of the beneficiary - 7-9 digits + check digit (K or 0-9). Example: “12345678-9”, “1234567-K”.
beneficiary_namestringBeneficiary full name (max 45 chars).
bank_codestringDestination bank code - 3 digits (e.g. “012” for BCI).
account_numberstringDestination account number - up to 18 digits (zero-padded by the provider if needed).
account_typePaymentDetails.ChileanBankTransfer.AccountTypeoptionalAccount type. Optional, but some payout routes require it; send it when known.

PaymentDetails.Cnaps

The China National Advanced Payment System

FieldTypeLabelDescription
account_numberstring6-25 digits
cnaps_codestring12 digits (encodes the bank + branch)
beneficiary_name_localstringBeneficiary name in Chinese characters
beneficiary_namestringBeneficiary name in Latin characters
businessPaymentDetails.Cnaps.Business
personPaymentDetails.Cnaps.Person
payment_referencestringPayment reference/description (optional)

PaymentDetails.Cnaps.Business

FieldTypeLabelDescription
license_numberstringBusiness license number - 18 digits

PaymentDetails.Cnaps.Person

FieldTypeLabelDescription
id_numberstringID number - 18 digits

PaymentDetails.ColombianAch

Colombian ACH (Automated Clearing House) bank transfer.

FieldTypeLabelDescription
document_numberstring
document_typePaymentDetails.ColombianAch.DocumentType
bank_codestring
account_numberstring
account_typePaymentDetails.ColombianAch.AccountType
beneficiary_namestring
phone_numberstringoptionalBeneficiary phone number. Optional, but some payout routes require it; send it when known.

PaymentDetails.ColombianBreb

Colombian Bre-B high-speed payment rail from Banco de la Republica. Same fields as ColombianAch except no phone_number.

FieldTypeLabelDescription
document_numberstring
document_typePaymentDetails.ColombianBreb.DocumentType
bank_codestring
account_numberstring
account_typePaymentDetails.ColombianBreb.AccountType
beneficiary_namestring

PaymentDetails.DomesticWire

FieldTypeLabelDescription
bank_namestring
bank_addressstring
routing_numberstringABA routing number (9 digits)
account_numberstring
beneficiary_namestringCapped at the width of the ISO 20022 creditor name element Fedwire carries.
beneficiary_addressstring
wire_referencestring

PaymentDetails.Fast

FAST - Turkish instant payment system. Addressed by IBAN or a KOLAS proxy.

FieldTypeLabelDescription
ibanstringTurkish IBAN (26 characters: TR + 2 check digits + 5-digit bank code + 1 reserved digit + 16-char alphanumeric account).
proxyPaymentDetails.Fast.ProxyKOLAS proxy (mobile / email / national ID / passport).
beneficiary_namestringBeneficiary’s full name.
payment_referencestringoptionalPayment reference/description (optional).

PaymentDetails.Fast.Proxy

FieldTypeLabelDescription
proxy_typePaymentDetails.Fast.Proxy.ProxyTypeKOLAS proxy type - determines the format of value.
valuestringKOLAS proxy value; format depends on proxy_type: - MOBILE: international format (e.g. “+905XXXXXXXXX”) - EMAIL: valid email address - NATIONAL_ID: Turkish national ID number - PASSPORT: passport number

PaymentDetails.Fps

FieldTypeLabelDescription
sort_codestring
account_numberstring
beneficiary_namestringName registered on the destination account. Capped at the width of the FPS scheme’s beneficiary account name field.
referencestringCapped at the width of the FPS scheme’s reference information field, which is narrower than the beneficiary name field.

PaymentDetails.GCash

FieldTypeLabelDescription
beneficiary_namestring
beneficiary_phonestringRecipient phone
payment_referencestring

PaymentDetails.Gip

GIP - Ghana Interbank Payment operated by GhIPSS. Domestic bank transfers using a bank sort code and account number.

FieldTypeLabelDescription
sort_codestringDestination bank sort code (6 numeric digits assigned by GhIPSS).
account_numberstringDestination account number.
account_namestringName registered on the destination account.
referencestringPayment reference/description (optional).

PaymentDetails.IndianBankTransfer

FieldTypeLabelDescription
account_ifscPaymentDetails.IndianBankTransfer.AccountIFSC1) ACCOUNT + IFSC (NEFT/RTGS/IMPS P2A)
impsPaymentDetails.IndianBankTransfer.IMPS2) IMPS P2P (MOBILE + MMID)
beneficiary_namestringBeneficiary name
beneficiary_typePaymentDetails.IndianBankTransfer.BeneficiaryTypeWhether the beneficiary is an individual or a company. INR payout rails always require the distinction.
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.IndonesianBankTransfer

Indonesian domestic bank transfer (BI-FAST and other rails). Addressed by account number, or by a BI-FAST proxy (mobile / email).

FieldTypeLabelDescription
accountPaymentDetails.IndonesianBankTransfer.AccountBank account (Indonesian bank code + account number).
mobilestringBI-FAST proxy: mobile number (international format).
emailstringBI-FAST proxy: email address.
beneficiary_namestringBeneficiary’s full name.
payment_referencestringoptionalPayment reference/description (optional).

PaymentDetails.IndonesianBankTransfer.Account

FieldTypeLabelDescription
bank_codestringIndonesian bank code.
account_numberstringBeneficiary account number.

PaymentDetails.IndonesianEWallet

Indonesian e-wallet transfer (GoPay, OVO, DANA, ShopeePay, LinkAja, etc.).

FieldTypeLabelDescription
providerstringE-wallet provider name (e.g. GoPay, OVO, DANA, ShopeePay, LinkAja).
mobile_numberstringIndonesian mobile number linked to the wallet (international format).
beneficiary_namestringBeneficiary’s full name.
payment_referencestringoptionalPayment reference/description (optional).

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. Capped at the width of the ISO 20022 creditor name element InstaPay carries.
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
beneficiary_namestringBeneficiary name

PaymentDetails.MexicanBankTransfer

Mexican domestic bank transfer via SPEI using a CLABE account number. RFC of the beneficiary is carried in Travel Rule Data, not here.

FieldTypeLabelDescription
beneficiary_namestringBeneficiary full name.
bank_codestringBank institution code.
account_numberstringCLABE (Clave Bancaria Estandarizada) - exactly 18 digits. Format: 3 digits bank code + 3 digits plaza code + 11 digits account + 1 check digit.

PaymentDetails.Napas

NAPAS 247 - Vietnamese instant transfer addressed by account number or card number.

FieldTypeLabelDescription
bank_binstringNAPAS bank identifier (6 digits).
account_numberstringAccount number (up to 19 digits).
card_numberstringCard number (16-19 digits).
beneficiary_namestringBeneficiary’s full name.
payment_referencestringoptionalPayment reference/description (optional).

PaymentDetails.Nip

NIP - Nigeria Instant Payment system Transfers are made using bank code and account number (NUBAN)

FieldTypeLabelDescription
bank_codestringBank code (e.g., “00001”)
account_numberstringAccount number (NUBAN format)
beneficiary_namestringBeneficiary’s full name
payment_referencestringPayment reference/description (optional)

PaymentDetails.PakistanBankTransfer

Pakistan Bank Transfer - Domestic transfers using Pakistani IBAN

FieldTypeLabelDescription
ibanstringPakistani IBAN (24 characters: PK + 2 check digits + 4-letter bank identifier + 16-char alphanumeric 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.PeruBankTransfer

Peruvian domestic bank transfer (PEN, USD-PE)

FieldTypeLabelDescription
document_numberstringDocument number of the beneficiary. Per document_type: DNI up to 8 digits; CE and RUC may be longer.
document_typePaymentDetails.PeruBankTransfer.DocumentTypeoptionalDocument type. Optional - defaults to DNI on the provider side if unset.
bank_codestringDestination bank code (mapped to provider-specific bank codes internally).
account_numberstringDestination account number.
account_typePaymentDetails.PeruBankTransfer.AccountType

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_namestringRecipient account name: the name as registered on the account. Capped at the width of the ISO 20022 creditor name element PESONet carries.
purpose_of_transferstringoptionalPurpose of Transfer (Optional/Mandatory depending on bank)
recipient_address_emailstringoptionalRecipient’s Address/Email (Optional/Mandatory depending on bank)

PaymentDetails.Pix

Pix payment instructions using a key pair, a BR Code, or both. When br_code is present, it is the payment instruction to present to the payer.

FieldTypeLabelDescription
key_typePaymentDetails.Pix.KeyTypePix key type; supplied together with key_value when a separate key is available. no validation: key presence is constrained by the message-level key-pair rule.
key_valuestringPix key value; its format is determined by key_type. CPF: 11 digits; CNPJ: 14 digits; EMAIL: email address. PHONE: international format (e.g., “+5511999999999”). EVP: UUID with hyphens (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_referencestringoptionalPayment reference; for QR-based payments, carries the Pix txid used for reconciliation, distinct from the payment’s end-to-end ID.
br_codestringoptionalComplete Pix Copia e Cola payload. Present it unchanged as copyable text or encode it unchanged into a QR image; do not substitute a transfer by key.
br_code_expires_atgoogle.protobuf.TimestampProvider-reported validity deadline for receipt of funds associated with br_code. Late-payment handling is agreed with the provider; absence means unspecified. no validation: historical expiry is valid; br_code presence is constrained at message level.

PaymentDetails.PromptPay

PromptPay - Thai instant transfer addressed by a registered proxy.

FieldTypeLabelDescription
proxy_typePaymentDetails.PromptPay.ProxyTypeProxy type - determines the format of identifier.
identifierstringProxy value; format depends on proxy_type: - MOBILE: Thai mobile number - NATIONAL_ID: 13-digit Thai national ID - TAX_ID: Thai tax identification number
beneficiary_namestringBeneficiary’s full name.
payment_referencestringoptionalPayment reference/description (optional).

PaymentDetails.ProviderDefined

Provider-defined envelope for payment details that intentionally stay outside the Network protocol. The provider and requester agree the payload format off-network (JSON, protobuf bytes, YAML, XML, a barcode/auth-code instruction format, or any other provider-specific encoding). The payload is opaque and forwarded to the provider without interpretation.

FieldTypeLabelDescription
payloadbytesOpaque provider-defined payload; maximum 10 KiB. Format agreed off-network.

PaymentDetails.Rtp

RTP - Real-Time Payments (USA) Real-time bank-to-bank transfers using routing and account numbers

FieldTypeLabelDescription
routing_numberstringABA routing number (9 digits)
account_numberstring
account_typePaymentDetails.Rtp.RtpAccountType
bank_namestring
payment_referencestringPayment reference/description (optional)

PaymentDetails.Sepa

FieldTypeLabelDescription
ibanstring
beneficiary_namestring
payment_referencestring

PaymentDetails.Sptr

SPTR - Angolan real-time gross settlement system. Kwanza (AOA) transfers addressed by IBAN.

FieldTypeLabelDescription
ibanstringAngolan IBAN without spaces (25 characters: AO + 2 check digits + the 21-digit NBA account number).
beneficiary_namestringBeneficiary’s full name.
bank_namestringName of the bank that holds the beneficiary account.
payment_referencestringoptionalPayment reference/description (optional).

PaymentDetails.Swift

FieldTypeLabelDescription
swift_codestringBeneficiary’s bank SWIFT/BIC code (8 or 11 characters). The party prefix is alphanumeric.
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
bank_namestringBeneficiary’s bank name
bank_countrystringBeneficiary’s bank country (ISO 3166-1 alpha-2)
account_currencystringoptionalAccount currency (ISO 4217)
intermediary_bankPaymentDetails.Swift.IntermediaryBank

PaymentDetails.Swift.IntermediaryBank

Intermediary bank details (optional)

FieldTypeLabelDescription
swift_codestring
bank_namestring
account_numberstring

PaymentDetails.ThaiBankTransfer

Thai domestic bank transfer (ORFT online transfer, BAHTNET RTGS).

FieldTypeLabelDescription
bank_codestringThai bank code.
account_numberstringBeneficiary account number (up to 15 digits).
beneficiary_namestringBeneficiary’s full name.
payment_referencestringoptionalPayment reference/description (optional).

PaymentDetails.Uaefts

UAEFTS - UAE Funds Transfer System operated by the Central Bank of the UAE. Domestic transfers addressed by IBAN.

FieldTypeLabelDescription
ibanstringUAE IBAN (23 characters: AE + 2 check digits + 19 digits).
beneficiary_namestringBeneficiary’s full name.
purpose_codestringCBUAE purpose-of-payment code (3 uppercase letters). Format-checked only; the code list changes regularly and is intentionally not validated here.
payment_referencestringoptionalPayment reference/description (optional).

PaymentDetails.VietQr

VietQR - Vietnamese bank transfer addressed by a resolved QR code.

FieldTypeLabelDescription
bank_binstringNAPAS bank identifier (6 digits).
account_numberstringBeneficiary account number (up to 19 digits).
beneficiary_namestringBeneficiary’s full name.
payment_referencestringoptionalPayment reference/description (optional).

PaymentDetails.Ach.AchAccountType

NameNumberDescription
ACH_ACCOUNT_TYPE_UNSPECIFIED0
ACH_ACCOUNT_TYPE_CHECKING10
ACH_ACCOUNT_TYPE_SAVINGS20

PaymentDetails.AfricanMobileMoney.Network

NameNumberDescription
NETWORK_UNDEFINED0
NETWORK_M_PESA10
NETWORK_AIRTEL20
NETWORK_MTN30
NETWORK_VODACOM40
NETWORK_ORANGE50
NETWORK_VODAFONE60
NETWORK_FREE70
NETWORK_ZAMTEL80

PaymentDetails.ChileanBankTransfer.AccountType

NameNumberDescription
ACCOUNT_TYPE_UNSPECIFIED0
ACCOUNT_TYPE_CHECKING10Cuenta Corriente
ACCOUNT_TYPE_VISTA20Cuenta Vista / Cuenta RUT
ACCOUNT_TYPE_SAVINGS40Cuenta de Ahorro

PaymentDetails.ColombianAch.AccountType

NameNumberDescription
ACCOUNT_TYPE_UNSPECIFIED0
ACCOUNT_TYPE_SAVINGS10Cuenta de Ahorros
ACCOUNT_TYPE_CHECKING20Cuenta Corriente

PaymentDetails.ColombianAch.DocumentType

NameNumberDescription
DOCUMENT_TYPE_UNSPECIFIED0
DOCUMENT_TYPE_CC10CC - Cedula de Ciudadania
DOCUMENT_TYPE_CE20CE - Cedula de Extranjeria
DOCUMENT_TYPE_NIT30NIT - Numero de Identificacion Tributaria (business tax ID)
DOCUMENT_TYPE_TI40TI - Tarjeta de Identidad
DOCUMENT_TYPE_PP50PP - Pasaporte

PaymentDetails.ColombianBreb.AccountType

NameNumberDescription
ACCOUNT_TYPE_UNSPECIFIED0
ACCOUNT_TYPE_SAVINGS10Cuenta de Ahorros
ACCOUNT_TYPE_CHECKING20Cuenta Corriente

PaymentDetails.ColombianBreb.DocumentType

NameNumberDescription
DOCUMENT_TYPE_UNSPECIFIED0
DOCUMENT_TYPE_CC10CC - Cedula de Ciudadania
DOCUMENT_TYPE_CE20CE - Cedula de Extranjeria
DOCUMENT_TYPE_NIT30NIT - Numero de Identificacion Tributaria (business tax ID)
DOCUMENT_TYPE_TI40TI - Tarjeta de Identidad
DOCUMENT_TYPE_PP50PP - Pasaporte

PaymentDetails.Fast.Proxy.ProxyType

NameNumberDescription
PROXY_TYPE_UNSPECIFIED0
PROXY_TYPE_MOBILE10Mobile phone number
PROXY_TYPE_EMAIL20Email address
PROXY_TYPE_NATIONAL_ID30National ID number
PROXY_TYPE_PASSPORT40Passport number

PaymentDetails.IndianBankTransfer.BeneficiaryType

NameNumberDescription
BENEFICIARY_TYPE_UNSPECIFIED0
BENEFICIARY_TYPE_INDIVIDUAL10Natural person.
BENEFICIARY_TYPE_COMPANY20Business entity.

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.PeruBankTransfer.AccountType

NameNumberDescription
ACCOUNT_TYPE_UNSPECIFIED0
ACCOUNT_TYPE_CHECKING10
ACCOUNT_TYPE_SAVINGS20

PaymentDetails.PeruBankTransfer.DocumentType

NameNumberDescription
DOCUMENT_TYPE_UNSPECIFIED0
DOCUMENT_TYPE_DNI10DNI - Documento Nacional de Identidad (max 8 digits)
DOCUMENT_TYPE_CE20CE - Carnet de Extranjeria (foreigner ID)
DOCUMENT_TYPE_RUC30RUC - Registro Unico de Contribuyentes (business tax ID)

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)

PaymentDetails.PromptPay.ProxyType

NameNumberDescription
PROXY_TYPE_UNSPECIFIED0
PROXY_TYPE_MOBILE10Mobile phone number
PROXY_TYPE_NATIONAL_ID20National ID number (13 digits)
PROXY_TYPE_TAX_ID30Tax identification number

PaymentDetails.Rtp.RtpAccountType

NameNumberDescription
RTP_ACCOUNT_TYPE_UNSPECIFIED0
RTP_ACCOUNT_TYPE_CHECKING10
RTP_ACCOUNT_TYPE_SAVINGS20

PaymentMethodType

NameNumberDescription
PAYMENT_METHOD_TYPE_UNSPECIFIED0
PAYMENT_METHOD_TYPE_SEPA10
PAYMENT_METHOD_TYPE_SWIFT20
PAYMENT_METHOD_TYPE_ACH50
PAYMENT_METHOD_TYPE_DOMESTIC_WIRE60
PAYMENT_METHOD_TYPE_FPS70
PAYMENT_METHOD_TYPE_M_PESA80deprecated in favor of PAYMENT_METHOD_TYPE_AFRICAN_MOBILE_MONEY
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
PAYMENT_METHOD_TYPE_AFRICAN_MOBILE_MONEY160African Mobile Money - Mobile money system across multiple countries: Kenya (Mpesa, Airtel), Tanzania, Mozambique, DRC, Lesotho, Ghana, Egypt, South Africa etc.
PAYMENT_METHOD_TYPE_CNAPS170The China National Advanced Payment System
PAYMENT_METHOD_TYPE_NIP180NIP - Nigeria Instant Payment system
PAYMENT_METHOD_TYPE_RTP190RTP - Real-Time Payments (USA)
PAYMENT_METHOD_TYPE_CHILEAN_BANK_TRANSFER200Chilean domestic bank transfer (CLP)
PAYMENT_METHOD_TYPE_PERU_BANK_TRANSFER210Peruvian domestic bank transfer (PEN, USD-PE)
PAYMENT_METHOD_TYPE_ARGENTINIAN_BANK_TRANSFER220Argentinian domestic bank transfer via CBU/CVU (ARS)
PAYMENT_METHOD_TYPE_MEXICAN_BANK_TRANSFER230Mexican domestic bank transfer via SPEI/CLABE (MXN)
PAYMENT_METHOD_TYPE_COLOMBIAN_ACH240Colombian ACH bank transfer (COP)
PAYMENT_METHOD_TYPE_COLOMBIAN_BREB250Colombian Bre-B high-speed payment rail (COP)
PAYMENT_METHOD_TYPE_GIP260GIP - Ghana Interbank Payment (GhIPSS)
PAYMENT_METHOD_TYPE_UAEFTS270UAEFTS - UAE Funds Transfer System (United Arab Emirates)
PAYMENT_METHOD_TYPE_VIETQR280VietQR - Vietnamese QR-addressed bank transfer
PAYMENT_METHOD_TYPE_NAPAS290NAPAS 247 - Vietnamese instant transfer by account or card
PAYMENT_METHOD_TYPE_FAST300FAST - Turkish instant payment system (Turkey)
PAYMENT_METHOD_TYPE_PROMPTPAY310PromptPay - Thai proxy-addressed instant transfer (Thailand)
PAYMENT_METHOD_TYPE_THAI_BANK_TRANSFER320Thai domestic bank transfer - ORFT/BAHTNET (Thailand)
PAYMENT_METHOD_TYPE_INDONESIAN_BANK_TRANSFER330Indonesian domestic bank transfer - BI-FAST and other rails (Indonesia)
PAYMENT_METHOD_TYPE_INDONESIAN_E_WALLET340Indonesian e-wallet - GoPay, OVO, DANA, ShopeePay, LinkAja, etc. (Indonesia)
PAYMENT_METHOD_TYPE_PROVIDER_DEFINED350Provider-defined envelope: payment details whose structure is defined by the provider and agreed with the requester off-network. The payload is opaque and forwarded to the provider without interpretation.
PAYMENT_METHOD_TYPE_SPTR360SPTR - Angolan real-time gross settlement system (Angola)