Crear un cobro dinámico con vencimiento

curl --request POST \
  --url https://plugin-pix-indirect.api.lerian.net/v1/collections/duedate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-Id: <x-account-id>' \
  --data '
{
  "amount": {
    "original": "100.00"
  },
  "debtor": {
    "document": "12345678901",
    "name": "João da Silva",
    "address": "Rua das Flores, 123",
    "city": "São Paulo",
    "email": "joao@example.com",
    "state": "SP",
    "zipCode": "01310-100"
  },
  "dueDate": "2024-12-31",
  "receiverKey": "+5511999999999",
  "txId": "TXabcdefghijklmno123456789",
  "validAfterDue": 5,
  "additionalInfo": {
    "customerId": "67890",
    "orderId": "12345"
  },
  "description": "Payment for order #12345",
  "locationInformation": {
    "categoryCode": "5411",
    "merchantCity": "São Paulo",
    "merchantName": "Loja ABC",
    "postalCode": "01310-100"
  },
  "metadata": {},
  "tags": [
    "ecommerce",
    "subscription"
  ]
}
'

{
  "additionalInfo": {
    "customerId": "67890",
    "orderId": "12345"
  },
  "amount": {
    "original": "100.00",
    "abatement": {
      "modality": "PERCENT",
      "value": "3.00"
    },
    "discount": {
      "modality": "AMOUNT_ADVANCE_BUSINESS_DAY",
      "discountDateFixed": [
        {
          "date": "2024-12-25",
          "value": "10.00"
        }
      ],
      "value": "5.00"
    },
    "fine": {
      "modality": "PERCENT",
      "value": "2.00"
    },
    "interest": {
      "modality": "PERCENTAGE_PER_MONTH_CALENDAR_DAYS",
      "value": "1.00"
    }
  },
  "createdAt": "2024-01-15T10:30:00Z",
  "debtor": {
    "address": "Rua das Flores, 123",
    "city": "São Paulo",
    "document": "12345678901",
    "email": "joao@example.com",
    "name": "João da Silva",
    "state": "SP",
    "zipCode": "01310-100"
  },
  "deletedAt": "2024-01-25T10:30:00Z",
  "description": "Payment for order #12345",
  "dueDate": "2024-12-31",
  "emv": "00020126580014br.gov.bcb.pix...",
  "id": "550e8400-e29b-41d4-a716-446655440010",
  "locationUrl": "https://api.example.com/qr/550e8400",
  "metadata": {},
  "receiver": {
    "address": "Rua das Flores, 123",
    "city": "São Paulo",
    "document": "12345678901",
    "name": "João da Silva",
    "state": "SP",
    "tradeName": "Company Name",
    "zipCode": "01310-100"
  },
  "receiverKey": "+5511999999999",
  "review": 0,
  "status": "ACTIVE",
  "tags": [
    "ecommerce",
    "subscription"
  ],
  "txId": "TXabcdefghijklmno123456789",
  "updatedAt": "2024-01-20T14:45:00Z",
  "validAfterDue": 5
}

Crear un cobro dinámico con vencimiento

Usa este endpoint para crear un cobro Pix con vencimiento (cobrança com vencimento) con reglas de pago complejas que incluyen multas, intereses, descuentos y abonos.

Notas:

Similar a los boletos tradicionales con capacidad de pago Pix
La fecha de vencimiento define cuándo se espera el pago
Admite cálculos de monto complejos con multas, intereses, descuentos y abonos
Requiere información completa del pagador y del receptor
El ID de transacción (txId) debe ser único entre todos los cobros
El cobro sigue siendo válido durante un período configurable después de la fecha de vencimiento

POST

collections

duedate

Crear un cobro dinámico con vencimiento

curl --request POST \
  --url https://plugin-pix-indirect.api.lerian.net/v1/collections/duedate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-Id: <x-account-id>' \
  --data '
{
  "amount": {
    "original": "100.00"
  },
  "debtor": {
    "document": "12345678901",
    "name": "João da Silva",
    "address": "Rua das Flores, 123",
    "city": "São Paulo",
    "email": "joao@example.com",
    "state": "SP",
    "zipCode": "01310-100"
  },
  "dueDate": "2024-12-31",
  "receiverKey": "+5511999999999",
  "txId": "TXabcdefghijklmno123456789",
  "validAfterDue": 5,
  "additionalInfo": {
    "customerId": "67890",
    "orderId": "12345"
  },
  "description": "Payment for order #12345",
  "locationInformation": {
    "categoryCode": "5411",
    "merchantCity": "São Paulo",
    "merchantName": "Loja ABC",
    "postalCode": "01310-100"
  },
  "metadata": {},
  "tags": [
    "ecommerce",
    "subscription"
  ]
}
'

{
  "additionalInfo": {
    "customerId": "67890",
    "orderId": "12345"
  },
  "amount": {
    "original": "100.00",
    "abatement": {
      "modality": "PERCENT",
      "value": "3.00"
    },
    "discount": {
      "modality": "AMOUNT_ADVANCE_BUSINESS_DAY",
      "discountDateFixed": [
        {
          "date": "2024-12-25",
          "value": "10.00"
        }
      ],
      "value": "5.00"
    },
    "fine": {
      "modality": "PERCENT",
      "value": "2.00"
    },
    "interest": {
      "modality": "PERCENTAGE_PER_MONTH_CALENDAR_DAYS",
      "value": "1.00"
    }
  },
  "createdAt": "2024-01-15T10:30:00Z",
  "debtor": {
    "address": "Rua das Flores, 123",
    "city": "São Paulo",
    "document": "12345678901",
    "email": "joao@example.com",
    "name": "João da Silva",
    "state": "SP",
    "zipCode": "01310-100"
  },
  "deletedAt": "2024-01-25T10:30:00Z",
  "description": "Payment for order #12345",
  "dueDate": "2024-12-31",
  "emv": "00020126580014br.gov.bcb.pix...",
  "id": "550e8400-e29b-41d4-a716-446655440010",
  "locationUrl": "https://api.example.com/qr/550e8400",
  "metadata": {},
  "receiver": {
    "address": "Rua das Flores, 123",
    "city": "São Paulo",
    "document": "12345678901",
    "name": "João da Silva",
    "state": "SP",
    "tradeName": "Company Name",
    "zipCode": "01310-100"
  },
  "receiverKey": "+5511999999999",
  "review": 0,
  "status": "ACTIVE",
  "tags": [
    "ecommerce",
    "subscription"
  ],
  "txId": "TXabcdefghijklmno123456789",
  "updatedAt": "2024-01-20T14:45:00Z",
  "validAfterDue": 5
}

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

object

requerido

Amount es el objeto de configuración del monto (obligatorio)

Show child attributes

debtor

object

requerido

Debtor es la información del deudor (obligatorio)

Show child attributes

dueDate

string

requerido

DueDate es la fecha de vencimiento de la cobranza en formato YYYY-MM-DD (ISO8601)

Ejemplo:

"2024-12-31"

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"

validAfterDue

integer

requerido

ValidAfterDue es el número de días posteriores a la fecha de vencimiento durante los cuales la cobranza permanece válida

Rango requerido: x >= 0

Ejemplo:

5

additionalInfo

object

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

Show child attributes

Ejemplo:

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

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 comercio para la generación del código QR

Show child attributes

metadata

object

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

Show child attributes

Respuesta

Created

additionalInfo

object

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

Show child attributes

Ejemplo:

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

amount

object

Amount es el objeto de configuración del monto (requerido)

Show child attributes

createdAt

string

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

Ejemplo:

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

debtor

object

Debtor es la información del deudor (requerido)

Show child attributes

deletedAt

string

DeletedAt es la marca de tiempo en que se eliminó la cobranza (opcional, anulable)

Ejemplo:

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

description

string

Description es la descripción personalizada de la cobranza (opcional)

Ejemplo:

"Payment for order #12345"

dueDate

string

DueDate es la fecha de vencimiento de la cobranza en formato YYYY-MM-DD (requerido)

Ejemplo:

"2024-12-31"

emv

string

EMV es el payload del código QR en formato EMV (requerido)

Ejemplo:

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

string

ID es el identificador único de la cobranza (requerido)

Ejemplo:

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

locationUrl

string

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

Ejemplo:

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

metadata

object

Metadata son los metadatos personalizados asociados con esta cobranza

Show child attributes

receiver

object

Receiver es la información del receptor (requerido)

Show child attributes

receiverKey

string

Clave Pix que recibirá el pago

Ejemplo:

"+5511999999999"

review

integer

Review es el número de revisión de la cobranza (requerido)

Ejemplo:

0

status

string

Status es el estado actual de la cobranza (requerido) Valores válidos: ACTIVE, COMPLETED, REMOVED_BY_RECEIVER, REMOVED_BY_PSP

Ejemplo:

"ACTIVE"