List indirect participants

Lists this tenant’s indirect participants, newest first, as one keyset page. Use it to find the indirectId an outbound order or a park resolution needs, and to see which participants are actually routable — status is the field that decides that: only ACTIVE resolves an inbound credit or may originate an outbound order.

Read-only; nothing changes. The status and ispb filters are exact matches and combine with AND. Pagination is cursor-based, not offset-based: pass the previous page’s nextCursor back as cursor, and a null nextCursor means that page was the last. limit defaults to 25 and is CLAMPED to 100 — a larger value is silently reduced rather than rejected, so do not read the page size you asked for as the page size you got. Every row’s delivery.secret is redacted.

The only refusal is 422 PIX-0098, for a status outside PENDING_PROVISIONING / ACTIVE / SUSPENDED / CLOSED: an unrecognized filter is rejected rather than silently ignored, so a typo cannot widen the result set.

GET /v1/indirects

List indirect participants

cURL

curl --request GET \
  --url https://api.example.com/v1/indirects \
  --header 'Authorization: Bearer <token>'

200

{
  "items": [
    {
      "createdAt": "2023-11-07T05:31:56Z",
      "delivery": {
        "endpointUrl": "https://indirect.example.com/pix",
        "secret": "***"
      },
      "indirectId": "018f2b7c-0000-7000-8000-000000000000",
      "ispb": "12345678",
      "messagingMode": "raw",
      "name": "Indirect PSP Ltda",
      "piAccountAlias": "@pi_12345678",
      "provisioning": {
        "failedStep": "createPIAccount"
      },
      "qrCertificate": {
        "ownCertificate": true,
        "publicBaseUrl": "qr.indirect.example.com/pix"
      },
      "status": "ACTIVE",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "nextCursor": "<string>"
}

Authorizations

Authorization · string · header · required

JWT bearer token issued by the identity provider.

Query Parameters

status · string

Filter by lifecycle status (PENDING_PROVISIONING, ACTIVE, SUSPENDED, CLOSED).

Example:

"ACTIVE"

ispb · string

Filter by exact ISPB (8 digits).

Example:

"12345678"

limit · integer<int64>

Page size (default 25, max 100).

Example:

25

cursor · string

Opaque pagination cursor from a prior page.

Response

200

application/json

OK

items · object[] | null · required

The indirects on this page.

Show child attributes

nextCursor · string

Opaque cursor for the next page, or null when exhausted.