Skip to main content
GET
/
v1
/
collections
/
immediate
List Immediate Charges
curl --request GET \
  --url https://plugin-pix-indirect.api.lerian.net/v1/collections/immediate \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Account-Id: <x-account-id>'
{
  "items": [
    {
      "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"
    }
  ],
  "limit": 10,
  "page": 1,
  "total": 150
}

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)

Query Parameters

​
limit
integer

Maximum number of collections per page (1-100)

​
page
integer

Page number for pagination (starting at 1)

​
status
string

Status filter

​
tags
string

Tags filter

Response

OK

​
items
object[]

Items is the array of collection results

​
limit
integer

Limit is the maximum number of results returned

Example:

10

​
page
integer

Page is the current page number

Example:

1

​
total
integer

Total is the total number of collections matching the filters

Example:

150