Supported Brands
Brand Name | Installments |
---|---|
VISA | 2-12 |
MASTER | 2-12 |
ELO | 2-12 |
AMEX | 2-12 |
HYPER | 2-12 |
Transaction Types | Meaning | Success return codes |
---|---|---|
PA | Authorization of the card. This transaction type has to be followed by a CP event | 000.000.000 |
DB | Debit of the card without prior authorization request | 000.000.000 |
CP | Capture of the Amount previously authorized | 000.000.000 |
Create the checkout
GET Request to the following endpoint:
https://test.oppwa.com/v1/checkouts/
Create the checkout
amount=1.00 currency=BRL paymentType=PA//your API Credentialsauthentication.userId=8a8294174ae82ada014aedf7fb151d5f authentication.password=AKdx7nmH authentication.entityId=8a8294174ae82ada014aedfd75aa1d79 //end of API Credentials customer.ip=1.1.1.1 customer.email=test@test.com merchantTransactionID=1234 //this value will show up on settlement reports and serves as your reference for this transaction
Successful Response
Response Checkout
{ "result":{ "code":"000.200.100", "description":"successfully created checkout" }, "buildNumber":"beb408d1f2c902bfb8665e2b4e268f1039848d03@2016-02-16 12:49:58 +0000", "timestamp":"2016-02-16 13:25:09+0000", "ndc":"DA84DCEB01BD28810E992D9EC8085985.sbg-vm-tx01", "id":"DA84DCEB01BD28810E992D9EC8085985.sbg-vm-tx01" }
Create the Hosted Payment Page / Payment Form
Payment Form
<script> //display the CPF number and set language to Portuguese var wpwlOptions ={ showTaxNumberField:true, locale:"pt" } </script> <script src="https://test.oppwa.com/v1/paymentWidgets.js?checkoutId=75E53EDE2467B24C179501962555376C.sbg-vm-tx02"></script> //Define the card brands you want to allow and also set the shopper result URL in which the shopper is being redirected to once the payment is concluded <form action=" {shopperResultUrl}" class="paymentWidgets">VISA MASTER ELO</form>
Field specifications
Name | Description | Format | Example |
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 |
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 |
merchantTransactionID | Merchant-provided reference number | AN255 [\s\S]{1,25 5} | 1234 |