Our API Docs just got a new look!

🇧🇷Brazil

Country specifications

country code
currency code
amount decimals
document name
document format
document required?

BR

BRL and USD

2

CPF

Numeric.

Length 11

(Validate verifier-digits)

Yes

Card features

Card-on-file
Subscriptions
3DS
Installments
Authorization and Capture

Multiplo cards

Some Brazilian bank cards, called "Multiplo" cards, can be used for both credit and debit.

Server2Server

Within our Server2Server integration, by default, we treat them as credit cards. However, you can use the credit_card.payment_mode setting to force a transaction to be DEBIT or CREDIT. This lets you give customers a choice, like using debit for a one-time payment or credit to pay in installments.

Card-on-file

For cards you have saved:

  • If you don't specify the type, it will use the type you originally saved (credit or debit).

  • If you use credit_card.payment_mode, it will use whatever you specify for that single transaction.

Brands available

payment_method code CC

Logo
payment_method
Name

VI

Visa

VD

Visa Debit ​

MC

Mastercard

MD

Mastercard Debit ​

AE

American Express

CL

Cabal ​

EL

Elo

ELD

Elo Debit ​

DC

Diners Club

HI

Hipercard

Alternative Payment Methods available

Logo
payment_method
Name
payment_type
Available for test

IX

Pix

BANK_TRANSFER

EmbbededRedirect

PP

PicPay

VOUCHER

EmbbededRedirect

BB

Banco do Brasil

BANK_TRANSFER

EmbbededRedirect

CA

Caixa

BANK_DEPOSIT

EmbbededRedirect

I

Itaú

BANK_TRANSFER

EmbbededRedirect

B

Bradesco

BANK_TRANSFER

EmbbededRedirect

SB

Santander

BANK_DEPOSIT

EmbbededRedirect

BZ

Banco Original

BANK_DEPOSIT

EmbbededRedirect

SF

Banco Safra

BANK_DEPOSIT

EmbbededRedirect

UL

Banrisul

BANK_DEPOSIT

EmbbededRedirect

NU

Nubank

BANK_TRANSFER

EmbbededRedirect

ME

MercadoPago

BANK_TRANSFER

EmbbededRedirect

ICSH

iCash

VOUCHER

EmbbededRedirect

SUA

SUAPI

WALLET

Redirect

Fields required for the OneShot solution

Payment method name

country

amount

payer[]

payment_method

All

Yes

Yes

Yes

Yes

payer[] object requirements

Payment method name

document

email

first_name

last_name

phone

address[]

Boleto

Yes

Yes

Yes

Yes

No

Yes

Banco do Brasil

Yes

Yes

Yes

Yes

No

Yes

Itaú

Yes

Yes

Yes

Yes

No

Yes

PicPay

Yes

Yes

Yes

Yes

Yes

No

All the other payment methods

Yes

Yes

Yes

Yes

No

No

address[] object requirements

Payment method name

Required for deposits above

street

city

state

zip_code

Boleto

USD 3000

Yes

Yes

Yes

Yes

Banco do Brasil

USD 200

Yes

Yes

Yes

Yes

Itaú

USD 200

Yes

Yes

Yes

Yes

If any of the required fields are missing the HOSTED flow will be triggered

In that case you will receive the HOSTED value in the checkout_type parameter. You will have to redirect the user to the redirect_url


Payment flows

Pix

The user selects Pix and chooses the option “Copia e Cola.” A payment code is generated, which they copy and paste into their bank app under the Pix section. After confirming the transaction, the payment is completed instantly.

Last updated

Was this helpful?