Criar uma Cobrança Imediata

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

import requests

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

payload = {
    "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"
}
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: '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'
  })
};

fetch('https://plugin-pix-indirect.api.lerian.net/v1/collections/immediate', 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/immediate",
  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' => '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'
  ]),
  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/immediate"

	payload := strings.NewReader("{\n  \"amount\": \"100.00\",\n  \"expirationSeconds\": 3600,\n  \"receiverKey\": \"+5511999999999\",\n  \"txId\": \"TXabcdefghijklmno123456789\",\n  \"additionalInfo\": {\n    \"customerId\": \"67890\",\n    \"orderId\": \"12345\"\n  },\n  \"debtorDocument\": \"12345678901\",\n  \"debtorName\": \"João da Silva\",\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  \"transactionAmount\": \"150.00\",\n  \"withdrawalAmount\": \"50.00\"\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/immediate")
  .header("X-Account-Id", "<x-account-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": \"100.00\",\n  \"expirationSeconds\": 3600,\n  \"receiverKey\": \"+5511999999999\",\n  \"txId\": \"TXabcdefghijklmno123456789\",\n  \"additionalInfo\": {\n    \"customerId\": \"67890\",\n    \"orderId\": \"12345\"\n  },\n  \"debtorDocument\": \"12345678901\",\n  \"debtorName\": \"João da Silva\",\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  \"transactionAmount\": \"150.00\",\n  \"withdrawalAmount\": \"50.00\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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\": \"100.00\",\n  \"expirationSeconds\": 3600,\n  \"receiverKey\": \"+5511999999999\",\n  \"txId\": \"TXabcdefghijklmno123456789\",\n  \"additionalInfo\": {\n    \"customerId\": \"67890\",\n    \"orderId\": \"12345\"\n  },\n  \"debtorDocument\": \"12345678901\",\n  \"debtorName\": \"João da Silva\",\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  \"transactionAmount\": \"150.00\",\n  \"withdrawalAmount\": \"50.00\"\n}"

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

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

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

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

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

Criar uma Cobrança Imediata

Use este endpoint para criar uma cobrança Pix imediata (cobrança imediata) com um QR Code dinâmico que expira após um período definido.

Notas:

Cada cobrança imediata é única e pode ser paga apenas uma vez
O valor e o tempo de expiração são obrigatórios
O ID da transação (txId) deve ser único entre todas as cobranças
O status muda automaticamente para CONCLUDED quando o pagamento é recebido
A cobrança expira automaticamente após o período de tempo especificado

POST

collections

immediate

Criar uma Cobrança Imediata

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

import requests

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

payload = {
    "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"
}
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: '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'
  })
};

fetch('https://plugin-pix-indirect.api.lerian.net/v1/collections/immediate', 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/immediate",
  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' => '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'
  ]),
  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/immediate"

	payload := strings.NewReader("{\n  \"amount\": \"100.00\",\n  \"expirationSeconds\": 3600,\n  \"receiverKey\": \"+5511999999999\",\n  \"txId\": \"TXabcdefghijklmno123456789\",\n  \"additionalInfo\": {\n    \"customerId\": \"67890\",\n    \"orderId\": \"12345\"\n  },\n  \"debtorDocument\": \"12345678901\",\n  \"debtorName\": \"João da Silva\",\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  \"transactionAmount\": \"150.00\",\n  \"withdrawalAmount\": \"50.00\"\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/immediate")
  .header("X-Account-Id", "<x-account-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": \"100.00\",\n  \"expirationSeconds\": 3600,\n  \"receiverKey\": \"+5511999999999\",\n  \"txId\": \"TXabcdefghijklmno123456789\",\n  \"additionalInfo\": {\n    \"customerId\": \"67890\",\n    \"orderId\": \"12345\"\n  },\n  \"debtorDocument\": \"12345678901\",\n  \"debtorName\": \"João da Silva\",\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  \"transactionAmount\": \"150.00\",\n  \"withdrawalAmount\": \"50.00\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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\": \"100.00\",\n  \"expirationSeconds\": 3600,\n  \"receiverKey\": \"+5511999999999\",\n  \"txId\": \"TXabcdefghijklmno123456789\",\n  \"additionalInfo\": {\n    \"customerId\": \"67890\",\n    \"orderId\": \"12345\"\n  },\n  \"debtorDocument\": \"12345678901\",\n  \"debtorName\": \"João da Silva\",\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  \"transactionAmount\": \"150.00\",\n  \"withdrawalAmount\": \"50.00\"\n}"

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

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

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

string

obrigatório

Amount é o valor da cobrança em formato decimal com 2 casas decimais

Exemplo:

"100.00"

expirationSeconds

integer

obrigatório

ExpirationSeconds é o tempo em segundos até a cobrança expirar

Exemplo:

3600

receiverKey

string

obrigatório

Chave Pix que receberá o pagamento

Exemplo:

"+5511999999999"

txId

string

obrigatório

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

Exemplo:

"TXabcdefghijklmno123456789"

additionalInfo

object

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

Show child attributes

Exemplo:

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

debtorDocument

string

DebtorDocument é o CPF ou CNPJ do pagador (opcional, deve ser informado junto com DebtorName)

Exemplo:

"12345678901"

debtorName

string

DebtorName é o nome do pagador (opcional, deve ser informado junto com DebtorDocument)

Exemplo:

"João da Silva"

description

string

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

Exemplo:

"Payment for order #12345"

locationInformation

object

LocationInformation contém os dados de localização do estabelecimento para a 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 contém informações adicionais de chave-valor

Show child attributes

Exemplo:

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

amount

string

Amount é o valor da cobrança em formato decimal

Exemplo:

"100.00"

createdAt

string

CreatedAt é o timestamp de quando a cobrança foi criada

Exemplo:

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

debtorDocument

string

DebtorDocument é o CPF ou CNPJ do pagador

Exemplo:

"12345678901"

debtorName

string

DebtorName é o nome do pagador

Exemplo:

"João da Silva"

description

string

Description é a descrição personalizada da cobrança

Exemplo:

"Payment for order #12345"

emv

string

EMV é o payload do QR code no formato EMV

Exemplo:

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

expirationSeconds

integer

ExpirationSeconds é o tempo em segundos até a expiração

Exemplo:

3600

string

ID é o identificador único da cobrança

Exemplo:

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

locationUrl

string

LocationURL é a URL para acessar a localização/QR code da cobrança

Exemplo:

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

metadata

object

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

Show child attributes

receiverKey

string

Chave Pix que receberá o pagamento

Exemplo:

"+5511999999999"

status

string

Status é o status atual da cobrança

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 Imediata

Autorizações

Cabeçalhos

Corpo

Resposta