Saltar al contenido principal
POST
/
v1
/
collections
/
immediate
Crear un cobro inmediato
curl --request POST \
  --url https://plugin-pix-indirect.api.lerian.net/v1/collections/immediate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-Id: <x-account-id>' \
  --data '
{
  "amount": "100.00",
  "expirationSeconds": 3600,
  "receiverKey": "+5511999999999",
  "txId": "TXabcdefghijklmno123456789",
  "additionalInfo": {
    "customerId": "67890",
    "orderId": "12345"
  },
  "debtorDocument": "12345678901",
  "debtorName": "João da Silva",
  "description": "Payment for order #12345",
  "locationInformation": {
    "categoryCode": "5411",
    "merchantCity": "São Paulo",
    "merchantName": "Loja ABC",
    "postalCode": "01310-100"
  },
  "metadata": {},
  "tags": [
    "ecommerce",
    "subscription"
  ],
  "transactionAmount": "150.00",
  "withdrawalAmount": "50.00"
}
'
{
  "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"
}

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)

Cuerpo

application/json
​
amount
string
requerido

Amount es el monto de la cobranza en formato decimal con 2 decimales

Ejemplo:

"100.00"

​
expirationSeconds
integer
requerido

ExpirationSeconds es el tiempo en segundos hasta que la cobranza expira

Ejemplo:

3600

​
receiverKey
string
requerido

Clave Pix que recibirá el pago

Ejemplo:

"+5511999999999"

​
txId
string
requerido

TxID es el identificador único de transacción para esta cobranza

Ejemplo:

"TXabcdefghijklmno123456789"

​
additionalInfo
object

AdditionalInfo es un mapa de clave-valor para información adicional

Ejemplo:
{ "customerId": "67890", "orderId": "12345" }
​
debtorDocument
string

DebtorDocument es el CPF o CNPJ del pagador (opcional, debe proporcionarse junto con DebtorName)

Ejemplo:

"12345678901"

​
debtorName
string

DebtorName es el nombre del pagador (opcional, debe proporcionarse junto con DebtorDocument)

Ejemplo:

"João da Silva"

​
description
string

Description es un mensaje o descripción personalizada para la cobranza

Ejemplo:

"Payment for order #12345"

​
locationInformation
object

LocationInformation contiene los datos de ubicación del comerciante para la generación del código QR

​
metadata
object

Metadata es un mapa opcional para pares clave-valor personalizados (máx. 50 claves)

​
tags
string[]

Tags es un arreglo de etiquetas personalizadas para categorización

Ejemplo:
["ecommerce", "subscription"]
​
transactionAmount
string

Monto de la compra para Pix Troco (servicio de cambio)

Ejemplo:

"150.00"

​
withdrawalAmount
string

Monto de retiro para Pix Saque o Pix Troco

Ejemplo:

"50.00"

Respuesta

Created

​
additionalInfo
object

AdditionalInfo contiene información adicional de clave-valor

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

​
id
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

​
receiverKey
string

Clave Pix que recibirá el pago

Ejemplo:

"+5511999999999"

​
status
string

Status es el estado actual de la cobranza

Ejemplo:

"ACTIVE"

​
tags
string[]

Tags es un arreglo de etiquetas personalizadas

Ejemplo:
["ecommerce", "subscription"]
​
txId
string

TxID es el identificador de la transacción

Ejemplo:

"TXN123456789"

​
updatedAt
string

UpdatedAt es la marca de tiempo de la última actualización

Ejemplo:

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