Update an Immediate Charge

curl --request PUT \
  --url https://api.example.com/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://api.example.com/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://api.example.com/v1/collections/immediate/{collection_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/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"
  ]
}

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

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

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

{
  "code": "<string>",
  "message": "<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://api.example.com/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://api.example.com/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://api.example.com/v1/collections/immediate/{collection_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/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"
  ]
}

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

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

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

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

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Account-Id

string<uuid>

requerido

Account ID (UUID format)

Parámetros de ruta

collection_id

string

requerido

Identifier of the immediate collection

Cuerpo

application/json

additionalInfo

object

Show child attributes

Ejemplo:

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

amount

string

Ejemplo:

"150.00"

debtorDocument

string

Ejemplo:

"52998224725"

debtorName

string

Ejemplo:

"Maria Santos"

description

string

Ejemplo:

"Updated payment description"

expirationSeconds

integer<int64>

Ejemplo:

7200

metadata

object

Show child attributes

receiverKey

string

Ejemplo:

"+5511988888888"

Respuesta

amount

string

requerido

Ejemplo:

"100.00"

createdAt

string<date-time>

requerido

Ejemplo:

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

expirationSeconds

integer<int64>

requerido

Ejemplo:

3600

string

requerido

Ejemplo:

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

receiverKey

string

requerido

Ejemplo:

"+5511999999999"

status

string

requerido

Ejemplo:

"ACTIVE"

txId

string

requerido

Ejemplo:

"TXN123456789"

updatedAt

string<date-time>

requerido

Ejemplo:

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

additionalInfo

object

Show child attributes

Ejemplo:

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

debtorDocument

string

Ejemplo:

"52998224725"

debtorName

string

Ejemplo:

"João da Silva"

description

string

Ejemplo:

"Payment for order #12345"

emv

string

Ejemplo:

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

locationUrl

string

Ejemplo:

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

metadata

object

Show child attributes

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

Tiempos de transacciones

API de Webhooks

Manejo de errores

Eventos

Update an Immediate Charge

Autorizaciones

Encabezados

Parámetros de ruta

Cuerpo

Respuesta