Pular para o conteúdo principal
POST
/
v1
/
collections
/
immediate
Criar uma Cobrança Imediata
curl --request POST \
  --url https://plugin-pix-indirect.api.lerian.net/v1/collections/immediate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-Id: <x-account-id>' \
  --data '
{
  "amount": "100.00",
  "expirationSeconds": 3600,
  "receiverKey": "+5511999999999",
  "txId": "TXabcdefghijklmno123456789",
  "additionalInfo": {
    "customerId": "67890",
    "orderId": "12345"
  },
  "debtorDocument": "12345678901",
  "debtorName": "João da Silva",
  "description": "Payment for order #12345",
  "locationInformation": {
    "categoryCode": "5411",
    "merchantCity": "São Paulo",
    "merchantName": "Loja ABC",
    "postalCode": "01310-100"
  },
  "metadata": {},
  "tags": [
    "ecommerce",
    "subscription"
  ],
  "transactionAmount": "150.00",
  "withdrawalAmount": "50.00"
}
'
{
  "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)

Corpo

application/json
​
amount
string
obrigatório

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

Exemplo:

"100.00"

​
expirationSeconds
integer
obrigatório

ExpirationSeconds é o tempo em segundos até a cobrança expirar

Exemplo:

3600

​
receiverKey
string
obrigatório

Chave Pix que receberá o pagamento

Exemplo:

"+5511999999999"

​
txId
string
obrigatório

TxID é o identificador único da transação para esta cobrança

Exemplo:

"TXabcdefghijklmno123456789"

​
additionalInfo
object

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

Exemplo:
{ "customerId": "67890", "orderId": "12345" }
​
debtorDocument
string

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

Exemplo:

"12345678901"

​
debtorName
string

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

Exemplo:

"João da Silva"

​
description
string

Description é uma mensagem ou descrição personalizada para a cobrança

Exemplo:

"Payment for order #12345"

​
locationInformation
object

LocationInformation contém os dados de localização do estabelecimento para a geração do QR code

​
metadata
object

Metadata é um mapa opcional para pares de chave-valor personalizados (máx. 50 chaves)

​
tags
string[]

Tags é um array de tags personalizadas para categorização

Exemplo:
["ecommerce", "subscription"]
​
transactionAmount
string

Valor da compra para o Pix Troco

Exemplo:

"150.00"

​
withdrawalAmount
string

Valor do saque para o Pix Saque ou Pix Troco

Exemplo:

"50.00"

Resposta

Created

​
additionalInfo
object

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

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

​
id
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

​
receiverKey
string

Chave Pix que receberá o pagamento

Exemplo:

"+5511999999999"

​
status
string

Status é o status atual da cobrança

Exemplo:

"ACTIVE"

​
tags
string[]

Tags é um array de tags personalizadas

Exemplo:
["ecommerce", "subscription"]
​
txId
string

TxID é o identificador da transação

Exemplo:

"TXN123456789"

​
updatedAt
string

UpdatedAt é o timestamp da última atualização

Exemplo:

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