Create an Immediate Charge

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

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

}

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));

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)

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

Create an Immediate Charge

Use this endpoint to create an immediate Pix collection (cobrança imediata) with a dynamic QR Code that expires after a defined period.

Notes:

Each immediate collection is unique and can only be paid once
Amount and expiration time are required
Transaction ID (txId) must be unique across all collections
Status automatically transitions to CONCLUDED when payment is received
Collection expires automatically after the specified time period

POST

collections

immediate

Create an Immediate Charge

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

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

}

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));

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)

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

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

string

requerido

Amount is the collection amount in decimal format with 2 decimal places

Ejemplo:

"100.00"

expirationSeconds

integer

requerido

ExpirationSeconds is the time in seconds until the collection expires

Ejemplo:

3600

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"

additionalInfo

object

AdditionalInfo is a key-value map for additional information

Show child attributes

Ejemplo:

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

debtorDocument

string

DebtorDocument is the CPF or CNPJ of the payer (optional, must be provided with DebtorName)

Ejemplo:

"12345678901"

debtorName

string

DebtorName is the name of the payer (optional, must be provided with DebtorDocument)

Ejemplo:

"João da Silva"

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 contains additional key-value information

Show child attributes

Ejemplo:

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

amount

string

Amount is the collection amount in decimal format

Ejemplo:

"100.00"

createdAt

string

CreatedAt is the timestamp when the collection was created

Ejemplo:

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

debtorDocument

string

DebtorDocument is the CPF or CNPJ of the payer

Ejemplo:

"12345678901"

debtorName

string

DebtorName is the name of the payer

Ejemplo:

"João da Silva"

description

string

Description is the custom description of the collection

Ejemplo:

"Payment for order #12345"

emv

string

EMV is the QR code payload in EMV format

Ejemplo:

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

expirationSeconds

integer

ExpirationSeconds is the time in seconds until expiration

Ejemplo:

3600

string

ID is the unique identifier of the collection

Ejemplo:

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

locationUrl

string

LocationURL is the URL to access the collection location/QR code

Ejemplo:

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

metadata

object

Metadata is the custom metadata associated with this collection

Show child attributes

receiverKey

string

Pix key that will receive the payment

Ejemplo:

"+5511999999999"

status

string

Status is the current status of the collection

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 an Immediate Charge

Autorizaciones

Encabezados

Cuerpo

Respuesta