You do not need to be a customer to try our API! Just contact our team at email@example.com to get a free-of-charge credential and instant access to our sandbox environment.
Access to the Bexs Pay API is available using industry standard OAuth2 authentication methods for transparent and secure access to user data.
Token Generator for oAuth2:
In order to have access to your token, you need to make a request to this endpoint using HTTP Basic Authentication
(HTTP/1.0 - 11.1 Basic Authentication Scheme)
Due our authentication method, you need to have access to a token, which is reponsible for check your credentials. If you already got a token and the error persists, please note that a token could be expired. Call authentication service again to receive a new one. Check our API page.
If you don’t want to pass fields that are optional, your handler should not pass empty strings
You can read about REST API errors in the REST API reference. This list can help you anticipate and account for most errors. You can also learn how to handle common REST Payment API errors.
You can contact us by e-mail firstname.lastname@example.org or being part of our Slack channel. Our timezone is BRT
Please , note that this support will be available soon.
Represented as the “confirm” property on a payment request, it indicates that payment will check and block the amount on consumer’s balance but is awaiting the confirmation message. It is a useful function when you have to run business rules before product shipping.
|Card Payment Type||Mastercard||Visa||Amex||Elo||Hipercard||Diners|
|Credit card with installments||Available||Available||Available||Available||Available||Available|
|Credit with authentication||Available||Available||Unavailable||Unavailable||Unavailable||Unavailable|
|Debit with authentication||Available||Available||Unavailable||Unavailable||Unavailable||Unavailable|
We are increasing new card brands and payment types every month.
We have local support to bank slip (Boleto Bancario). Please check our API guide to know more about it.
Soon, we will have support to Online Debit (Bank Transfers) to main issuers in Brazil.
Our platform is ready to process cancellation of payments, including partial amount and with more than one cancellation, limited to total amount from payment. You can decide what rules are better to your business model.
The amount will be available on consumer bank account until 10 business days.
We are able to communicate consumer by e-mail about cancellation rules and events on payments. Please, let us know to activate this feature and communicate with consumer on your behalf.
While testing, use only the test credit card numbers on table bellow. Other numbers produce an error.
The expiration date must be a valid date in the future and the secure code is not validated on test enviroment.
|Card Number||Payment Type||Installments||Http Code||Result|
|5200000000001096||Debit Without Authenticate||1||200 OK||Success|
|4000000000001000||Debit Without Authenticate||1||200 OK||Success|
|2221000601734667||Debit Without Authenticate||1||422||Denied|
|4000000000001109||Debit Without Authenticate||1||422||Denied|
Please, as national id is a mandatory field on API, please use one described on table bellow:
00015262197, 00016476107 or 00020298048
Pix payments are asynchronous and depend on the final user to finalize the payment in his own bank. This scenario cannot be replicated in the sandbox environment.
Therefore to simulate some expected scenarios for Pix payments it is necessary to send the last number of the amount field value following the payload below:
We will be consider behavior as the table below:
|Scenario Description||Decimal Number||Status after creation||Status after 3 seconds|
|QR Code generated sucessfully and after the creation approved||*.*1||WAITING_CONSUMER||CONFIRMED|
|Transaction denied on creation||*.*2||DECLINED_BY_ISSUER||DECLINED_BY_ISSUER|
|Transaction denied after the creation||*.*3||WAITING_CONSUMER||CANCELED|
|QR Code generated succesfully and payment does not receive any updates after||*.*4||WAITING_CONSUMER||WAITING_CONSUMER|