...
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
//send POST to https://test.oppwa.com/v1/payments //Header -H "Authorization: Bearer OGE4Mjk0MTg0ZTczNjAxMjAxNGU3OGExN2E2YTE1YjB8ZjJGRUtacXRCUA==" amount=10.00 00 currency=BRL BRL paymentBrand=BOLETO paymentType=PA //API credentials entityId=8a8294174ae82ada014aedfd75aa1d79 //API credentials end //Dummy data, replace with your shopper`s details customer.identificationDocType=TAXSTATEMENT billing.street1=Av Brigadeiro Faria Lima 3729 billing.city=Sao Paulo billing.state=SP // State with 2 digits billing.postcode=04538905 //postcode with 8 numeric digits, no dashes, spaces or slashes. billing.country=BR //Country with 2 digits customer.givenName=Gustavo customer.surname=Santos customer.ip=1.1.1.1 customer.email=test@test.com customer.identificationDocType=TAXSTATEMENT // Type of the identification DOC. Needed as you need to send a CPF. customer.identificationDocId=70383053102 //CPF number of end customer //end of shopper details customParameters[CUSTOM_due_date]=21012018 //Due date of the Boleto. We recommend 3 days of the issuance date merchantTransactionId=1234 shopperResultUrl=http://google.com //Although there is no re-direct back from the Boleto to your shop, our API requires this parameter to be present testMode=EXTERNAL // only required on staging. Please remove on production environment |
...
Name | Description | Format | Example | |||||
| Authorization Bearer (Header) | Authentication token used to identify the merchant. | AN [a-zA-Z0- 9_] | Bearer OGE4Mjk0MTg0ZTczNjAxMjAxNGU3OGExN2E2YTE1YjB8ZjJGRUtacXRCUA== | |||||
amount | Amount of the payment request. The dot is used as a decimal separator. | N13 [0- 9]{1,10}\.[0 -9]{2} | 1.00 | |||||
currency | Currency Code according to ISO 4217 specifications of the payment request’s amount | A3 [a-zA-Z]{3} | BRL | |||||
paymentBrand | The brand specifies the method for the request | AN32 [a-zA-Z0- 9_] {1,32} | BOLETO | |||||
paymentType | The payment type for the request | A2 | PA | Authentication.userID | The userId for the entity. Required for a server-to-server request | Authentication.password | The password for the entity (channel). Required for a server-to-server request | AN32 [a-zA-Z0- 9]{8,32}AKdx7nmH |
authentication.entityId | The entity for the request. (e.g. channel) | AN32 [a-zA-Z0- 9]{32} | 8a8294174ae82ada014 aedfd75aa1d79 | |||||
customer.email | The (internal) email address of the customer | AN128 [\s\S]{6,12 8} | ||||||
customer.ip | AN255 [\s\S]{1,25 5} | AN255 [\s\S]{1,25 5} | 1.1.1.1 | |||||
customer.identificationDocId | CPF number of customer or CNPJ of the company | N11 | 70383053102or N14 | 50439917476 or 50966454000190 | ||||
merchantTransactionID | Merchant-provided reference number | AN255 [\s\S]{1,25 5} | 1234 | |||||
customParameters[CUSTOM_due_date] | Due Date of the Boleto. Recommended: 3 days in the future. Format: DDMMYYYY | AN10 {19|20}([0-9]{2})-(0[1-9]|1[0-2])-(0[1-9]|1[0-9]|2[0-9]|3[0-1]) | 21012016 |
...