What can we help you with?

  1. What is necessary to try the API and how do I get the sandbox credentials?

    You do not need to be a customer to try our API! Just contact our team at integration@bexsbanco.com.br to get a free-of-charge credential and instant access to our sandbox environment.

  2. What is the API authentication method?

    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)

  3. Why am I receiving a 401 error during my tests?

    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.

  4. Should I pass empty strings for optional values?

    If you don’t want to pass fields that are optional, your handler should not pass empty strings

  5. I’m getting errors while using the REST APIs. What do I do?

    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.

  6. Who do I contact if I have questions or need support?

    You can contact us by e-mail integration@bexs.combr or being part of our Slack channel. Our timezone is BRT

  7. What are the status of a typical payment transaction?

    • WAITING_CONSUMER: occurs when the payment is waiting some confirmation or authentication by the consumer. Generally, occurs on transactions of debit, on banking slips that is waiting payment or when the issuer has two authentication factors enabled because of risk.
    • AUTHORIZED: the payment was authorized by issuer. On that status, the consumer's balance was checked but the payment is not confirmed. The payment is pending of confirmation.You can confirm a payment automatically by the parameter "confirm: true".
    • CONFIRMED: the payment was authorized by issuer and is confirmed.
    • CANCELED: the payment was canceled.
    • DECLINED_BY_ISSUER: the payment was declined by issuer and the reason is described on response
    • DECLINED_BY_BUSINESS_RULE: the payment was declined by some business rule from Bexs Bay and the reason is described on response
  8. What are the local payments methods in Brazil?

    • Brazilian Bank Slip: Also knows as Boleto Bancario or voucher, is a very popular method that allows sell to consumers without a credit or debit card. It can be paid online or offline, in cash, mobile or online banking using a barcode. It is a method with zero risk of fraud or chargeback and can take until three days to be settled.
    • Brazilian Domestic Cards: Only a few percentage of brazilians have cards that works on international transactions. Our platform is ready to offer access to the whole universe of credit and debit cards of brazilians consumers.
    • Online Banking (TEF): Also knows online debit, is a method that connects our platform direct to a online bank account with instantaneous response, without dependence of a card. It is a method with zero risk of fraud or chargeback.

    Please , note that this support will be available soon.

  9. What are the use cases of late confirmation function?

    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.

  10. What are the card brands and payment types available?

    General availability by Card Brand
    Card Payment TypeMastercardVisaAmexEloHipercardDiners
    Credit cardAvailableAvailableAvailableAvailableAvailableAvailable
    Credit card with installmentsAvailableAvailableAvailableAvailableAvailableAvailable
    Credit with authenticationAvailableAvailableUnavailableUnavailableUnavailableUnavailable
    Debit with authenticationAvailableAvailableUnavailableUnavailableUnavailableUnavailable
    Soft DescriptorAvailableAvailableAvailableAvailableAvailableUnavailable

    We are increasing new card brands and payment types every month.

  11. What are local payment methods available?

    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.

  12. How a payment cancellation works?

    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.

  13. Card numbers and general information for testing

    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 and scenarios for test
    Card NumberPayment TypeInstallmentsHttp CodeResult
    4556897654968402Credit3200 OKSuccess
    4929785925958759Credit3200 OKSuccess
    4024007129267307Credit1200 OKSuccess
    4024007159375863Credit3200 OKSuccess
    5121116960598636Credit3200 OKSuccess
    342398203700310Credit3200 OKSuccess
    342091561592540Credit3200 OKSuccess
    6011652830881662Credit1200 OKSuccess
    4532882971768528Debit1200 OKSuccess
    4716071517283162Debit1422 Denied
    5532882971768528Debit1200 OKSuccess
    5716071517283162Debit1422 Denied
    5200000000001096Debit Without Authenticate1200 OKSuccess
    4000000000001000Debit Without Authenticate1200 OKSuccess
    2221000601734667Debit Without Authenticate1422 Denied
    4000000000001109Debit Without Authenticate1422 Denied

    National IDs for test

    Please, as national id is a mandatory field on API, please use one described on table bellow:

    00015262197, 00016476107 or 00020298048

  14. Expected scenarios for Pix payments (Sandbox environment)

    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:


    "amount": 1.01


    We will be consider behavior as the table below:

    Scenario DescriptionDecimal NumberStatus after creationStatus after 3 seconds
    QR Code generated sucessfully and after the creation approved*.*1WAITING_CONSUMERCONFIRMED
    Transaction denied on creation*.*2DECLINED_BY_ISSUERDECLINED_BY_ISSUER
    Transaction denied after the creation*.*3WAITING_CONSUMERCANCELED
    QR Code generated succesfully and payment does not receive any updates after*.*4WAITING_CONSUMERWAITING_CONSUMER
Copyright © 2019 Bexs Banco de Câmbio S/A