PIX payment information for Brazilian instant payments
| Name |
Type |
Description |
Notes |
| rail |
RailEnum |
The payment rail type for PIX transfers |
|
| addressingSystem |
AddressingSystemEnum |
The addressing system used for PIX transfers |
|
| accountHolderGivenName |
String |
The given name (first name) of the account holder |
|
| accountHolderSurname |
String |
The surname (last name) of the account holder |
|
| country |
String |
The country for the transfer (ISO 3166-1 alpha-2 code) |
|
| pixKey |
String |
The PIX key used for the transfer |
|
| bankName |
String |
The name of the bank |
[optional] |
| bankCode |
String |
The bank code (ISPB - Identificador do Sistema de Pagamentos Brasileiros) |
[optional] |
| keyType |
KeyTypeEnum |
The type of PIX key being used |
|
Enum: AddressingSystemEnum
| Name |
Value |
| CPF |
"CPF" |
| CNPJ |
"CNPJ" |
| EMAIL |
"EMAIL" |
| PHONE |
"PHONE" |
| RANDOM |
"RANDOM" |