Informar pagamento
Tem como objetivo informar o pagamento do documento realizado pelo fluxo Ezpay Business.
Interface
| Método HTTP | Endpoint |
|---|---|
POST | https://api.ez-pay.app/v1/info_payment |
Parâmetros de entrada
| Header |
|---|
| Bearer token |
| Content-Type: application/json |
| JSON body | |
|---|---|
| Parâmetro | Tipo |
| id_documento | STRING(32) ID do documento (campo identificador do documento retornado nos endpoints de listar documentos) |
| id_transacao | STRING(100) ID da transação financeira do pagamento |
| id_banco | INT Identificação do banco onde foi realizado o pagamento |
| valor_pago | STRING(9) Valor do pagamento |
| metodo_pagamento | STRING(50) Tipo da transação. Exemplo: 'Pix' |
| data_pagamento | STRING(10) Data do pagamento no formato 'AAAA-MM-DD' |
Exemplo
{
"id_documento":"13088528350486916081813501129010699620415606565440732223091",
"id_transacao":"123456789",
"id_banco":"123",
"valor_pago":"150,00",
"metodo_pagamento":"Pix",
"data_pagamento": "2024-03-01"
}
Response
{
"message": "Requisição processada com sucesso",
"trackid": "4d143ff5-d1a9-4676-b978-fe41ed0e0e99"
}
Mensagens
| Código HTTP | Mensagem |
|---|---|
| 201 | Pagamento registrado |
| 204 | Documento inexistente |
| 204 | Pagamento já informado |
| 400 | Parâmetros inválidos |
| 401 | Credential unexpected |
| 406 | Not Acceptable |
| 500 | Erro ao processar a requisição |