Register a participant

curl --request POST \
  --url http://localhost:9820/api/v1/siloc/participants \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ispb": "<string>",
  "name": "<string>",
  "settlingInstitutionIspb": "<string>"
}
'

import requests

url = "http://localhost:9820/api/v1/siloc/participants"

payload = {
    "ispb": "<string>",
    "name": "<string>",
    "settlingInstitutionIspb": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({ispb: '<string>', name: '<string>', settlingInstitutionIspb: '<string>'})
};

fetch('http://localhost:9820/api/v1/siloc/participants', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "9820",
  CURLOPT_URL => "http://localhost:9820/api/v1/siloc/participants",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'ispb' => '<string>',
    'name' => '<string>',
    'settlingInstitutionIspb' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "http://localhost:9820/api/v1/siloc/participants"

	payload := strings.NewReader("{\n  \"ispb\": \"<string>\",\n  \"name\": \"<string>\",\n  \"settlingInstitutionIspb\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://localhost:9820/api/v1/siloc/participants")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"ispb\": \"<string>\",\n  \"name\": \"<string>\",\n  \"settlingInstitutionIspb\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:9820/api/v1/siloc/participants")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"ispb\": \"<string>\",\n  \"name\": \"<string>\",\n  \"settlingInstitutionIspb\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "createdAt": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ispb": "<string>",
  "name": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "settlingInstitutionIspb": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

POST

api

siloc

participants

curl --request POST \
  --url http://localhost:9820/api/v1/siloc/participants \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ispb": "<string>",
  "name": "<string>",
  "settlingInstitutionIspb": "<string>"
}
'

import requests

url = "http://localhost:9820/api/v1/siloc/participants"

payload = {
    "ispb": "<string>",
    "name": "<string>",
    "settlingInstitutionIspb": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({ispb: '<string>', name: '<string>', settlingInstitutionIspb: '<string>'})
};

fetch('http://localhost:9820/api/v1/siloc/participants', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "9820",
  CURLOPT_URL => "http://localhost:9820/api/v1/siloc/participants",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'ispb' => '<string>',
    'name' => '<string>',
    'settlingInstitutionIspb' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "http://localhost:9820/api/v1/siloc/participants"

	payload := strings.NewReader("{\n  \"ispb\": \"<string>\",\n  \"name\": \"<string>\",\n  \"settlingInstitutionIspb\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://localhost:9820/api/v1/siloc/participants")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"ispb\": \"<string>\",\n  \"name\": \"<string>\",\n  \"settlingInstitutionIspb\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:9820/api/v1/siloc/participants")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"ispb\": \"<string>\",\n  \"name\": \"<string>\",\n  \"settlingInstitutionIspb\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "createdAt": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ispb": "<string>",
  "name": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "settlingInstitutionIspb": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Headers

Idempotency-Key

string

Idempotency key, max 255 characters.

Maximum string length: 255

Body

application/json

ispb

string

required

8-digit BACEN ISPB.

Pattern: ^[0-9]{8}$

Example:

"46026562"

name

string

required

Participant legal name.

Maximum string length: 200

role

enum<string>

required

Participant role.

Available options:

DIRECT,

INDIRECT,

SETTLING_INSTITUTION

settlingInstitutionIspb

string

Required when role is INDIRECT.

Pattern: ^[0-9]{8}$

Response

Created

createdAt

string<date-time>

required

Creation timestamp.

string<uuid>

required

Participant id.

ispb

string

required

8-digit BACEN ISPB.

Pattern: ^[0-9]{8}$

Example:

"46026562"

name

string

required

Participant legal name.

Maximum string length: 200

role

enum<string>

required

Participant role.

Available options:

DIRECT,

INDIRECT,

SETTLING_INSTITUTION

status

enum<string>

required

PAG0101 operational status.

Available options:

1,

2,

3,

6,

7,

8,

9

updatedAt

string<date-time>

required

Last-update timestamp.

settlingInstitutionIspb

string

For an indirect participant, the ISPB of its settling institution.

Pattern: ^[0-9]{8}$

⌘I

Pix — Lerian SPI (native messaging)

Pix — JD (interface, direct)

Pix — BTG (interface, indirect)

TED — Lerian SPB (native messaging)

TED — JD (interface)

Boletos — BTG (interface)

Lerian SILOC (native messaging)

Lerian SLC (native messaging)

Lerian STA (native messaging)

Lerian SISBAJUD (native messaging)

Lerian Consignado (native messaging)

Register a participant

Authorizations

Headers

Body

Response