List Bank Participants

curl --request GET \
  --url https://plugin-br-pix-direct-jd.sandbox.lerian.net/v1/banks/participants \
  --header 'Authorization: Bearer <token>'

[
  {
    "bankId": "12345678",
    "name": "Banco Example S.A.",
    "pspType": 1,
    "pspStatus": 1
  }
]

GET

banks

participants

List Bank Participants

curl --request GET \
  --url https://plugin-br-pix-direct-jd.sandbox.lerian.net/v1/banks/participants \
  --header 'Authorization: Bearer <token>'

[
  {
    "bankId": "12345678",
    "name": "Banco Example S.A.",
    "pspType": 1,
    "pspStatus": 1
  }
]

Authorization

string

header

required

JWT Bearer token authentication. Obtain token from /v1/login/oauth/access_token endpoint using client credentials (clientId and clientSecret).

Include token in Authorization header: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Token expires after 3600 seconds (1 hour).

List of participating banks retrieved successfully

bankId

string

required

Bank ISPB code (8 digits).

Example:

"12345678"

name

string

required

Bank name.

Example:

"Banco Example S.A."

pspType

integer

required

Payment Service Provider type. Values: 1 = Direct participant, 2 = Indirect participant

Example:

1

pspStatus

integer

required

Participation status in Pix system. Values: 1 = Active and operational

Example:

1

⌘I