Skip to main content
GET
Consultar cobrança com vencimento

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

txid
string
obrigatório

Identificador da transação [a-zA-Z0-9]{26,35}.

Resposta

OK

calendario
object
obrigatório
chave
string
obrigatório

Chave DICT do recebedor.

Maximum string length: 77
devedor
object
obrigatório
loc
object
obrigatório
location
string
obrigatório

Localização do payload.

Maximum string length: 77
pixCopiaECola
string
obrigatório

Pix Copia e Cola (BR Code) correspondente à cobrança.

Maximum string length: 512
recebedor
object
obrigatório
revisao
integer<int64>
obrigatório

Revisão da cobrança (inicia em 0).

status
enum<string>
obrigatório

Status do registro da cobrança.

Opções disponíveis:
ATIVA,
CONCLUIDA,
REMOVIDA_PELO_USUARIO_RECEBEDOR,
REMOVIDA_PELO_PSP
txid
string
obrigatório

Identificador da transação.

Pattern: [a-zA-Z0-9]{26,35}
valor
object
obrigatório
infoAdicionais
object[] | null
pix
object[] | null

Pix recebidos vinculados à cobrança.

solicitacaoPagador
string
Maximum string length: 140