Terminal-2 icon

Installments in Brazil

Flag the payment as debit or credit, and make credit card installment payments in Brazil.

In Brazil, shoppers commonly use a combo card that has both a debit and a credit functionality, and most credit cards accept installment payments. Consequently, when paying by card, shoppers are asked to make some choices:

  • Do they want to pay by debit or credit?
  • If credit, do they want to make a one-off payment of the total amount or do they want to pay in installments?
  • If installments, how many installments?

Here we explain how to flag in-store card payments as credit or debit and make credit card installment payments:

Requirements

Requirement Description
Integration type Make sure you have an existing Terminal API integration or a standalone terminal.
Limitations Supported in Brazil.

How it works - Terminal API

With a Terminal API integration, the flow at the point of sale is as follows:

  1. Your store staff asks the shopper how they prefer to pay: debit or credit, and if applicable, how many installments.
  2. Your store staff enters this information into your POS app.
  3. Your POS app passes this information to the payment request.
  4. The shopper presents their card to the terminal and completes the payment.
  5. When the transaction is approved, you receive a response containing installment and receipt data.

Make a payment - Terminal API

The Terminal API payment request needs to contain a flag to indicate a debit or credit card payment. When paying by credit in installments, the request also needs to contain an object to define the installments.

  1. Make sure that your POS app collects the following information and passes it to the Terminal API payment request:

    • Whether the shopper is going to pay by debit or credit.
    • If credit: whether the shopper wants to pay in installments.
    • If credit installments: how many installments.

  2. Make a POST request to a Terminal API endpoint, specifying:

    • MessageHeader: the standard SaleToPOIRequest.MessageHeader object. Specify:

      Parameter Required Description
      ProtocolVersion -white_check_mark- 3.0
      MessageClass -white_check_mark- Service
      MessageCategory -white_check_mark- Payment
      MessageType -white_check_mark- Request
      ServiceID -white_check_mark- Your unique ID for this request, consisting of 1-10 alphanumeric characters. Must be unique within the last 48 hours for the terminal (POIID) being used.
      SaleID -white_check_mark- Your unique ID for the POS system component to send this request from.
      POIID -white_check_mark- The unique ID of the terminal to send this request to. Format: [device model]-[serial number].

    • PaymentRequest: The request body. This must include:

      Parameter Required Description
      SaleData.SaleTransactionID -white_check_mark- An object with:
      • TransactionID: your reference to identify a payment. We recommend using a unique value per payment. In your Customer Area and Adyen reports, this shows as the merchant reference for the transaction.
      • TimeStamp: date and time of the request in UTC format.
      PaymentTransaction.AmountsReq -white_check_mark- An object with:
      • Currency: the transaction currency.
      • RequestedAmount: The final transaction amount.

  3. Add a flag to specify if the shopper wants to pay by debit or credit:

    • TransactionConditions.DebitPreferredFlag:
      • true: makes a debit card payment.
      • false: makes a credit card payment.

    For a debit card payment or a one-off credit card payment, no further parameters are required.

  4. If the shopper is paying by credit card in installments, define the installments by adding:

    • PaymentData: the installment details. This contains:
      • PaymentType: Instalment
      • Instalment.InstalmentType: EqualInstalments
      • Instalment.SequenceNumber: 1
      • Instalment.Period: 1
      • Instalment.PeriodUnit: Monthly
      • Instalment.TotalNbOfPayments: the number of installments. The minimum is 2, the maximum 36.

    Here are some sample requests:

  5. Check the payment result.
    If the payment is successful, the terminal shows the payment is approved, and you receive a Terminal API response. This response
    contains:

    • PaymentReceipt: dynamically generated receipt data that you can use for printing (or emailing) receipts. Both the merchant receipt and the shopper receipt have additional required keys:

      • productType: indicates if the shopper paid by debit, credit, or credit in a specified number of installments.

      • cnpj: identification number issued for the Brazilian National Registry of Legal Entities.

    • If the shopper paid in installments, the response also includes:

      • PaymentResult.PaymentType: Instalment

      • PaymentResult.Instalment: object containing the same installment details that you defined in the PaymentData of your PaymentRequest.

    Here is a sample response for a credit card payment with 12 installments:

How it works - Standalone

On a standalone terminal, the flow at the point of sale is as follows:

  1. Your store staff asks the shopper how they prefer to pay: debit or credit, and if applicable, how many installments.
  2. Your store staff starts the transaction as usual.
  3. The shopper inserts their card.
  4. On the terminal, your store staff enters how the shopper prefers to pay.
  5. The shopper completes the payment on the terminal. This may require PIN or signature.
  6. When the transaction is approved, the terminal prints the merchant and shopper receipts.

Make a payment - Standalone

  1. Ask the shopper how they prefer to pay:

    • Debit or credit.
    • If credit: one-off payment or installments.
    • If installments: number of installments.

  2. Select Start on the terminal display, or select the Confirm key on the keypad.

  3. Enter the transaction value and confirm to continue.

  4. Let the shopper insert their card into the card reader or terminal.

    Choosing debit or credit and choosing installments is only possible when the shopper inserts their card.
    If the shopper makes a contactless transaction, a combo card defaults to a credit payment without installments.

  5. Follow the instructions on the terminal to enter how the shopper prefers to pay.

  6. Let the shopper complete the payment on the terminal. They may need to enter their PIN or signature to verify the payment.

If the payment is successful, the terminal shows that the payment is approved, and prints a merchant receipt and then a shopper receipt.

Reconciling installments

If a shoppers pays in installments, the first installment is immediately charged to the shopper's credit card, and all future installments will be charged automatically.

You receive the funds for each installment as it is settled. There is a settlement delay of 30 days. If you need the funds sooner, we also offer advancements. There is an additional fee for this service. Contact your Adyen Account Manager for details.

If you use standalone terminals, you need to manually reconcile your point-of-sale transactions against your sales and returns.

For more information on how installments are settled and reconciled, see Reconcile installment payments.

See also