Arquitetura da integração

O modelo empregado na integração das APIs é simples e se baseia na utilização de duas URLs:

  • URL transacional - específica para operações como autorização, captura e cancelamento de transações.
  • URL de consulta - para operações consultivas, como uma pesquisa de transações.

Para executar uma operação:

  1. Combine a base da URL do ambiente com o endpoint da operação desejada. Ex.: https://api.braspag.com.br/_v2/sales/_.
  2. Envie a requisição para a URL utilizando o método HTTP adequado à operação.
Método HTTPDescrição
GETRetorna recursos já existentes, ex.: consulta de transações.
POSTCria um novo recurso, ex.: criação de uma transação.
PUTAtualiza um recurso existente, ex.: captura ou cancelamento de uma transação previamente autorizada.

ℹ️

Todas a operações requerem as credenciais de acesso MerchantId e Merchant Key, que devem ser enviadas no cabeçalho (header) da requisição.

Cada envio de requisição irá retornar um código de Status HTTP, indicando se ela foi realizada com sucesso ou não.

Para saber se a transação foi autorizada, confira na resposta o parâmetro Status.