v1
latestOpenAPI 3.0.12026-07-26254581767.1 KBPagamento - Consultar
Características:
- Somente será possível realizar a consulta dos pagamentos PIX feitos por meio de APIs, mediante seleção do dia a ser consultado e não mais por período.
- O intervalo máximo entre Início e Fim deve ser de 1 dia
Query parameters
Filtra os registros cuja data de criação seja maior ou igual a data de início.
Filtra os registros cuja data de criação seja maior ou igual a data de início.
Filtra os registros cuja data de criação seja menor ou igual a data de fim, desde que não ultrapassem um período maior que 24 horas entre data inicio e data fim.
Filtra os registros cuja data de criação seja menor ou igual a data de fim, desde que não ultrapassem um período maior que 24 horas entre data inicio e data fim.
| Tipo | Significado |
|---|---|
| INICIADO | Pagamento foi iniciado porém ainda não foi confirmado pelo consumidor da api. |
| CONFIRMADO | Confirmação ocorreu com sucesso e a solicitação do pagamento foi enviada para o BACEN. |
| EFETIVADO | Pagamento foi realizado com sucesso e o valor foi debitado da conta. |
| REJEITADO | O contraparte do pagamento o rejeitou. Os motivos podem variar desde indisponibilidade no contraparte ou conta do destinatario encerrada/bloqueada. |
| ERRO | Ocorreu algum erro durante o fluxo de pagamento. |
| EXPIRADO | O tempo entre a iniciação e a confirmação do pagamento excedeu 60 minutos |
Filtra os registros cujo o Status seja igual.
Filtra os registros cujo o Tipo seja igual.
Página a ser retornada pela consulta. Se não for informada, o PSP assumirá que será 0.
Página a ser retornada pela consulta. Se não for informada, o PSP assumirá que será 0.
Quantidade máxima de registros retornados em cada página. Apenas a última página pode conter uma quantidade menor de registros.
Quantidade máxima de registros retornados em cada página. Apenas a última página pode conter uma quantidade menor de registros.
Response
Consulta realizada com sucesso.