Technical integration

The only difference to the core Volt Gateway integration is that the document ID (CPFs, Brazilian tax IDs unique to each person) and Payer Name must be included in the payment request under the payer object.

The integration is as simple as follows:

  • Complete our core integration by getting started here
  • Add the payer->name and payer->document_id (CPF) fields
  • Enjoy receiving Pix transactions from all Brazilian banks

Embedded flow

If you want to render the Pix QR code on your website, please make sure you use the /V2/payments endpoint. Further information can be found here.

When sending requests to /V2/payments, you will receive at the response a new field called qrString.

qrString is the text from ‘Pix copia e cola’. It’s also the string needed to generate a QR code – just use the qrString as the param from your qrCode generator library and show it on your website.

Also show the qrString as the string for Pix copia e cola, so mobile users can copy and paste it in their banking app to pay.

Testing different responses

We support testing a successful received transaction in the Sandbox environment and also a transaction that will never be paid.

To test the two different flows, just use the amount as the trigger. If the amount ends in 00 (e.g. BRL10.00), we will automatically simulate the payment of this transaction.

Any other ending will not simulate the payment, and you will not be able to see the complete checkout when redirected to the checkout page.

Example request:

Endpoint: https://api.sandbox.volt.io/v2/payments
{
   "currencyCode":"BRL",
   "amount":1000,
   "type":"OTHER",
   "uniqueReference":"test51224324",
   "payer":{
      "reference":"user13489",
      "email":"john.smith@example.com",
      "name":"John Smith",
      "ip":"192.168.0.1",
      "documentId":34886543030
   }
}
{
    "id": "340e4522-11b1-4a15-ac3c-73c7cbd91c51",
    "checkoutUrl": "https://checkout.sandbox.volt.io/340e4522-11b1-4a15-ac3c-73c7cbd91c51?auth=eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE2NjU1NTczNzIsImV4cCI6MTY2NTU1OTE3Miwicm9sZXMiOltdLCJwYXltZW50SWQiOiIzNDBlNDUyMi0xMWIxLTRhMTUtYWMzYy03M2M3Y2JkOTFjNTEifQ.VRcj5wUy6bJdDdSK32NAjDUBkgUNPE8VET2YPqP9UyvXTVYjEIqi2pMz9IMt-TXmfvifDFtcRx8XD-O2HUL2nb5xe2ePciXZipPIRfn5P65AhHzw6zxdiUkVPUarWSuRYXtMVcy_uLjOasyfZYi6aI6EUsBXhqSVdYrY7eT_Tml2meDPf3KRLg08WcH8Oj-F_u0R6GqhoGrEC84JQph64GGlHW-iEOcBTWVScvw-A5YAIeIy9mxZPaY4x5DLt3ZKuFmPB5tfb7pEhruZPycLF-Ubo74__qFGpnL1YajBNTcDWdXghOSysQi1T_F8qBUIxBUwxhrE7mHtQMSL68DKvUQYZYuvPi7XrUEhIQILtII0cMkXTELoBvWBItGo6ixjSq2D6_5h81Vkqau3D5KHvx7buwITHUx133Lo9zr5c-W9-8IvMP9S28_ZL7i_5pVOT1z7_ahJMoTdKx6rfknNJckY98A7q00DqU_c9MItjg5aiBcoABOKYcqj2Vl16cfnist7EPCmt7uE4k69Nkxm3fhHdzQI_QeHT6EPwlARrbQ6_FiMAK8BnsLJ29FmX7ctMbeMenCCZ79Mqe9X02owOeOAE-g9pLA7bI8IGi6JxdVhntJUCWQilrJSfRcL71gACRoIyOHCsSZrxB50pT_VDc8sqEW_IZmEfSdH3S93pgA",
    "qrString": "000201010212261850014BR.GOV.BCB.PIX2516200020126540014br.gov.bcb.pix0132pix_marketplace@voltiobrasil.com520400005303986540560.205802BR5915HOME GAMES_INFO6009Itaperuna62240520mpqrinter153831049366304CB2F52042313530398654040.105802BR5920VOLT PAGAMENTOS LTDA6009SAO PAULO62390501050300017BR.GOV.BCB.BRCODE01051.0.06304326E"
}