Actualizar un cobro inmediato

curl --request PUT \
  --url https://plugin-pix-indirect.api.lerian.net/v1/collections/immediate/{collection_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-Id: <x-account-id>' \
  --data '
{
  "additionalInfo": {
    "status": "updated",
    "version": "2"
  },
  "amount": "150.00",
  "debtorDocument": "98765432109",
  "debtorName": "Maria Santos",
  "description": "Updated payment description",
  "expirationSeconds": 7200,
  "metadata": {},
  "receiverKey": "+5511988888888",
  "tags": [
    "updated",
    "revised"
  ]
}
'

import requests

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

payload = {
    "additionalInfo": {
        "status": "updated",
        "version": "2"
    },
    "amount": "150.00",
    "debtorDocument": "98765432109",
    "debtorName": "Maria Santos",
    "description": "Updated payment description",
    "expirationSeconds": 7200,
    "metadata": {},
    "receiverKey": "+5511988888888",
    "tags": ["updated", "revised"]
}
headers = {
    "X-Account-Id": "<x-account-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    'X-Account-Id': '<x-account-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    additionalInfo: {status: 'updated', version: '2'},
    amount: '150.00',
    debtorDocument: '98765432109',
    debtorName: 'Maria Santos',
    description: 'Updated payment description',
    expirationSeconds: 7200,
    metadata: {},
    receiverKey: '+5511988888888',
    tags: ['updated', 'revised']
  })
};

fetch('https://plugin-pix-indirect.api.lerian.net/v1/collections/immediate/{collection_id}', 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/{collection_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'additionalInfo' => [
        'status' => 'updated',
        'version' => '2'
    ],
    'amount' => '150.00',
    'debtorDocument' => '98765432109',
    'debtorName' => 'Maria Santos',
    'description' => 'Updated payment description',
    'expirationSeconds' => 7200,
    'metadata' => [
        
    ],
    'receiverKey' => '+5511988888888',
    'tags' => [
        'updated',
        'revised'
    ]
  ]),
  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/{collection_id}"

	payload := strings.NewReader("{\n  \"additionalInfo\": {\n    \"status\": \"updated\",\n    \"version\": \"2\"\n  },\n  \"amount\": \"150.00\",\n  \"debtorDocument\": \"98765432109\",\n  \"debtorName\": \"Maria Santos\",\n  \"description\": \"Updated payment description\",\n  \"expirationSeconds\": 7200,\n  \"metadata\": {},\n  \"receiverKey\": \"+5511988888888\",\n  \"tags\": [\n    \"updated\",\n    \"revised\"\n  ]\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://plugin-pix-indirect.api.lerian.net/v1/collections/immediate/{collection_id}")
  .header("X-Account-Id", "<x-account-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"additionalInfo\": {\n    \"status\": \"updated\",\n    \"version\": \"2\"\n  },\n  \"amount\": \"150.00\",\n  \"debtorDocument\": \"98765432109\",\n  \"debtorName\": \"Maria Santos\",\n  \"description\": \"Updated payment description\",\n  \"expirationSeconds\": 7200,\n  \"metadata\": {},\n  \"receiverKey\": \"+5511988888888\",\n  \"tags\": [\n    \"updated\",\n    \"revised\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Put.new(url)
request["X-Account-Id"] = '<x-account-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"additionalInfo\": {\n    \"status\": \"updated\",\n    \"version\": \"2\"\n  },\n  \"amount\": \"150.00\",\n  \"debtorDocument\": \"98765432109\",\n  \"debtorName\": \"Maria Santos\",\n  \"description\": \"Updated payment description\",\n  \"expirationSeconds\": 7200,\n  \"metadata\": {},\n  \"receiverKey\": \"+5511988888888\",\n  \"tags\": [\n    \"updated\",\n    \"revised\"\n  ]\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>"
}

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

Actualizar un cobro inmediato

Usa este endpoint para actualizar un cobro inmediato. Solo se pueden actualizar los cobros en estado ACTIVE.

Campos mutables (se pueden actualizar):

expirationSeconds: Tiempo en segundos hasta que expira el cobro
receiverKey: Clave PIX que recibirá el pago
debtorDocument: CPF/CNPJ del pagador (debe proporcionarse junto con debtorName)
debtorName: Nombre del pagador (debe proporcionarse junto con debtorDocument)
description: Descripción personalizada del cobro
additionalInfo: Información adicional en pares clave-valor
tags: Arreglo de etiquetas personalizadas

Campos inmutables (no se pueden actualizar):

id: Identificador único del cobro
accountId: Identificador de la cuenta
txId: Identificador de la transacción
amount: Monto original del cobro
status: Estado del cobro (gestionado por el sistema)
pactualId: ID del proveedor externo
emv: Payload del código QR
locationUrl: URL del código QR
createdAt: Marca de tiempo de creación
updatedAt: Marca de tiempo de la última actualización

Restricciones de estado:

Los cobros SOLO se pueden actualizar cuando el estado es ACTIVE
Los cobros con estado COMPLETED, DELETED o EXPIRED no se pueden actualizar

PUT

collections

immediate

{collection_id}

Actualizar un cobro inmediato

curl --request PUT \
  --url https://plugin-pix-indirect.api.lerian.net/v1/collections/immediate/{collection_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-Id: <x-account-id>' \
  --data '
{
  "additionalInfo": {
    "status": "updated",
    "version": "2"
  },
  "amount": "150.00",
  "debtorDocument": "98765432109",
  "debtorName": "Maria Santos",
  "description": "Updated payment description",
  "expirationSeconds": 7200,
  "metadata": {},
  "receiverKey": "+5511988888888",
  "tags": [
    "updated",
    "revised"
  ]
}
'

import requests

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

payload = {
    "additionalInfo": {
        "status": "updated",
        "version": "2"
    },
    "amount": "150.00",
    "debtorDocument": "98765432109",
    "debtorName": "Maria Santos",
    "description": "Updated payment description",
    "expirationSeconds": 7200,
    "metadata": {},
    "receiverKey": "+5511988888888",
    "tags": ["updated", "revised"]
}
headers = {
    "X-Account-Id": "<x-account-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    'X-Account-Id': '<x-account-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    additionalInfo: {status: 'updated', version: '2'},
    amount: '150.00',
    debtorDocument: '98765432109',
    debtorName: 'Maria Santos',
    description: 'Updated payment description',
    expirationSeconds: 7200,
    metadata: {},
    receiverKey: '+5511988888888',
    tags: ['updated', 'revised']
  })
};

fetch('https://plugin-pix-indirect.api.lerian.net/v1/collections/immediate/{collection_id}', 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/{collection_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'additionalInfo' => [
        'status' => 'updated',
        'version' => '2'
    ],
    'amount' => '150.00',
    'debtorDocument' => '98765432109',
    'debtorName' => 'Maria Santos',
    'description' => 'Updated payment description',
    'expirationSeconds' => 7200,
    'metadata' => [
        
    ],
    'receiverKey' => '+5511988888888',
    'tags' => [
        'updated',
        'revised'
    ]
  ]),
  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/{collection_id}"

	payload := strings.NewReader("{\n  \"additionalInfo\": {\n    \"status\": \"updated\",\n    \"version\": \"2\"\n  },\n  \"amount\": \"150.00\",\n  \"debtorDocument\": \"98765432109\",\n  \"debtorName\": \"Maria Santos\",\n  \"description\": \"Updated payment description\",\n  \"expirationSeconds\": 7200,\n  \"metadata\": {},\n  \"receiverKey\": \"+5511988888888\",\n  \"tags\": [\n    \"updated\",\n    \"revised\"\n  ]\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://plugin-pix-indirect.api.lerian.net/v1/collections/immediate/{collection_id}")
  .header("X-Account-Id", "<x-account-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"additionalInfo\": {\n    \"status\": \"updated\",\n    \"version\": \"2\"\n  },\n  \"amount\": \"150.00\",\n  \"debtorDocument\": \"98765432109\",\n  \"debtorName\": \"Maria Santos\",\n  \"description\": \"Updated payment description\",\n  \"expirationSeconds\": 7200,\n  \"metadata\": {},\n  \"receiverKey\": \"+5511988888888\",\n  \"tags\": [\n    \"updated\",\n    \"revised\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Put.new(url)
request["X-Account-Id"] = '<x-account-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"additionalInfo\": {\n    \"status\": \"updated\",\n    \"version\": \"2\"\n  },\n  \"amount\": \"150.00\",\n  \"debtorDocument\": \"98765432109\",\n  \"debtorName\": \"Maria Santos\",\n  \"description\": \"Updated payment description\",\n  \"expirationSeconds\": 7200,\n  \"metadata\": {},\n  \"receiverKey\": \"+5511988888888\",\n  \"tags\": [\n    \"updated\",\n    \"revised\"\n  ]\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>"
}

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

ID de la cuenta (formato UUID)

Parámetros de ruta

collection_id

string

requerido

Identificador del cobro inmediato

Cuerpo

application/json

additionalInfo

object

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

Show child attributes

Ejemplo:

{ "status": "updated", "version": "2" }

amount

string

Amount es el nuevo monto de la cobranza en formato decimal con 2 decimales

Ejemplo:

"150.00"

debtorDocument

string

DebtorDocument es el nuevo CPF o CNPJ del pagador (debe proporcionarse junto con DebtorName)

Ejemplo:

"98765432109"

debtorName

string

DebtorName es el nuevo nombre del pagador (debe proporcionarse junto con DebtorDocument)

Ejemplo:

"Maria Santos"

description

string

Description es la nueva descripción personalizada para la cobranza

Ejemplo:

"Updated payment description"

expirationSeconds

integer

ExpirationSeconds es el nuevo tiempo de expiración en segundos (debe ser mayor que 0)

Ejemplo:

7200

metadata

object

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

Show child attributes

receiverKey

string

Nueva clave Pix que recibirá el pago

Minimum string length: 1

Ejemplo:

"+5511988888888"

Respuesta

Cobro actualizado correctamente

additionalInfo

object

AdditionalInfo contiene información adicional de clave-valor

Show child attributes

Ejemplo:

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

amount

string

Amount es el monto de la cobranza en formato decimal

Ejemplo:

"100.00"

createdAt

string

CreatedAt es la marca de tiempo en que se creó la cobranza

Ejemplo:

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

debtorDocument

string

DebtorDocument es el CPF o CNPJ del pagador

Ejemplo:

"12345678901"

debtorName

string

DebtorName es el nombre del pagador

Ejemplo:

"João da Silva"

description

string

Description es la descripción personalizada de la cobranza

Ejemplo:

"Payment for order #12345"

emv

string

EMV es el payload del código QR en formato EMV

Ejemplo:

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

expirationSeconds

integer

ExpirationSeconds es el tiempo en segundos hasta la expiración

Ejemplo:

3600

string

ID es el identificador único de la cobranza

Ejemplo:

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

locationUrl

string

LocationURL es la URL para acceder a la ubicación/código QR de la cobranza

Ejemplo:

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

metadata

object

Metadata son los metadatos personalizados asociados con esta cobranza

Show child attributes

receiverKey

string

Clave Pix que recibirá el pago

Ejemplo:

"+5511999999999"

status

string

Status es el estado actual de la cobranza

Ejemplo:

"ACTIVE"

Pix — Lerian SPI (mensajería nativa)

Pix — JD (interfaz, directo)

Pix — BTG (interfaz, indirecto)

TED — Lerian SPB (mensajería nativa)

TED — JD (interfaz)

Boletos — BTG (interfaz)

Lerian SILOC (mensajería nativa)

Lerian SLC (mensajería nativa)

Lerian STA (mensajería nativa)

Lerian SISBAJUD (mensajería nativa)

Lerian Consignado (mensajería nativa)

Actualizar un cobro inmediato

Autorizaciones

Encabezados

Parámetros de ruta

Cuerpo

Respuesta