Confira a seguir os recursos disponíveis na API Gateway de Pagamentos.
API transacional
URL sandbox: https://apisandbox.braspag.com.br/
URL produção: https://api.braspag.com.br/
| Método | Endpoint | Descrição |
|---|---|---|
post | /v2/verifycard | Valida o cartão com Zero Auth e retorna as informações do cartão a partir da consulta BIN ou token do cartão. |
post | /v2/sales/ | -Cria pagamentos (para cada meio de pagamento); - Cria recorrências; -Salva cartões durante a autorização; - Cria pagamentos com antifraude. |
post | /v1/authorize | Obtém as parcelas de uma integração com a Koin. |
put | /v2/sales/{PaymentId}/capture | Captura transação de cartão de crédito. |
put | /v2/sales/{PaymentId}/void | - Cancela ou estorna uma transação de cartão de crédito ou débito via PaymentId;- Solicita uma devolução Pix; - Estorna um pagamento BNPL. |
put | /v2/RecurrentPayment/{RecurrentPaymentId}/Customer | Altera dados do comprador em um pagamento recorrente. |
put | /v2/RecurrentPayment/{RecurrentPaymentId}/Payment | Altera dados do pagamento recorrente. |
put | /v2/RecurrentPayment/{RecurrentPaymentId}/Amount | Altera valor do pagamento recorrente. |
put | /v2/RecurrentPayment/{RecurrentPaymentId}/RecurrencyDay | Altera dia do pagamento recorrente. |
put | /v2/RecurrentPayment/{RecurrentPaymentId}/NextPaymentDate | Altera data do próximo pagamento recorrente. |
put | /v2/RecurrentPayment/{RecurrentPaymentId}/Interval | Altera intervalo do pagamento recorrente. |
put | /v2/RecurrentPayment/{RecurrentPaymentId}/EndDate | Altera data final do pagamento recorrente. |
put | /v2/RecurrentPayment/{RecurrentPaymentId}/Deactivate | Desativa um pagamento recorrente. |
put | /v2/RecurrentPayment/{RecurrentPaymentId}/Reactivate | Reativa um pagamento recorrente. |
API de consulta
URL sandbox: https://apiquerysandbox.braspag.com.br/
URL produção: https://apiquery.braspag.com.br/
| Método | Endpoint | Descrição |
|---|---|---|
get | /v2/sales/{PaymentId} | Consulta transação pelo PaymentId. |
get | /v2/sales?merchantOrderId={merchantOrderId} | Consulta transação pelo MerchantOrderId. |
get | /v2/RecurrentPayment/{RecurrentPaymentId} | Consulta transação recorrente. |
API de autenticação do Cartão protegido
URL sandbox: https://authsandbox.braspag.com.br/_oauth2/token
URL produção: https://auth.braspag.com.br/_oauth2/token
| Método | Endpoint | Descrição |
|---|---|---|
post | oauth2/token | Obtém o token de acesso a API do cartão protegido |
API do Cartão protegido
URL sandbox: https://cartaoprotegidoapisandbox.braspag.com.br/
URL produção: https://cartaoprotegidoapi.braspag.com.br/
| Método | Endpoint | Descrição |
|---|---|---|
post | /v1/Token | Cria um cartão tokenizado (token reference) |
get | /v1/Token/{TokenReference} | Consulta informações relacionadas a um TokenReference, tais como Status, Cartão Mascarado, Data de Validade e Nome do Portador. |
get | /v1/Alias/{Alias}/TokenReference | Obtém o TokenReference por meio de um alias (apelido do cartão) previamente informado. |
get | /v1/Token/{TokenReference}/suspend | Suspende um TokenReference temporariamente. |
get | /v1/Token/{TokenReference}/unsuspend | Reativa um TokenReference. |
delete | /v1/Token/{TokenReference} | Exclui o TokenReference da base definitivamente. |