Credit Cards

This page describes Brazil-specific requirements for the Create a Purchase operation. Refer to the create a Purchase guide for the full parameter list and base definitions.

🔁
This payment methods use an API flow. The response to the purchase request will include the final status (COMPLETED, REJECTED, etc.), without redirection.

Mandatory fields for Brazil

The following fields are required in addition to the global mandatory parameters.

Property	Type	Description
`Description`	`string`	Required by acquirers in Brazil. Format: `MerchantName+OrderId+[merchantUrl]`.
`Customer` → `FirstName`	`string`	Required for anti-fraud validation.
`Customer` → `LastName`	`string`	Required for anti-fraud validation.
`Customer` → `DocumentType`	`string`	Must be `CPF.BR` (individual) or `CNPJ.BR` (company).
`Customer` → `DocumentNumber`	`string`	CPF: 11 digits, CNPJ: 14 digits.
`Customer` → `PhoneNumber`	`string`	Must include area code, digits only.
`Customer` → `Address` → `State`	`string`	Two-letter state code (e.g. `SP`, `RJ`).
`Customer` → `Address` → `City`	`string`	City of residence.
`Customer` → `Address` → `AddressDetail`	`string`	Street + number + complement.
`Customer` → `Address` → `PostalCode`	`string`	Postal code without hyphens.

⚠️
Transactions missing these parameters will be rejected by acquirers in Brazil.

Request example using Token

To test this endpoint, use the API Reference or the Postman Collection

{
  "TrxToken": "OT__6dHAgJo6qeg62qIroA7H7_f_NWZZ6IEx4jiYpVJ8SzQ_",
  "UniqueID": "order-2025-001",
  "Capture": true,
  "TargetCountryISO": "BR",
  "Currency": "BRL",
  "Amount": 10000,
  "Installments": 1,
  "Order": "CH2025-001",
  "Description": "LojaExemplo",
  "Customer": {
    "FirstName": "João",
    "LastName": "Silva",
    "DocumentType": "CPF.BR",
    "DocumentNumber": "08333762921",
    "Email": "[email protected]",
    "PhoneNumber": "11987654321",
    "Address": {
      "Country": "BR",
      "City": "São Paulo",
      "State": "SP",
      "PostalCode": "01310200",
      "AddressDetail": "Avenida Paulista 1000"
    }
  },
  "CustomerIP": "190.10.224.231",
  "AntifraudData": {
    "AntifraudFingerprintId": "0046f17b-197a-4d63-8b6b-6082cdd557ff"
  }
}

Request example using Card Data

To test this endpoint, use the API Reference or the Postman Collection

{
    "CardData": {
        "CardHolderName": "João Silva",
        "Pan": "4984123412341234",
        "CVV": "123",
        "Expiration": "12/29",
        "Email": "[email protected]",
        "Document": "12345678901"
    },
    "UniqueID": "paymentID3022",
    "Capture": true,
    "TargetCountryISO": "BR",
    "Currency": "BRL",
    "Amount": 25000,
    "Installments": 2,
    "Order": "CH2023-001",
    "Description": "Compra de teste",
    "Customer": {
        "FirstName": "João",
        "LastName": "Silva",
        "ReferenceCode": "JS-001",
        "PhoneNumber": "11987654321",
        "DocumentNumber": "12345678901",
        "DocumentType": "CPF.BR",
        "Email": "[email protected]",
        "Address": {
            "Country": "BR",
            "City": "São Paulo",
            "State": "SP",
            "PostalCode": "01310-200",
            "AddressDetail": "Avenida Paulista 1000"
        }
    }
}

Response parameters

Review Create Purchase Guide

Check the global request and response rules before building your request.

Try it in API Reference

Test the endpoint directly and explore real request/response examples.

Testing cards

Use the following cards to simulate the different status of the purchase.

Brand	PAN	CVV	Expiration Date
Mastercard	`5555666677778884`	`123`	`12/29`
Visa	`4984123412341234`	`123`	`12/29`

💳
To ensure successful testing, please use the following specific details: docNumber: 13394559358 and docType: CPF. Failure to use these details may result in unsuccessful transactions.

Discover the API

Once you’re familiar with how to create a purchase, you can test your integration using our API Reference:

Country Requirements

Check what each country requires in terms of documents, bank formats, and supported currencies.

Create a Payment

Explore full request and response examples.

Error Codes

Understand possible error responses and how to resolve them.