List participants

curl --request GET \
  --url https://spi.sandbox.lerian.net/api/v1/core/participants/ \
  --header 'Authorization: Bearer <token>'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://spi.sandbox.lerian.net/api/v1/core/participants/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://spi.sandbox.lerian.net/api/v1/core/participants/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "items": [
    {
      "createdAt": "2025-03-07T14:30:00Z",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "ispb": "12345678",
      "name": "Banco Exemplo S.A.",
      "status": "ACTIVE",
      "type": "DIRECT",
      "updatedAt": "2025-03-07T14:30:00Z",
      "config": {
        "quotaDailyLimit": 1000000,
        "quotaTransactionLimit": 50000,
        "routingPolicy": "DEFAULT"
      },
      "sponsorISPB": ""
    }
  ],
  "limit": 123,
  "offset": 123,
  "correlationId": "<string>"
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

GET

api

core

participants

List participants

curl --request GET \
  --url https://spi.sandbox.lerian.net/api/v1/core/participants/ \
  --header 'Authorization: Bearer <token>'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://spi.sandbox.lerian.net/api/v1/core/participants/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://spi.sandbox.lerian.net/api/v1/core/participants/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "items": [
    {
      "createdAt": "2025-03-07T14:30:00Z",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "ispb": "12345678",
      "name": "Banco Exemplo S.A.",
      "status": "ACTIVE",
      "type": "DIRECT",
      "updatedAt": "2025-03-07T14:30:00Z",
      "config": {
        "quotaDailyLimit": 1000000,
        "quotaTransactionLimit": 50000,
        "routingPolicy": "DEFAULT"
      },
      "sponsorISPB": ""
    }
  ],
  "limit": 123,
  "offset": 123,
  "correlationId": "<string>"
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Parámetros de consulta

Filter by sponsor ISPB (8 numeric digits)

limit

integer<int64>

predeterminado:20

Page size (default 20, max 100)

Rango requerido: 1 <= x <= 100

offset

integer<int64>

predeterminado:0

Page offset (default 0)

Rango requerido: x >= 0

Respuesta

items

object[] | null

requerido

Participants for the requested limit/offset window.

Show child attributes

limit

integer<int64>

requerido

Effective page size applied to this response.

offset

integer<int64>

requerido

Zero-based offset of the first item in this page.

correlationId

string

Request-scoped correlation identifier echoing X-Request-ID, for pivoting from response to trace.