Create a Dynamic Charge with Due Date

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"
  ]
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://plugin-pix-indirect.api.lerian.net/v1/collections/duedate"

	payload := strings.NewReader("{\n  \"amount\": {\n    \"original\": \"100.00\"\n  },\n  \"debtor\": {\n    \"document\": \"12345678901\",\n    \"name\": \"João da Silva\",\n    \"address\": \"Rua das Flores, 123\",\n    \"city\": \"São Paulo\",\n    \"email\": \"joao@example.com\",\n    \"state\": \"SP\",\n    \"zipCode\": \"01310-100\"\n  },\n  \"dueDate\": \"2024-12-31\",\n  \"receiverKey\": \"+5511999999999\",\n  \"txId\": \"TXabcdefghijklmno123456789\",\n  \"validAfterDue\": 5,\n  \"additionalInfo\": {\n    \"customerId\": \"67890\",\n    \"orderId\": \"12345\"\n  },\n  \"description\": \"Payment for order #12345\",\n  \"locationInformation\": {\n    \"categoryCode\": \"5411\",\n    \"merchantCity\": \"São Paulo\",\n    \"merchantName\": \"Loja ABC\",\n    \"postalCode\": \"01310-100\"\n  },\n  \"metadata\": {},\n  \"tags\": [\n    \"ecommerce\",\n    \"subscription\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Account-Id", "<x-account-id>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {
    'X-Account-Id': '<x-account-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    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']
  })
};

fetch('https://plugin-pix-indirect.api.lerian.net/v1/collections/duedate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://plugin-pix-indirect.api.lerian.net/v1/collections/duedate"

payload = {
    "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"]
}
headers = {
    "X-Account-Id": "<x-account-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

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

{
  "code": "<string>",
  "title": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "title": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "title": "<string>",
  "message": "<string>"
}

Create a Dynamic Charge with Due Date

Use this endpoint to create a due date Pix collection (cobrança com vencimento) with complex payment rules including fines, interest, discounts, and rebates.

Notes:

Similar to traditional boletos with Pix payment capability
Due date defines when payment is expected
Supports complex amount calculations with fines, interest, discounts, and rebates
Requires complete debtor and receiver information
Transaction ID (txId) must be unique across all collections
Collection remains valid for a configurable period after the due date

POST

collections

duedate

Create a Dynamic Charge with Due Date

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"
  ]
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://plugin-pix-indirect.api.lerian.net/v1/collections/duedate"

	payload := strings.NewReader("{\n  \"amount\": {\n    \"original\": \"100.00\"\n  },\n  \"debtor\": {\n    \"document\": \"12345678901\",\n    \"name\": \"João da Silva\",\n    \"address\": \"Rua das Flores, 123\",\n    \"city\": \"São Paulo\",\n    \"email\": \"joao@example.com\",\n    \"state\": \"SP\",\n    \"zipCode\": \"01310-100\"\n  },\n  \"dueDate\": \"2024-12-31\",\n  \"receiverKey\": \"+5511999999999\",\n  \"txId\": \"TXabcdefghijklmno123456789\",\n  \"validAfterDue\": 5,\n  \"additionalInfo\": {\n    \"customerId\": \"67890\",\n    \"orderId\": \"12345\"\n  },\n  \"description\": \"Payment for order #12345\",\n  \"locationInformation\": {\n    \"categoryCode\": \"5411\",\n    \"merchantCity\": \"São Paulo\",\n    \"merchantName\": \"Loja ABC\",\n    \"postalCode\": \"01310-100\"\n  },\n  \"metadata\": {},\n  \"tags\": [\n    \"ecommerce\",\n    \"subscription\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Account-Id", "<x-account-id>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {
    'X-Account-Id': '<x-account-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    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']
  })
};

fetch('https://plugin-pix-indirect.api.lerian.net/v1/collections/duedate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://plugin-pix-indirect.api.lerian.net/v1/collections/duedate"

payload = {
    "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"]
}
headers = {
    "X-Account-Id": "<x-account-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

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

{
  "code": "<string>",
  "title": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "title": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "title": "<string>",
  "message": "<string>"
}

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

Account ID (UUID format)

Cuerpo

application/json

amount

object

requerido

Amount is the amount configuration object (required)

Show child attributes

debtor

object

requerido

Debtor is the debtor information (required)

Show child attributes

dueDate

string

requerido

DueDate is the due date for the collection in format YYYY-MM-DD (ISO8601)

Ejemplo:

"2024-12-31"

receiverKey

string

requerido

Pix key that will receive the payment

Ejemplo:

"+5511999999999"

txId

string

requerido

TxID is the unique transaction identifier for this collection

Ejemplo:

"TXabcdefghijklmno123456789"

validAfterDue

integer

requerido

ValidAfterDue is the number of days after the due date that the collection remains valid

Rango requerido: x >= 0

Ejemplo:

5

additionalInfo

object

AdditionalInfo is a key-value map for additional information

Show child attributes

Ejemplo:

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

description

string

Description is a custom message or description for the collection

Ejemplo:

"Payment for order #12345"

locationInformation

object

LocationInformation contains merchant location data for QR code generation

Show child attributes

metadata

object

Metadata is an optional map for custom key-value pairs (max 50 keys)

Show child attributes

Respuesta

Created

additionalInfo

object

AdditionalInfo is a key-value map for additional information (optional)

Show child attributes

Ejemplo:

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

amount

object

Amount is the amount configuration object (required)

Show child attributes

createdAt

string

CreatedAt is the timestamp when the collection was created (required)

Ejemplo:

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

debtor

object

Debtor is the debtor information (required)

Show child attributes

deletedAt

string

DeletedAt is the timestamp when the collection was deleted (optional, nullable)

Ejemplo:

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

description

string

Description is the custom description of the collection (optional)

Ejemplo:

"Payment for order #12345"

dueDate

string

DueDate is the due date for the collection in format YYYY-MM-DD (required)

Ejemplo:

"2024-12-31"

emv

string

EMV is the QR code payload in EMV format (required)

Ejemplo:

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

string

ID is the unique identifier of the collection (required)

Ejemplo:

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

locationUrl

string

LocationURL is the URL to access the collection location/QR code (required)

Ejemplo:

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

metadata

object

Metadata is the custom metadata associated with this collection

Show child attributes

receiver

object

Receiver is the receiver information (required)

Show child attributes

receiverKey

string

Pix key that will receive the payment

Ejemplo:

"+5511999999999"

review

integer

Review is the revision number of the collection (required)

Ejemplo:

0

status

string

Status is the current status of the collection (required) Valid values: ACTIVE, COMPLETED, REMOVED_BY_RECEIVER, REMOVED_BY_PSP

Ejemplo:

"ACTIVE"

API de DICT

API de Reclamaciones

MED · Infracciones

MED · Marcadores de fraude

MED · Solicitudes de devolución

MED · Estadísticas

API de Transacciones

API de Códigos QR

API de Cobros

API de Recuperación de Fondos

API de Conciliación

API de Pix Automático

API de Programaciones

API de Informes de Transacción

API de Webhooks

Manejo de errores

Create a Dynamic Charge with Due Date

Autorizaciones

Encabezados

Cuerpo

Respuesta