Skip to main content

Comprovante de Estorno

Utilize este endpoint para consultar o comprovante de estorno de uma transação pelo id.

Ambientes Disponíveis

https://api.gateway.com.br

Endpoint

  • Método: POST
  • Endpoint: /transaction/{id}/refund/receipt
  • Autenticação: Bearer token

Path Params

NomeTipoObrigatórioDescriçãoValidações
idstring (UUID)SimIdentificador da transaçãoDeve ser UUID válido

Exemplo de Requisição

curl --request POST \
--url https://api.gateway.com.br/transaction/553e8400-e29b-41d4-a716-436251480000/refund/receipt \
--header 'Authorization: Bearer seu-token-jwt'

Resposta de Sucesso

CampoTipoObrigatórioDescrição
idstringSimIdentificador da transação
paymentReceiptUrlstringSimURL para download/visualização do comprovante de estorno
expirationDatestring (ISO)NãoData de expiração do comprovante

Exemplo de Resposta

{
"id": "553e8400-e29b-41d4-a716-436251480000",
"paymentReceiptUrl": "https://files.exemplo.com.br/receipts/refund-transaction-553e8400-e29b-41d4-a716-436251480000.pdf",
"expirationDate": "2026-04-01T00:00:00.000Z"
}

Possíveis Erros

CódigoDescriçãoSolução
401Credenciais inválidasVerifique suas credenciais
403Sem permissão/autorizaçãoContate o suporte
404Transação/comprovante de estorno não encontradoVerifique o id informado
422Dados inválidos ou faltandoVerifique o formato dos dados
500Erro internoContate o suporte