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://api.example.com/v1/recurrences/payer/authorizations \
  --header 'Authorization: Bearer <token>'

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

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Account-Id · string<uuid>

Account ID (UUID format). Optional: absent spans all accounts (cross-account search).

Parámetros de consulta

page · integer<int64> · predeterminado: 1

Page number (default 1, minimum 1)

limit · integer<int64> · predeterminado: 10

Page size (default 10, range 1-100)

status · string[]

Filter by status (comma-separated, OR-matched): AUTHORIZED, CANCELLED, EXPIRED

receiver_document · string

Filter by receiver document (CPF or CNPJ, unmasked)

cancellation_reason_kind · string

Filter by cancellation reason kind: PAYER, FRAUD, EXPIRED, RECEIVER

start_date · string

ISO 8601 UTC lower bound on createdAt

Ejemplo:

"2026-06-09T00:00:00Z"

end_date · string

ISO 8601 UTC upper bound on createdAt

Ejemplo:

"2026-06-09T00:00:00Z"

sort_order · string · predeterminado: desc

Sort order: asc or desc (default desc)

Respuesta

200

application/json

OK

items · object[] · requerido

Show child attributes

limit · integer<int64> · requerido

Ejemplo:

10

page · integer<int64> · requerido

Ejemplo:

1

total · integer<int64> · requerido

Ejemplo:

42