Brazil
Country domains & codes (Brazil)
| Country/Region | Country Code | Domain | Currency Code | Currency Name |
|---|---|---|---|---|
| Brazil | br | global-br-openapi.toppayment.com | BRL | Brazilian Real |
Domain: Prefer the unified host
openapi.toppayment.com(path unchanged); legacy country domains remain available.
Sandbox/production hostnames are subject to your account setup; URL patterns follow the same convention as other regions: /sandbox/{countryCode}/... (sandbox) and /{countryCode}/... (production).
Pay-In method codes
Use these values in the method field for Brazil Pay-In (/pay/prePay, domain/country code as above). Aligned with BrazilMethodEnum. Open-API field descriptions and examples: Pay-In Orders — Brazil.
| Method code | Description |
|---|---|
| PIX | PIX |
If additional method values are enabled by the gateway, follow the live response and the list provided by operations.
Amount format (Pay-In / Pay-Out)
Positive amount, integer or at most 2 decimal places; not all zeros; no three or more decimal places. See amount in Pay-In Orders — Brazil and Pay-Out Orders — Brazil.
Pay-Out PIX field mapping
For Brazil pay-out over PIX, the generic DTO fields map as follows. Pay-Out request fields and examples: Pay-Out Orders — Brazil.
| Open API field | Meaning |
|---|---|
accountName | Beneficiary name (business field name) |
bankCode | PIX key type (business field pixType), values in the table below, case-insensitive |
bankCard | PIX account / key value (business field pixAccount) |
taxNumber | Optional; when present must be 11 digits (CPF) or 14 digits (CNPJ) after stripping non-digits |
Beneficiary name (accountName)
- Required, max 50 characters.
- Only Unicode letters, digits, and spaces.
PIX types (bankCode) and names
Same as BrazilBankEnum — used as pay-out bankCode (pixType) and display bankName:
| bankCode | bankName |
|---|---|
| CPF | CPF |
| CNPJ | CNPJ |
| PHONE | PHONE |
| EVP | EVP |
bankCard (pixAccount) rules by PIX type
| bankCode | bankCard (pixAccount) requirement |
|---|---|
| CPF | After removing non-digits, exactly 11 digits |
| CNPJ | After removing non-digits, exactly 14 digits |
| PHONE | Spaces may be removed first; must start with +55 followed by 10–11 digits |
| Valid email format | |
| EVP | Exactly 32 alphanumeric characters ([a-zA-Z0-9]{32}) |
For Pay-In and Pay-Out status values, see Transaction Status Codes.