Recuperar Detalhes da Cobrança Imediata

curl --request GET \ --url https://plugin-pix-indirect.api.lerian.net/v1/collections/immediate/{collection_id} \ --header 'Authorization: Bearer <token>' \ --header 'X-Account-Id: <x-account-id>'

{ "additionalInfo": { "customerId": "67890", "orderId": "12345" }, "amount": "100.00", "createdAt": "2024-01-15T10:30:00Z", "debtorDocument": "12345678901", "debtorName": "João da Silva", "description": "Payment for order #12345", "emv": "00020126580014br.gov.bcb.pix...", "expirationSeconds": 3600, "id": "550e8400-e29b-41d4-a716-446655440000", "locationUrl": "https://api.example.com/qr/550e8400", "metadata": {}, "receiverKey": "+5511999999999", "status": "ACTIVE", "tags": [ "ecommerce", "subscription" ], "txId": "TXN123456789", "updatedAt": "2024-01-15T10:30:00Z" }

curl --request GET \ --url https://plugin-pix-indirect.api.lerian.net/v1/collections/immediate/{collection_id} \ --header 'Authorization: Bearer <token>' \ --header 'X-Account-Id: <x-account-id>'

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

additionalInfo

object

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

Show child attributes

Exemplo:

{ "customerId": "67890", "orderId": "12345" }

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

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

Show child attributes

receiverKey

string

Chave Pix que receberá o pagamento

Exemplo:

"+5511999999999"

status

string

Status é o status atual da cobrança

Exemplo:

"ACTIVE"