Criar uma Cobrança Dinâmica com Vencimento

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": "Pagamento do pedido #12345",
  "locationInformation": {
    "categoryCode": "5411",
    "merchantCity": "São Paulo",
    "merchantName": "Loja ABC",
    "postalCode": "01310-100"
  },
  "metadata": {},
  "tags": [
    "ecommerce",
    "subscription"
  ]
}
'

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": "Pagamento do pedido #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)

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: 'Pagamento do pedido #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));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://plugin-pix-indirect.api.lerian.net/v1/collections/duedate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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' => 'Pagamento do pedido #12345',
    'locationInformation' => [
        'categoryCode' => '5411',
        'merchantCity' => 'São Paulo',
        'merchantName' => 'Loja ABC',
        'postalCode' => '01310-100'
    ],
    'metadata' => [
        
    ],
    'tags' => [
        'ecommerce',
        'subscription'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-Account-Id: <x-account-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

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\": \"Pagamento do pedido #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))

}

HttpResponse<String> response = Unirest.post("https://plugin-pix-indirect.api.lerian.net/v1/collections/duedate")
  .header("X-Account-Id", "<x-account-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\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\": \"Pagamento do pedido #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}")
  .asString();

require 'uri'
require 'net/http'

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

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Account-Id"] = '<x-account-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\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\": \"Pagamento do pedido #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}"

response = http.request(request)
puts response.read_body

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

Criar uma Cobrança Dinâmica com Vencimento

Use este endpoint para criar uma cobrança Pix com vencimento (cobrança com vencimento) com regras de pagamento complexas incluindo multas, juros, descontos e abatimentos.

Notas:

Similar aos boletos tradicionais com capacidade de pagamento via Pix
O vencimento define quando o pagamento é esperado
Suporta cálculos complexos de valores com multas, juros, descontos e abatimentos
Requer informações completas do devedor e do recebedor
O ID da transação (txId) deve ser único entre todas as cobranças
A cobrança permanece válida por um período configurável após o vencimento

POST

collections

duedate

Criar uma Cobrança Dinâmica com Vencimento

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": "Pagamento do pedido #12345",
  "locationInformation": {
    "categoryCode": "5411",
    "merchantCity": "São Paulo",
    "merchantName": "Loja ABC",
    "postalCode": "01310-100"
  },
  "metadata": {},
  "tags": [
    "ecommerce",
    "subscription"
  ]
}
'

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": "Pagamento do pedido #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)

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: 'Pagamento do pedido #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));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://plugin-pix-indirect.api.lerian.net/v1/collections/duedate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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' => 'Pagamento do pedido #12345',
    'locationInformation' => [
        'categoryCode' => '5411',
        'merchantCity' => 'São Paulo',
        'merchantName' => 'Loja ABC',
        'postalCode' => '01310-100'
    ],
    'metadata' => [
        
    ],
    'tags' => [
        'ecommerce',
        'subscription'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-Account-Id: <x-account-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

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\": \"Pagamento do pedido #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))

}

HttpResponse<String> response = Unirest.post("https://plugin-pix-indirect.api.lerian.net/v1/collections/duedate")
  .header("X-Account-Id", "<x-account-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\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\": \"Pagamento do pedido #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}")
  .asString();

require 'uri'
require 'net/http'

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

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Account-Id"] = '<x-account-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\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\": \"Pagamento do pedido #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}"

response = http.request(request)
puts response.read_body

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

Autorizações

Authorization

string

header

obrigatório

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

Cabeçalhos

X-Account-Id

string

obrigatório

ID da Conta (formato UUID)

Corpo

application/json

amount

object

obrigatório

Amount é o objeto de configuração de valor (obrigatório)

Show child attributes

debtor

object

obrigatório

Debtor é a informação do devedor (obrigatório)

Show child attributes

dueDate

string

obrigatório

DueDate é a data de vencimento da cobrança no formato YYYY-MM-DD (ISO8601)

Exemplo:

"2024-12-31"

receiverKey

string

obrigatório

Chave Pix que receberá o pagamento

Exemplo:

"+5511999999999"

txId

string

obrigatório

TxID é o identificador único de transação para esta cobrança

Exemplo:

"TXabcdefghijklmno123456789"

validAfterDue

integer

obrigatório

ValidAfterDue é o número de dias após a data de vencimento em que a cobrança permanece válida

Intervalo obrigatório: x >= 0

Exemplo:

5

additionalInfo

object

AdditionalInfo é um mapa de chave-valor para informações adicionais

Show child attributes

Exemplo:

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

description

string

Description é uma mensagem ou descrição personalizada para a cobrança

Exemplo:

"Pagamento do pedido #12345"

locationInformation

object

LocationInformation contém os dados de localização do estabelecimento para geração do QR code

Show child attributes

metadata

object

Metadata é um mapa opcional para pares de chave-valor personalizados (máx. 50 chaves)

Show child attributes

Resposta

Created

additionalInfo

object

AdditionalInfo é um mapa de chave-valor para informações adicionais (opcional)

Show child attributes

Exemplo:

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

amount

object

Amount é o objeto de configuração do valor (obrigatório)

Show child attributes

createdAt

string

CreatedAt é o timestamp de quando a cobrança foi criada (obrigatório)

Exemplo:

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

debtor

object

Debtor é a informação do devedor (obrigatório)

Show child attributes

deletedAt

string

DeletedAt é o timestamp de quando a cobrança foi excluída (opcional, anulável)

Exemplo:

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

description

string

Description é a descrição personalizada da cobrança (opcional)

Exemplo:

"Payment for order #12345"

dueDate

string

DueDate é a data de vencimento da cobrança no formato YYYY-MM-DD (obrigatório)

Exemplo:

"2024-12-31"

emv

string

EMV é o payload do QR code no formato EMV (obrigatório)

Exemplo:

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

string

ID é o identificador único da cobrança (obrigatório)

Exemplo:

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

locationUrl

string

LocationURL é a URL para acessar a localização/QR code da cobrança (obrigatório)

Exemplo:

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

metadata

object

Metadata são os metadados personalizados associados a esta cobrança

Show child attributes

receiver

object

Receiver é a informação do recebedor (obrigatório)

Show child attributes

receiverKey

string

Chave Pix que receberá o pagamento

Exemplo:

"+5511999999999"

review

integer

Review é o número da revisão da cobrança (obrigatório)

Exemplo:

0

status

string

Status é o status atual da cobrança (obrigatório) Valores válidos: ACTIVE, COMPLETED, REMOVED_BY_RECEIVER, REMOVED_BY_PSP

Exemplo:

"ACTIVE"

Pix — Lerian SPI (mensageria nativa)

Pix — JD (interface, direto)

Pix — BTG (interface, indireto)

TED — Lerian SPB (mensageria nativa)

TED — JD (interface)

Boletos — BTG (interface)

Lerian SILOC (mensageria nativa)

Lerian SLC (mensageria nativa)

Lerian STA (mensageria nativa)

Lerian SISBAJUD (mensageria nativa)

Lerian Consignado (mensageria nativa)

Criar uma Cobrança Dinâmica com Vencimento

Autorizações

Cabeçalhos

Corpo

Resposta