Actualizar un cobro dinámico con vencimiento

curl --request PATCH \
  --url https://plugin-pix-indirect.api.lerian.net/v1/collections/duedate/{collection_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-Id: <x-account-id>' \
  --data '
{
  "additionalInfo": {
    "customerId": "67890",
    "orderId": "12345"
  },
  "description": "Payment for order #12345",
  "dueDate": "2024-12-31",
  "metadata": {},
  "receiverKey": "+5511999999999",
  "tags": [
    "ecommerce",
    "subscription"
  ],
  "validAfterDue": 5
}
'

{
  "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
}

PATCH

collections

duedate

{collection_id}

Actualizar un cobro dinámico con vencimiento

curl --request PATCH \
  --url https://plugin-pix-indirect.api.lerian.net/v1/collections/duedate/{collection_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-Id: <x-account-id>' \
  --data '
{
  "additionalInfo": {
    "customerId": "67890",
    "orderId": "12345"
  },
  "description": "Payment for order #12345",
  "dueDate": "2024-12-31",
  "metadata": {},
  "receiverKey": "+5511999999999",
  "tags": [
    "ecommerce",
    "subscription"
  ],
  "validAfterDue": 5
}
'

{
  "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)

Parámetros de ruta

collection_id

string

requerido

Identificador del cobro con vencimiento

Cuerpo

application/json

additionalInfo

object

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

Show child attributes

Ejemplo:

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

amount

object

Amount es el objeto de configuración del monto (para actualizaciones de multa/interés/descuento/abono)

Show child attributes

debtor

object

Debtor es la información del deudor (nombre y documento requeridos si se proporciona)

Show child attributes

description

string

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

Ejemplo:

"Payment for order #12345"

dueDate

string

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

Ejemplo:

"2024-12-31"

metadata

object

Metadata es un mapa para actualizar pares clave-valor personalizados (merge patch RFC 7386)

Show child attributes

receiverKey

string

Clave Pix que recibirá el pago

Ejemplo:

"+5511999999999"

Respuesta

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"