PIX is a server to server only payment method to increase conversion.
Please note that you will need to collect at least one “chave” to generate a PIX. The chave is set by the end-customer with the bank they use. As “chave” they can use their CPF, email or phone number. We recommend you give them all three options at checkout as the end-customer is not required to register all 3 “chaves” with their bank.
Payment Types | Meaning | Success return codes |
|---|
PA | Successful generation of the PIX QR-Code. The shopper can go and pay for it online or at any supported POS | 000.000.000 000.100.112 (on staging) |
RC | Successful payment of PIX. The payment of the PIX is asynchronous and the payment confirmation depends on when the PIX was paid by the consumer | 000.000.000 |
...
| Code Block |
|---|
//send POST to https://test.oppwa.com/v1/payments
//Header -H "Authorization: Bearer OGE4Mjk0MTg0ZTczNjAxMjAxNGU3OGExN2E2YTE1YjB8ZjJGRUtacXRCUA=="
amount=10.00
currency=BRL
paymentBrand=PIX
paymentType=PA
//API credentials
entityId=8a8294174ae82ada014aedfd75aa1d79
//API credentials end
//Shopper details (all mandatory)
customer.givenName=Gustavo
customer.surname=Santos
customer.identificationDocType=TAXSTATEMENT // Type of the identification DOC. Needed as you need to send a CPF/CNPJ
customer.identificationDocId=7038305310258000970031 //CPF/CNPJ number of end customer
//end of shopper details
billing.country="BR"
customParameters[CUSTOM_due_time]=7200 //Due time of the PIX in seconds. 7200 seconds = 2hours. You can also use customParameters[CUSTOM_due_date]=DDMMYYYY. If no expiry date is sent, will be set to 3 days by default.
merchantTransactionId=1234
shopperResultUrl=http://www.primeiropay.com //Although there is no re-direct back from PIX to your shop, our API requires this parameter to be present
testMode=EXTERNAL // only required on staging. Please remove on production environment |
|
...
| Code Block |
|---|
{
"id":"8a82944964ea186c0164ecbf445f7385",
"paymentType":"PA",
"paymentBrand":"PIX",
"amount":"10.00",
"currency":"BRL",
"descriptor":"Test Merchant 2460.0146.3970 Virtual Goods",
"merchantTransactionId":"1234",
"result":{
"code":"000.100.112",
"description":"Request successfully processed in 'Merchant in Connector Test Mode'"
},
"resultDetails":{
"ExtendedDescription":"Payment method ready to be captured",
"connectorId":"beb52023-ea89-4750-9a82-75525d189249",
"ConnectorTxID2":"1234",
"reconciliationId":"1234"
},
"customer":{
"givenName":"Gustavo",
"surname":"Santos",
"identificationDocType":"TAXSTATEMENT",
"identificationDocId":"7038305310258000970031",
},
"customParameters":{
"CUSTOM_due_time":"7200"
},
"redirect":{
"url":"https://pix.primeiropay.com/2313413241414",
"parameters":[
]
},
"buildNumber":"ff2430ab706f7ca0b5b903b11604719f5424d21c@2018-07-27 10:29:18 +0000",
"timestamp":"2018-07-30 19:51:58+0000",
"ndc":"8a8294174ae82ada014aedfd75aa1d79_dca6a0b62dc44d0e81195603af6f39a7"
} |
|
...
| Code Block |
|---|
[2018-07-30][19:57:13,046]Notification b8d00c6a-276b-4816-a423-a7996e376834 message: {"type":"PAYMENT","payload":
{"id":"8a82944a64ea2a060164ecc41d671606","referencedId":"8a82944a64ea2a060164ecc06db70bce","paymentType":"RC",
"amount":"10.0","currency":"BRL","presentationAmount":"10.0","presentationCurrency":"BRL",
"descriptor":"Test Merchant 6086.5776.5026 Virtual Goods","merchantTransactionId":"****",
"result":{"code":"000.100.112","description":"Request successfully processed in 'Merchant in Connector Test Mode'",
"randomField621972632":"Please allow for new unexpected fields to be added"},
"customer":{"givenName":"Gustavo","surname":"Santos","identificationDocType":"TAXSTATEMENT","identificationDocId":"7038305310258000970031"},
"billing":{"country":"BR"},
"authentication":{"entityId":"8a8294174ae82ada014aedfd75aa1d79"},"customParameters":{"INFO_matchingAlgorithm":"MANUAL_MATCH"},
"redirect":{"parameters":[]},
"risk":{"score":""},"timestamp":"2018-07-30 19:57:12+0000","ndc":"DFCAD1AC1C0E00977B5A9FFE0E85AB3D.sbg-vm-bip01_1234_rand3cd6e14412f83147"}} |
|
...