Pagamento - Consultar - EndToEndId

get https://example.com/pix/direto/forintegration/v1/pagamentos/endToEndId/{endToEndId}

Pré-requisitos:
Um EndToEndId 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.

Responses

Response body

object

endToEndId

string | null

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

status

string

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

INICIADO CONFIRMADO EFETIVADO REJEITADO ERRO EXPIRADO

qrCode

object

categoria

int32 | null

moeda

int32 | null

pais

string | null

cidade

string | null

txId

string | null

cobranca

object

string | null

Id da cobrança

documento

object

calendario

object

pagador

object

valor

object

chave

object

solicitacao

string | null

infoAdicionais

array of objects | null

infoAdicionais

object

nome

string | null

valor

string | null

recebedor

object

ispb

string | null

Número ISPB do banco

conta

object

pessoa

object

erro

object

erroCodigo

string | null

Código do Erro

erroDescricao

string | null

Descrição do Erro

valor

double | null

Valor do Pagamento

numeroContaPagador

string | null

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

204

Consulta realizada com sucesso, porém sem resultados.

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url https://example.com/pix/direto/forintegration/v1/pagamentos/endToEndId/endToEndId \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Consulta realizada com sucesso.

400Ocorreu um erro ao tentar consultar o pagamento.