v1
latestOpenAPI 3.0.12026-07-261451591021.8 KBConsulta de dados de pagamentos
Consulta de Pagamento. Este endpoint permite consultar os detalhes de um pagamento específico. <br/> <br/> <br/> Requisição<br/><table><thead><tr><th>Campo</th><th>Tipo</th><th>Descrição</th><th>Obrigatoriedade</th></tr></thead><tbody><tr><td>transaction_id</td><td>Texto</td><td>ID único da transação</td><td>Sim</td></tr><tr><td>client-id</td><td>Texto</td><td>Client ID enviado no header</td><td>Sim</td></tr></tbody></table><br/><br/>Resposta 200<br/><table><thead><tr><th>Campo</th><th>Tipo</th><th>Descrição</th></tr></thead><tbody><tr><td>message</td><td>Texto</td><td>Mensagem sobre a consulta</td></tr><tr><td>Tipo da transação</td><td>Texto</td><td>Tipo da transação</td></tr><tr><td>Status</td><td>Texto</td><td>Status da transação</td></tr><tr><td>Beneficiario</td><td>Texto</td><td>Nome do beneficiário</td></tr><tr><td>Data de criação do pagamento</td><td>Texto</td><td>Data de criação do pagamento</td></tr><tr><td>Valor</td><td>Texto</td><td>Valor do pagamento</td></tr><tr><td>descrição</td><td>Texto|null</td><td>Descrição do pagamento</td></tr><tr><td>errors</td><td>Texto|null</td><td>Erros retornados, se houver</td></tr><tr><td>statusCode</td><td>Inteiro</td><td>Código HTTP da resposta</td></tr><tr><td>status</td><td>Boleano</td><td>Status da operação</td></tr></tbody></table><br/><br/>Resposta 201<br/><table><thead><tr><th>Campo</th><th>Tipo</th><th>Descrição</th></tr></thead><tbody><tr><td>message</td><td>Texto</td><td>Mensagem sobre a consulta</td></tr><tr><td>Tipo da transação</td><td>Texto</td><td>Tipo da transação</td></tr><tr><td>Beneficiario</td><td>Texto</td><td>Nome do beneficiário</td></tr><tr><td>Data de efetivação do pagamento</td><td>Texto</td><td>Data de efetivação do pagamento</td></tr><tr><td>Valor</td><td>Texto</td><td>Valor do pagamento</td></tr><tr><td>descrição</td><td>Texto|null</td><td>Descrição do pagamento</td></tr><tr><td>errors</td><td>Texto|null</td><td>Erros retornados, se houver</td></tr><tr><td>statusCode</td><td>Inteiro</td><td>Código HTTP da resposta</td></tr><tr><td>status</td><td>Boleano</td><td>Status da operação</td></tr></tbody></table>
Query parameters
ID único da transação
Headers
Client ID enviado no header
Response
Pagamento consultado com sucesso