Recuperar detalles de un cobro inmediato

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>'

Autorizaciones

Authorization

string

header

requerido

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

Encabezados

X-Account-Id

string

requerido

ID de la cuenta (formato UUID)

Parámetros de ruta

collection_id

string

requerido

Identificador del cobro inmediato

Respuesta

additionalInfo

object

AdditionalInfo contiene información adicional de clave-valor

Show child attributes

Ejemplo:

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

amount

string

Amount es el monto de la cobranza en formato decimal

Ejemplo:

"100.00"

createdAt

string

CreatedAt es la marca de tiempo en que se creó la cobranza

Ejemplo:

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

debtorDocument

string

DebtorDocument es el CPF o CNPJ del pagador

Ejemplo:

"12345678901"

debtorName

string

DebtorName es el nombre del pagador

Ejemplo:

"João da Silva"

description

string

Description es la descripción personalizada de la cobranza

Ejemplo:

"Payment for order #12345"

emv

string

EMV es el payload del código QR en formato EMV

Ejemplo:

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

expirationSeconds

integer

ExpirationSeconds es el tiempo en segundos hasta la expiración

Ejemplo:

3600

string

ID es el identificador único de la cobranza

Ejemplo:

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

locationUrl

string

LocationURL es la URL para acceder a la ubicación/código QR de la cobranza

Ejemplo:

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

metadata

object

Metadata son los metadatos personalizados asociados con esta cobranza

Show child attributes

receiverKey

string

Clave Pix que recibirá el pago

Ejemplo:

"+5511999999999"

status

string

Status es el estado actual de la cobranza

Ejemplo:

"ACTIVE"