API Reference
Log In

Busca dados de uma cobrança Pix

Este endpoint tem como objetivo buscar dados de cobrança Pix

Respostas das requisições​

Para esta consulta será retornada uma lista dos seguintes dados:

VariávelTipoDescrição
statusStringStatus da cobrança
txIdStringIdentificador da cobrança
urlQrCodeStringURL de acesso para código QR do Pix
valueStringValor da cobrança
paymentDateTimeStringData/hora do pagamento da cobrança
establishmentEstablishmentDados do estabelecimento vinculado

Establishment

VariávelTipoDescrição
tradeNameStringNome fantasia do estabelecimento
aliasNameStringTipo do estabelecimento. Matriz ou Filial
corporateNameStringRazão Social do estabelecimento
legalDocumentStringCPF/CNPJ do estabelecimento
constitutionDateStringData da constituição do estabelecimento. "YYYY-MM-DD"

Status

O status da cobrança pode vir da seguinte forma:

StatusDescrição
PENDINGPagamento pendente
PAIDPagamento realizado
CANCELEDCobrança cancelada
IN_PROCESSTransação em processo
DEVOLVEDDinheiro estornado
Language
Click Try It! to start a request and see the response here!