É possível remover um QR Code Pix já gerado caso ele não tenha sido pago. Caso o Pix tenha sido pago, veja como solicitar uma devolução Pix.
Requisição
Ambiente | Método | Endpoint |
---|---|---|
Sandbox | post | https://apisandbox.braspag.com.br/v2/sales/ |
Produção | post | https://api.braspag.com.br/v2/sales/ |
Parâmetros do path
Campo | Tipo | Descrição | Obrigatório |
---|---|---|---|
PaymentId | string | Número de identificação do pagamento, retornado pela API na criação do QR Code Pix. Tamanho: 36. | Sim |
Parâmetros do cabeçalho
Propriedade | Descrição | Tipo | Tamanho | Obrigatório |
---|---|---|---|---|
MerchantId | Identificador da loja no Gateway de Pagamentos. | Text | 36 | Sim |
MerchantKey | Chave pública para autenticação dupla no Gateway de Pagamentos. | Text | 40 | Sim |
RequestId | Identificador da requisição, usado quando a loja usa diferentes servidores para cada GET/POST/PUT. | Text | 36 | Não |
Resposta
{
"Status": 2,
"ReasonCode": 8,
"ReasonMessage": "Scheduled",
"ProviderReturnCode": "0",
"ProviderReturnMessage": "OPERACAO REALIZADA COM SUCESSO",
"Links": [
{
"Method": "GET",
"Rel": "self",
"Href": "https://apiquerysandbox.braspag.com.br/v2/sales/34fc280a-8b98-44c9-bc8f-5911bbeef952"
},
{
"Method": "PUT",
"Rel": "void",
"Href": "https://apisandbox.braspag.com.br/v2/sales/34fc280a-8b98-44c9-bc8f-5911bbeef952/void"
}
]
}
A tabela a seguir apresenta os principais parâmetros que podem ser retornados pelo Gateway de Pagamentos na remoção de um QR Code Pix:
Campo | Tipo | Descrição |
---|---|---|
Status | number | Status da transação. |
ReasonCode | number | Código de retorno. |
ReasonMessage | number | Mensagem de retorno. |
ProviderReturnCode | number | Código de retorno do provedor. |
ProviderReturnMessage | text | Mensagem de retorno do provedor. |