Update an Immediate Charge

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

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

}

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

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)

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

Update an Immediate Charge

Use this endpoint to update an immediate collection. Only collections in ACTIVE status can be updated.

Mutable Fields (can be updated):

expirationSeconds: Time in seconds until collection expires
receiverKey: Pix key that will receive the payment
debtorDocument: CPF/CNPJ of the payer (must be provided with debtorName)
debtorName: Name of the payer (must be provided with debtorDocument)
description: Custom description for the collection
additionalInfo: Additional key-value information
tags: Array of custom tags

Immutable Fields (cannot be updated):

id: Collection unique identifier
accountId: Account identifier
txId: Transaction identifier
amount: Original collection amount
status: Collection status (managed by system)
pactualId: External provider ID
emv: QR code payload
locationUrl: QR code URL
createdAt: Creation timestamp
updatedAt: Last update timestamp

State Restrictions:

Collections can ONLY be updated when status is ACTIVE
Collections with status COMPLETED, DELETED, or EXPIRED cannot be updated

PUT

collections

immediate

{collection_id}

Update an Immediate Charge

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

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

}

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

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)

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

Account ID (UUID format)

Parámetros de ruta

collection_id

string

requerido

Identifier of the immediate collection

Cuerpo

application/json

additionalInfo

object

AdditionalInfo is the new key-value map for additional information

Show child attributes

Ejemplo:

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

amount

string

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

Ejemplo:

"150.00"

debtorDocument

string

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

Ejemplo:

"98765432109"

debtorName

string

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

Ejemplo:

"Maria Santos"

description

string

Description is the new custom description for the collection

Ejemplo:

"Updated payment description"

expirationSeconds

integer

ExpirationSeconds is the new expiration time in seconds (must be greater than 0)

Ejemplo:

7200

metadata

object

Metadata is a map for updating custom key-value pairs (RFC 7386 merge patch)

Show child attributes

receiverKey

string

New Pix key that will receive the payment

Minimum string length: 1

Ejemplo:

"+5511988888888"

Respuesta

Collection updated successfully

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

Update an Immediate Charge

Autorizaciones

Encabezados

Parámetros de ruta

Cuerpo

Respuesta