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": "52998224725",
  "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\": \"52998224725\",\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: '52998224725',
    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": "52998224725",
    "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)

{
  "amount": "100.00",
  "createdAt": "2024-01-15T10:30:00Z",
  "expirationSeconds": 3600,
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "receiverKey": "+5511999999999",
  "status": "ACTIVE",
  "txId": "TXN123456789",
  "updatedAt": "2024-01-15T10:30:00Z",
  "additionalInfo": {
    "customerId": "67890",
    "orderId": "12345"
  },
  "debtorDocument": "52998224725",
  "debtorName": "João da Silva",
  "description": "Payment for order #12345",
  "emv": "00020126580014br.gov.bcb.pix...",
  "locationUrl": "https://api.example.com/qr/550e8400",
  "metadata": {},
  "tags": [
    "ecommerce",
    "subscription"
  ]
}

{
  "message": "<string>",
  "code": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "message": "<string>",
  "code": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "message": "<string>",
  "code": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<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, accountId, txId, amount, status, pactualId, emv, locationUrl, createdAt, updatedAt

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": "52998224725",
  "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\": \"52998224725\",\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: '52998224725',
    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": "52998224725",
    "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)

{
  "amount": "100.00",
  "createdAt": "2024-01-15T10:30:00Z",
  "expirationSeconds": 3600,
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "receiverKey": "+5511999999999",
  "status": "ACTIVE",
  "txId": "TXN123456789",
  "updatedAt": "2024-01-15T10:30:00Z",
  "additionalInfo": {
    "customerId": "67890",
    "orderId": "12345"
  },
  "debtorDocument": "52998224725",
  "debtorName": "João da Silva",
  "description": "Payment for order #12345",
  "emv": "00020126580014br.gov.bcb.pix...",
  "locationUrl": "https://api.example.com/qr/550e8400",
  "metadata": {},
  "tags": [
    "ecommerce",
    "subscription"
  ]
}

{
  "message": "<string>",
  "code": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "message": "<string>",
  "code": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "message": "<string>",
  "code": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Headers

X-Account-Id

string<uuid>

required

Account ID (UUID format)

Path Parameters

collection_id

string

required

Identifier of the immediate collection

Body

application/json

additionalInfo

object

Show child attributes

Example:

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

amount

string

Example:

"150.00"

debtorDocument

string

Example:

"52998224725"

debtorName

string

Example:

"Maria Santos"

description

string

Example:

"Updated payment description"

expirationSeconds

integer<int64>

Example:

7200

metadata

object

Show child attributes

receiverKey

string

Example:

"+5511988888888"

Response

amount

string

required

Example:

"100.00"

createdAt

string<date-time>

required

Example:

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

expirationSeconds

integer<int64>

required

Example:

3600

string

required

Example:

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

receiverKey

string

required

Example:

"+5511999999999"

status

string

required

Example:

"ACTIVE"

txId

string

required

Example:

"TXN123456789"

updatedAt

string<date-time>

required

Example:

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

additionalInfo

object

Show child attributes

Example:

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

debtorDocument

string

Example:

"52998224725"

debtorName

string

Example:

"João da Silva"

description

string

Example:

"Payment for order #12345"

emv

string

Example:

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

locationUrl

string

Example:

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

metadata

object

Show child attributes

DICT API

Claims API

MED · Infractions

MED · Fraud markers

MED · Refund requests

MED · Statistics

Transactions API

QR Codes API

Collections API

Funds Recovery API

Reconciliation API

Pix Automático API

Schedules API

Transaction Reports API

Transaction times

Webhooks API

Error handling

Update an Immediate Charge

Authorizations

Headers

Path Parameters

Body

Response