Create an Immediate Charge

Use this endpoint to create an immediate Pix collection (cobrança imediata) with a dynamic QR Code that expires after a defined period.

Notes:

• Each immediate collection is unique and can only be paid once
• Amount and expiration time are required
• Transaction ID (txId) must be unique across all collections
• Status automatically transitions to CONCLUDED when payment is received
• Collection expires automatically after the specified time period

POST /v1/collections/immediate

Create an Immediate Charge

cURL

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": "[phone]",
  "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"
}
'

201

{
  "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": "[phone]",
  "status": "ACTIVE",
  "tags": [
    "ecommerce",
    "subscription"
  ],
  "txId": "TXN123456789",
  "updatedAt": "2024-01-15T10:30:00Z"
}

Authorizations

Authorization · string · header · required

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

Headers

X-Account-Id · string · required

Account ID (UUID format)

Body

application/json

amount · string · required

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

Example:

"100.00"

expirationSeconds · integer · required

ExpirationSeconds is the time in seconds until the collection expires

Example:

3600

receiverKey · string · required

Pix key that will receive the payment

Example:

"[phone]"

txId · string · required

TxID is the unique transaction identifier for this collection

Example:

"TXabcdefghijklmno123456789"

additionalInfo · object

AdditionalInfo is a key-value map for additional information

Show child attributes

Example:

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

debtorDocument · string

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

Example:

"12345678901"

debtorName · string

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

Example:

"João da Silva"

description · string

Description is a custom message or description for the collection

Example:

"Payment for order #12345"

locationInformation · object

LocationInformation contains merchant location data for QR code generation

Show child attributes

metadata · object

Metadata is an optional map for custom key-value pairs (max 50 keys)

Show child attributes

tags · string[]

Tags is an array of custom tags for categorization

Example:

["ecommerce", "subscription"]

transactionAmount · string

Purchase amount for Pix Troco (change service)

Example:

"150.00"

withdrawalAmount · string

Withdrawal amount for Pix Saque or Pix Troco

Example:

"50.00"

Response

201

application/json

Created

additionalInfo · object

AdditionalInfo contains additional key-value information

Show child attributes

Example:

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

amount · string

Amount is the collection amount in decimal format

Example:

"100.00"

createdAt · string

CreatedAt is the timestamp when the collection was created

Example:

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

debtorDocument · string

DebtorDocument is the CPF or CNPJ of the payer

Example:

"12345678901"

debtorName · string

DebtorName is the name of the payer

Example:

"João da Silva"

description · string

Description is the custom description of the collection

Example:

"Payment for order #12345"

emv · string

EMV is the QR code payload in EMV format

Example:

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

expirationSeconds · integer

ExpirationSeconds is the time in seconds until expiration

Example:

3600

id · string

ID is the unique identifier of the collection

Example:

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

locationUrl · string

LocationURL is the URL to access the collection location/QR code

Example:

"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

Example:

"[phone]"

status · string

Status is the current status of the collection

Example:

"ACTIVE"

tags · string[]

Tags is an array of custom tags

Example:

["ecommerce", "subscription"]

txId · string

TxID is the transaction identifier

Example:

"TXN123456789"

updatedAt · string

UpdatedAt is the timestamp of the last update

Example:

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