Brazil

Brazil is one of the key markets for digital payments in Latin America. With a rapidly growing fintech ecosystem, the country offers a modern and robust infrastructure for both Pay-In and Pay-Out transactions.

Among the most widely used payment methods is PIX, a real-time payment system developed by the Central Bank of Brazil.

tip

Please note that the process is always the same, before processing the transaction you must create the order, here is an example of the body for this country.

{
  "country": "BRA",
  "origin": "api",
  "amount": "5",
  "email": "test@gmail.com"
}

Pay In

APM

Type Transaction	Type Payment	Payment Method	Supported Providers	Logos
bankin	bank	pix	pix

Complete transaction - Body (Sample Request)

{
    "hash":"U2FsdGVkX1%2BSi%2B...",
    "paymentMethod" : "pix",
    "typePayment" : "bank",
    "typeTransaction":"bankin",
    "description" : "Orden de prueba",
    "customer" :
    {
        "name": "Test User"
    },
    "cpf": "136.006.426-50"
}

---

Wallet

Paypal

This endpoint allows you to initiate a payment process with PayPal through our API.
We will generate a checkout URL where the customer can be redirected to securely complete the payment process.

Complete transaction - Body (Sample Request)

{
  "hash": "U2FsdGV...",
  "paymentMethod": "paypal",
  "typePayment": "wallet",
  "typeTransaction": "walletin",
  "merchantId": "564153131",
  "urlReturn": "https://google.com",
  "urlRejected": "https://youtube.com",
  "urlWebhook": "https://webhook/ok"
}

Aditional Notes

• The merchant must redirect the user to the payer-action URL immediately after receiving the response.
• Do not rely solely on user redirection to confirm the payment; always validate the final payment status using the webhook.

---

Pay Out

Cash - Cash out

Complete transaction - Body (Sample Request)

{
    "hash":"U2FsdGVkX1%2BmLtf1vpR3e...",
    "paymentMethod" : "pix",
    "typePayment" : "cash",
    "typeTransaction":"cashout",
    "description" : "Orden de prueba",
    "customer" :
    {
        "name": "Test User"
    },
    "cpf": "136.006.426-50"
    "transaction": {"orderId": "string", "orderDescription": "string"},
}

Sample response

202 Accepted

{
    "status": {
        "code": 202,
        "message": "success",
        "kind": "unknown"
    },
    "data": {
        "statusCode": "Done",
        "data": {
            "transaction": {
                "id": "56e6af48-xxxx-xxxx-xxxx-2407443859",
                "orderId": "f85b47d8-xxxx-xxxx-xxxx-07b5",
                "date": "2024-11-06T18:37:33.098Z",
                "state": "Registered",
                "amount": "10"
            },
        },
        "payment": {
            "id": 524,
            "uuid": "f85b47d8-xxxx-xxxx-xxxx-07b5",
            "merchant": "test.88pay@gmail.com",
            "merchantUuid": "xxxx-719c501cb757",
            "country": "BRA",
            "origin": "api",
            "createdAt": "2024-11-06T18:36:52.000Z",
            "amount": 10,
            "rate": null,
            "rateAmount": null,
            "total": null,
            "rateProviderAmount": null,
            "sandbox": 1,
            "paymentMethod": "pix",
            "typeMethod": "cash"
        }
    }
}

406 Payment declined

{
    "status": {
        "code": 406,
        "message": "failed",
        "kind": "unknown"
    },
    "data": {
        "status": "Declined",
        "statusCode": 406,
        "statusReason": "Payment declined",
        "transactionId": "",
        "idempotencyKey": "123f5da56789",
        "transactionReferenceId": null,
        "descriptor": "",
        "errors": [],
        "payment": {
            "id": 140,
            "uuid": "e0ebd9cf-xxxx-xxxx-xxxx-401f5da67049",
            "merchant": "d6d29ad2-xxxx-xxxx-xxxx-55d518578434",
            "country": "USA",
            "origin": "api",
            "status": "refused",
            "createdAt": "2024-07-31T06:59:52.000Z",
            "type": "cardin",
            "amount": 10,
            "rate": null,
            "rateAmount": null,
            "total": null,
            "paymentPocketStatus": "PENDING",
            "rateProviderAmount": null,
            "sandbox": 1,
            "paymentMethod": "TC",
            "typeMethod": "credit"
        }
    }
}

---

Limits

💡 Note: The values expressed in this "Limits" section are in USD.

Payment Method	Minimum	Maximum	Min. Daily Transactions / Max. Daily Transactions
PIX	0.17 USD per Transaction	8665 USD per Transaction	Without Limit