List Pix Automático Authorizations

List active authorizations belonging to the authenticated payer with optional filters and page/limit pagination. Includes computed nextChargeAt / nextChargeAmount.

GET /v1/recurrences/payer/authorizations

List Pix Automático Authorizations

cURL

curl --request GET \
  --url https://plugin-pix-indirect.api.lerian.net/v1/recurrences/payer/authorizations \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Account-Id: <x-account-id>'

200

{
  "items": [
    {
      "accountId": "019cf6ef-e418-7ced-80c0-7b9816faa798",
      "amount": {
        "fixed": "29.90",
        "max": "500.00",
        "min": "10.00"
      },
      "approvedAt": "2023-11-07T05:31:56Z",
      "authorizationRequestId": "019cf6ef-e418-7ced-80c0-7b9816faa798",
      "cancelReason": "PAYER",
      "cancellationReason": "Customer reported unauthorized charge",
      "cancellationReasonKind": "FRAUD",
      "cancelledAt": "2023-11-07T05:31:56Z",
      "cancelledByOperatorId": "op-9",
      "createdAt": "2023-11-07T05:31:56Z",
      "destination": {
        "account": "123456",
        "accountType": "CACC",
        "bank": "30306294",
        "branch": "0001",
        "document": "12345678000199",
        "key": "[e-mail]",
        "name": "Streaming Co",
        "personType": "LEGAL_PERSON"
      },
      "expiredAt": "2023-11-07T05:31:56Z",
      "externalAuthorizationId": "AUT-2026-04-001",
      "id": "019cf6ef-e418-7ced-80c0-7b9816faa798",
      "nextChargeAmount": "29.90",
      "nextChargeAt": "2023-11-07T05:31:56Z",
      "periodicity": {
        "customDays": 30,
        "type": "MONTHLY"
      },
      "receiverMaxAmount": "500.00",
      "retryPolicy": "RETRY_3X_7D",
      "status": "AUTHORIZED",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "limit": 10,
  "page": 1,
  "total": 42
}

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

Unique identifier of the Midaz Ledger Account (UUID format).

Query Parameters

limit · integer · default: 10

Maximum number of items per page.

Required range: 1 <= x <= 100

page · integer · default: 1

Page number for pagination.

Required range: x >= 1

status · enum<string>

Filter by status

Available options: AUTHORIZED, CANCELLED, EXPIRED

receiver_document · string

Filter by receiver document (CPF or CNPJ, unmasked)

sort_order · enum<string> · default: asc

Sort direction: asc or desc.

Available options: asc, desc

Response

200

application/json

OK

items · object[]

Show child attributes

limit · integer

Example:

10

page · integer

Example:

1

total · integer

Example:

42