Atualizar uma Cobrança Imediata

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": "Descrição de pagamento atualizada",
  "expirationSeconds": 7200,
  "metadata": {},
  "receiverKey": "+5511988888888",
  "tags": [
    "updated",
    "revised"
  ]
}
'

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

Atualizar uma Cobrança Imediata

Use este endpoint para atualizar uma cobrança imediata. Apenas cobranças no status ACTIVE podem ser atualizadas.

Campos Mutáveis (podem ser atualizados):

expirationSeconds: Tempo em segundos até a cobrança expirar
receiverKey: Chave PIX que receberá o pagamento
debtorDocument: CPF/CNPJ do pagador (deve ser informado junto com debtorName)
debtorName: Nome do pagador (deve ser informado junto com debtorDocument)
description: Descrição personalizada da cobrança
additionalInfo: Informações adicionais em pares chave-valor
tags: Array de tags personalizadas

Campos Imutáveis (não podem ser atualizados):

id: Identificador único da cobrança
accountId: Identificador da conta
txId: Identificador da transação
amount: Valor original da cobrança
status: Status da cobrança (gerenciado pelo sistema)
pactualId: ID do provedor externo
emv: Payload do QR Code
locationUrl: URL do QR Code
createdAt: Timestamp de criação
updatedAt: Timestamp da última atualização

Restrições de Estado:

As cobranças SÓ podem ser atualizadas quando o status é ACTIVE
Cobranças com status COMPLETED, DELETED ou EXPIRED não podem ser atualizadas

PUT

collections

immediate

{collection_id}

Atualizar uma Cobrança Imediata

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": "Descrição de pagamento atualizada",
  "expirationSeconds": 7200,
  "metadata": {},
  "receiverKey": "+5511988888888",
  "tags": [
    "updated",
    "revised"
  ]
}
'

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

Autorizações

Authorization

string

header

obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Cabeçalhos

X-Account-Id

string

obrigatório

ID da Conta (formato UUID)

Parâmetros de caminho

collection_id

string

obrigatório

Identificador da cobrança imediata

Corpo

application/json

additionalInfo

object

AdditionalInfo é o novo mapa de chave-valor para informações adicionais

Show child attributes

Exemplo:

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

amount

string

Amount é o novo valor da cobrança em formato decimal com 2 casas decimais

Exemplo:

"150.00"

debtorDocument

string

DebtorDocument é o novo CPF ou CNPJ do pagador (deve ser informado junto com DebtorName)

Exemplo:

"98765432109"

debtorName

string

DebtorName é o novo nome do pagador (deve ser informado junto com DebtorDocument)

Exemplo:

"Maria Santos"

description

string

Description é a nova descrição personalizada para a cobrança

Exemplo:

"Descrição de pagamento atualizada"

expirationSeconds

integer

ExpirationSeconds é o novo tempo de expiração em segundos (deve ser maior que 0)

Exemplo:

7200

metadata

object

Metadata é um mapa para atualizar pares de chave-valor personalizados (merge patch RFC 7386)

Show child attributes

receiverKey

string

Nova chave Pix que receberá o pagamento

Minimum string length: 1

Exemplo:

"+5511988888888"

Resposta

Cobrança atualizada com sucesso

additionalInfo

object

AdditionalInfo contém informações adicionais de chave-valor

Show child attributes

Exemplo:

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

amount

string

Amount é o valor da cobrança em formato decimal

Exemplo:

"100.00"

createdAt

string

CreatedAt é o timestamp de quando a cobrança foi criada

Exemplo:

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

debtorDocument

string

DebtorDocument é o CPF ou CNPJ do pagador

Exemplo:

"12345678901"

debtorName

string

DebtorName é o nome do pagador

Exemplo:

"João da Silva"

description

string

Description é a descrição personalizada da cobrança

Exemplo:

"Payment for order #12345"

emv

string

EMV é o payload do QR code no formato EMV

Exemplo:

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

expirationSeconds

integer

ExpirationSeconds é o tempo em segundos até a expiração

Exemplo:

3600

string

ID é o identificador único da cobrança

Exemplo:

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

locationUrl

string

LocationURL é a URL para acessar a localização/QR code da cobrança

Exemplo:

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

metadata

object

Metadata são os metadados personalizados associados a esta cobrança

Show child attributes

receiverKey

string

Chave Pix que receberá o pagamento

Exemplo:

"+5511999999999"

status

string

Status é o status atual da cobrança

Exemplo:

"ACTIVE"