Introduction

PIX is a Brazilian payment method that supports payments (deposits) only. All transactions are regulated by the Central Bank of Brazil.

To complete PIX payments, transactions must be authorized by scanning a QR code containing transaction information. Transaction details must be confirmed on a mobile device.

For a typical transaction, the merchant redirects the customer to a URL that contains a QR created by Nuvei.

For customers with a special configuration, the merchant generates the QR code for the customer on their payment page. To work in this manner, special configuration is required from Nuvei’s side; please contact Nuvei’s Integration Support Team.

Supported Countries

• Brazil

Supported Currencies

• USD
• BRL

Implementation Details

Click tab to open…

{
    "sessionToken": "<sessionToken from getSessionToken>",
    "merchantId": "<merchantId>",
    "merchantSiteId": "<merchantSiteId>",
    "clientUniqueId": "<unique transaction ID in merchant system>",
    "clientRequestId": "<unique request ID in merchant system>",
    "amount": "200",
    "currency": "BRL",
    "userTokenId": "<unique customer identifier in merchant system>",
    "paymentOption": {
        "alternativePaymentMethod": {
            "paymentMethod": "apmgw_PIX",
            "personal_id": "<personal_id>"
        }
    },
    "billingAddress":{
      "country":"US",
      "email":"john.smith@email.com"
    },
    "deviceDetails": {
        "ipAddress": "127.0.0.1"
    },
    "userDetails": {
        "firstName": "John",
        "lastName": "Smith",
        "address": "12, SBS Q. 2",
        "phone": "6133145555",
        "zip": "70070",
        "city": "Brasília",
        "email": "john.smith@email.com",
        "country": "BR"
    },
    "timeStamp": "<YYYYMMDDHHmmss>",
    "checksum": "<calculated checksum>"
}

For this APM, the following parameters are mandatory:

• userTokenId – Unique identifier of the customer in your system
• amount
• currency
• paymentOption.alternativePaymentMethod block containing:
  • paymentMethod: "apmgw_PIX"
  • personal_id
• deviceDetails block containing: ipAddress
• billingAddress block containing: country, email
• userDetails block containing: firstName, lastName, address, phone, zip, city, email, country

User Experience

With Redirect

1. Enter the amount to deposit (quantity and currency) followed by the personal ID (CPF) number, then press Deposit.
2. After being redirected to a QR page, scan the QR code with a mobile device.
3. Authorize the payment with the mobile device to complete the transaction.

With Merchant Generated QR Code

1. Enter the amount to deposit (quantity and currency) followed by the personal ID (CPF) number, then press Deposit.
2. Scan the QR code that is generated on the payment page with a mobile device.
3. Authorize the payment with the mobile device to complete the transaction.

Example Responses

Example response for when a customer is redirected to a URL that contains a QR created by Nuvei.

{
    "orderId": "37287371",
    "userTokenId": "chochoRank1hht5ehdehfje33hjdskggtthgjjgh44e7",
    "paymentOption": {
        "redirectUrl": "https://noccapi-stg.paymentez.com/qr/render/TlZFSVFFU0hQSVgtQlJMO0tPSS01OTU7ODMzYTZhNjZiMDk1NTg4ZWIzODJkYWJlZDdlNzg0MzNmMzVkOGZiYjRjYzcwNTU2Mjc2Y2Q2MzY4N2NkYzc0ZA==",
        "userPaymentOptionId": "8179541",
        "card": {}
    },
    "transactionStatus": "REDIRECT",
    "merchantDetails": {
        "customField1": "<merchantName>",
    },
    "sessionToken": "04cb9877-34da-4ea5-8c71-a8f60e08d1c6",
    "clientUniqueId": "uniqueIdCC",
    "internalRequestId": 20295621,
    "status": "SUCCESS",
    "errCode": 0,
    "reason": "",
    "merchantId": "4526724817460808257",
    "merchantSiteId": "178906",
    "version": "1.0",
    "clientRequestId": "20220526172147"
}

Example response for when a customer generates their own QR code in their system.

{
    "orderId": "37287311",
    "userTokenId": "chochoRank1hht5efdshjfhjdskggtthgjjgh44e7",
    "paymentOption": {
        "redirectUrl": "qrCode=iVBORw0KGgoAAAANSUhEUgAAAPoAAAD6AQAAAACgl2eQAAADCUlEQVR4Xu2XUW4cIRBE6YvA/W+Ro8BFIPWKsWU5kpWPbOVn8SaZhWep1F1dTNr5ef1q33e+rTdw1xu466+A2VqtXbuP3etMPY9zlrdjwPLnrNm1NceaNXtv426nAOliqw5K+1io3IBhoFyZsWuaE/UfgM1h0xpzTMqUBfRxXZB2ONylhy/Nej0wMe2fi+0Y4KUend1omcZHR7vufgigNMzLEDXFbL63Pj6bFQBkld57MS0KkEWfdhOg3sWAI0mYRUIJMkvGwq5VCJhWtwkwAWoXIcJvjRxw9WnL/YKQWxejPGKAxvZgEHWoBKlhErztmBhgafaMXCtqWKVDJQYc2oNndY5llncEspUDlOFFrXRA23QiUl9jwB7aPvhkoE5UGeQxBlyFLEaXCbrW+XT16wGe9Kcsk25JsH/oWgjw9PbGge+ysdAtgRAhwNm1iW+rXN5pV2oMuEaVTHlXL30iFaySXU+hAsBGpJulzAAclE3geEQGAIzCfcKrFv7VEVna3LAQMIcNyiue7lKSg1ppQ0OcAshPWWT4amNtarb4GgN8qcmwvlAk8qNRtC4GuEVKLn13fKlUUuxepQC+C9NWJ9ZlHRu5iLMUMPGrdhkZLKwLpvQfoXvXhoCDzsZP0beFgagefgkC0yWiVbxqFBmmn/Xh6tcDyxnGtUpskJ/Mb0dpDGBQnSJSJ7NKHYahaR+Fej3wWMSqMI/+Utmkmm6lgCewfICwmyPdHg4BGtRBkHp+m29VqbPyHCCPKL+pFzpJUiZIep9CBQAnOZ+nQwu3TP8bAybjqvJgkyI+DjLF07gQ4M5wXEibvtod5u0RGQDYKhhZFX3ca9hYuRID9GbDidql+kgt/eKCpYMpwGaVIAZGAaKObZyL1BygxTMgMUKXuOEXbQwBFEWaOt4tusQW/eKXQsDic0vE+17njA4SrjFg8n43XCwbZQsdfooCC4eSJJoXJVkRYJ/NSgHEOBIJ8wtYeAzQh0HpCjLop3GDeU4BtEU2kUpXR1YhQqlXDvhxvYG73sBd/wD4Df7+v4eqIoYgAAAAAElFTkSuQmCC&content=00020101021126950014BR.GOV.BCB.PIX2573spi.dev.cloud.itau.com.br/documentos/198e49c5-2330-4ad7-9d0b-967c7b5371225204000053039865802BR5923PMD Gotham NegA cios ME6009SAO PAULO62410503***50300017BR.GOV.BCB.BRCODE01051.0.063040866",
        "userPaymentOptionId": "8179511",
        "card": {}
    },
    "transactionStatus": "REDIRECT",
    "sessionToken": "485b3e6f-64e6-47ca-a189-66dc20b1daed",
    "clientUniqueId": "uniqueIdCC",
    "internalRequestId": 20295521,
    "status": "SUCCESS",
    "errCode": 0,
    "reason": "",
    "merchantId": "<>",
    "merchantSiteId": "178906",
    "version": "1.0",
    "clientRequestId": "20220526171319"
}

Testing

Testing is possible with any valid personal ID (CPF) (Example: 26658083827).