get
https://apiquerysandbox.braspag.com.br/v2/sales
Consulta todas as vendas (PaymentId) relacionados a uma loja (MerchantOrderId).
| Ambiente | Método | Endpoint |
|---|---|---|
| Sandbox | get | https://apiquerysandbox.braspag.com.br/v2/sales?merchantOrderId={merchantOrderId} |
| Produção | get | https://apiquery.braspag.com.br/v2/sales?merchantOrderId={merchantOrderId} |
Não é possível consultar um pagamento diretamente pelo identificador enviado pela loja (MerchantOrderId), mas é possível obter todos os PaymentIds associados ao identificador.
Resposta da consulta de transação pelo MerchantOrderId
A tabela a seguir apresenta os principais parâmetros que podem ser retornados pela API na consulta de transação pelo MerchantOrderId.
| Propriedade | Descrição | Tipo | Tamanho |
|---|---|---|---|
ReasonCode | Código de retorno da API para indicar sucesso ou erro na operação. | string | 32 |
ReasonMessage | Mensagem correspondente ao ReasonCode. | string | 512 |
PaymentId | Campo identificador do pedido. | string | 36 |
ReceivedDate | Data em que a transação foi recebida pela API. | string | 19 |
Para consultar uma venda pelo identificador da loja, é necessário o envio de mensagem HTTP do método GET para o recurso /sales, conforme o exemplo: