Check out the available resources in the Gateway de Pagamento API below
Transactional API
URL sandbox: https://apisandbox.braspag.com.br/
URL production: https://api.braspag.com.br/
| Method | Endpoint | Description |
|---|---|---|
post | /v2/verifycard | Validates the card with Zero Auth and returns the card information based on the BIN query or card token. |
post | /v2/sales/ | - Creates payments (for each payment method); - Creates recurring payments; - Saves cards during authorization; - Creates payments with Antifraude. |
put | /v2/sales/{PaymentId}/capture | Captures credit card transaction. |
put | /v2/sales/{PaymentId}/void | - Cancels or refunds a credit or debit card transaction via PaymentId;- Requests a Pix refund. |
put | /v2/RecurrentPayment/{RecurrentPaymentId}/Customer | Changes shopper's data in a recurring payment. |
put | /v2/RecurrentPayment/{RecurrentPaymentId}/Payment | Changes recurring payment data. |
put | /v2/RecurrentPayment/{RecurrentPaymentId}/Amount | Changes recurring payment amount. |
put | /v2/RecurrentPayment/{RecurrentPaymentId}/RecurrencyDay | Changes recurring payment date. |
put | /v2/RecurrentPayment/{RecurrentPaymentId}/NextPaymentDate | Changes next recurring payment date. |
put | /v2/RecurrentPayment/{RecurrentPaymentId}/Interval | Changes recurring payment interval. |
put | /v2/RecurrentPayment/{RecurrentPaymentId}/EndDate | Changes end date of recurring payment. |
put | /v2/RecurrentPayment/{RecurrentPaymentId}/Deactivate | Deactivates a recurring payment. |
put | /v2/RecurrentPayment/{RecurrentPaymentId}/Reactivate | Reactivates a recurring payment. |
Query API
URL sandbox: https://apiquerysandbox.braspag.com.br/
URL production: https://apiquery.braspag.com.br/
| Method | Endpoint | Description |
|---|---|---|
get | /v2/sales/{PaymentId} | Queries transaction by PaymentId. |
get | /v2/sales?merchantOrderId={merchantOrderId} | Queries transaction byMerchantOrderId. |
get | /v2/RecurrentPayment/{RecurrentPaymentId} | Queries recurring transaction. |
API authentication Cartão Protegido
URL sandbox: https://authsandbox.braspag.com.br/_oauth2/token
URL production: https://auth.braspag.com.br/_oauth2/token
| Método | Endpoint | Descrição |
|---|---|---|
post | oauth2/token | Gets the API access token from the Cartão Protegido. |
API Cartão Protegido
URL sandbox: https://cartaoprotegidoapisandbox.braspag.com.br/
URL production: https://cartaoprotegidoapi.braspag.com.br/
| Método | Endpoint | Descrição |
|---|---|---|
post | /v1/Token | Create card token (token reference) |
get | /v1/Token/{TokenReference} | Obtain information related to a token reference, such as status, masked card, expiration date, and cardholder name. |
get | /v1/Alias/{Alias}/TokenReference | Get the token reference from a previously informed alias. |
get | /v1/Token/{TokenReference}/suspend | Suspend a token reference temporarily. |
get | /v1/Token/{TokenReference}/unsuspend | Reactivate a token reference that was temporarily suspended. |
delete | /v1/Token/{TokenReference} | Delete token reference permanently from data base. |