Consultar cobrança imediata.

Endpoint para consultar uma cobrança através de um determinado txid.

Path Params
string
required
[a-zA-Z0-9]{26,35}

Identificador da transação

O campo txid determina o identificador da transação.
O objetivo desse campo é ser um elemento que possibilite ao PSP do recebedor apresentar ao usuário recebedor a funcionalidade de conciliação de pagamentos.
Na pacs.008, é referenciado como TransactionIdentification <txId> ou idConciliacaoRecebedor.
Em termos de fluxo de funcionamento, o txid é lido pelo aplicativo do PSP do pagador e,
depois de confirmado o pagamento, é enviado para o SPI via pacs.008.
Uma pacs.008 também é enviada ao PSP do recebedor, contendo, além de todas as informações usuais
do pagamento, o txid.
Ao perceber um recebimento dotado de txid, o PSP do recebedor está apto a se comunicar com o usuário recebedor,
informando que um pagamento específico foi liquidado.
O txid é criado exclusivamente pelo usuário recebedor e está sob sua responsabilidade.
O txid, no contexto de representação de uma cobrança, é único por CPF/CNPJ do usuário recebedor. Cabe ao
PSP recebedor validar essa regra na API Pix.

Query Params
int32

O campo revisao

Denota a revisão da cobrança. Sempre começa em zero. Sempre varia em acréscimos de 1.
O incremento em uma cobrança deve ocorrer sempre que um objeto da cobrança em questão for alterado.
O campo loc é uma exceção a esta regra.
Se em uma determinada alteração em uma cobrança, o único campo alterado for o campo loc,
então esta operação não incrementa a revisão da cobrança.
O campo loc não ocasiona uma alteração na cobrança em si.
Não é necessário armazenar histórico das alterações do campo loc para uma determinada cobrança.
Para os outros campos da cobrança, registra-se histórico.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json