Skip to main content
GET
Recuperar Detalhes da Cobrança Imediata

Autorizações

Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Cabeçalhos

X-Account-Id
string
obrigatório

ID da Conta (formato UUID)

Parâmetros de caminho

collection_id
string
obrigatório

Identificador da cobrança imediata

Resposta

OK

additionalInfo
object

AdditionalInfo contém informações adicionais de chave-valor

Exemplo:
amount
string

Amount é o valor da cobrança em formato decimal

Exemplo:

"100.00"

createdAt
string

CreatedAt é o timestamp de quando a cobrança foi criada

Exemplo:

"2024-01-15T10:30:00Z"

debtorDocument
string

DebtorDocument é o CPF ou CNPJ do pagador

Exemplo:

"12345678901"

debtorName
string

DebtorName é o nome do pagador

Exemplo:

"João da Silva"

description
string

Description é a descrição personalizada da cobrança

Exemplo:

"Payment for order #12345"

emv
string

EMV é o payload do QR code no formato EMV

Exemplo:

"00020126580014br.gov.bcb.pix..."

expirationSeconds
integer

ExpirationSeconds é o tempo em segundos até a expiração

Exemplo:

3600

id
string

ID é o identificador único da cobrança

Exemplo:

"550e8400-e29b-41d4-a716-446655440000"

locationUrl
string

LocationURL é a URL para acessar a localização/QR code da cobrança

Exemplo:

"https://api.example.com/qr/550e8400"

metadata
object

Metadata são os metadados personalizados associados a esta cobrança

receiverKey
string

Chave Pix que receberá o pagamento

Exemplo:

"+5511999999999"

status
string

Status é o status atual da cobrança

Exemplo:

"ACTIVE"

tags
string[]

Tags é um array de tags personalizadas

Exemplo:
txId
string

TxID é o identificador da transação

Exemplo:

"TXN123456789"

updatedAt
string

UpdatedAt é o timestamp da última atualização

Exemplo:

"2024-01-15T10:30:00Z"