Sign in

v1

latestOpenAPI 3.0.12026-07-26254581767.1 KB
Pagamentos - Cliente

Pagamento - Consultar - PagamentoId

Pré-requisitos:
Um pagamentoId gerado por um dos seguintes fluxos de iniciação de pagamentos:

  • Iniciação de pagamento por chave
  • Iniciação de pagamento por qrcode
  • Iniciação de pagamento manual

Características:

  • Realiza a consulta do estado e dados do pagamento.
  • Pode ser usado no mecanismo de pooling para conciliação.
get/pix/direto/forintegration/v1/pagamentos/{pagamentoId}

Path parameters

pagamentoIdstring uuid required

PagamentoId gerado em qualquer fluxo de iniciação de pagamento.

PagamentoId gerado em qualquer fluxo de iniciação de pagamento.

Response

Consulta realizada com sucesso.

endToEndIdstring nullable

Identificador EndToEnd que tráfega em toda a transação. Equivale a um protocolo transacional, existentes nas duas pontas da transação.

status'INICIADO' | 'CONFIRMADO' | 'EFETIVADO' | 'REJEITADO' | 'ERRO' | 'EXPIRADO'
TipoSignificado
INICIADOPagamento foi iniciado porém ainda não foi confirmado pelo consumidor da api.
CONFIRMADOConfirmação ocorreu com sucesso e a solicitação do pagamento foi enviada para o BACEN.
EFETIVADOPagamento foi realizado com sucesso e o valor foi debitado da conta.
REJEITADOO contraparte do pagamento o rejeitou. Os motivos podem variar desde indisponibilidade no contraparte ou conta do destinatario encerrada/bloqueada.
ERROOcorreu algum erro durante o fluxo de pagamento.
EXPIRADOO tempo entre a iniciação e a confirmação do pagamento excedeu 60 minutos
valornumber double nullable

Valor do Pagamento

numeroContaPagadorstring nullable

Número da conta utilizado na validação de pagamento apenas para conta do pagador