Create a participant

curl --request POST \
  --url https://slc.sandbox.lerian.net/v1/participants \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "type": "<string>",
  "active": true,
  "bcbCode": "<string>",
  "document": "<string>",
  "ispb": "<string>",
  "metadata": {},
  "nucleaCode": "<string>"
}
'

import requests

url = "https://slc.sandbox.lerian.net/v1/participants"

payload = {
    "name": "<string>",
    "type": "<string>",
    "active": True,
    "bcbCode": "<string>",
    "document": "<string>",
    "ispb": "<string>",
    "metadata": {},
    "nucleaCode": "<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({
    name: '<string>',
    type: '<string>',
    active: true,
    bcbCode: '<string>',
    document: '<string>',
    ispb: '<string>',
    metadata: {},
    nucleaCode: '<string>'
  })
};

fetch('https://slc.sandbox.lerian.net/v1/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_URL => "https://slc.sandbox.lerian.net/v1/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([
    'name' => '<string>',
    'type' => '<string>',
    'active' => true,
    'bcbCode' => '<string>',
    'document' => '<string>',
    'ispb' => '<string>',
    'metadata' => [
        
    ],
    'nucleaCode' => '<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 := "https://slc.sandbox.lerian.net/v1/participants"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"type\": \"<string>\",\n  \"active\": true,\n  \"bcbCode\": \"<string>\",\n  \"document\": \"<string>\",\n  \"ispb\": \"<string>\",\n  \"metadata\": {},\n  \"nucleaCode\": \"<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("https://slc.sandbox.lerian.net/v1/participants")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"type\": \"<string>\",\n  \"active\": true,\n  \"bcbCode\": \"<string>\",\n  \"document\": \"<string>\",\n  \"ispb\": \"<string>\",\n  \"metadata\": {},\n  \"nucleaCode\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://slc.sandbox.lerian.net/v1/participants")

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

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

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

{
  "active": true,
  "connectivityOk": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "lastConnectivityAt": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "type": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "bcbCode": "<string>",
  "document": "<string>",
  "ispb": "<string>",
  "metadata": {},
  "nucleaCode": "<string>"
}

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

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

POST

participants

Create a participant

curl --request POST \
  --url https://slc.sandbox.lerian.net/v1/participants \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "type": "<string>",
  "active": true,
  "bcbCode": "<string>",
  "document": "<string>",
  "ispb": "<string>",
  "metadata": {},
  "nucleaCode": "<string>"
}
'

import requests

url = "https://slc.sandbox.lerian.net/v1/participants"

payload = {
    "name": "<string>",
    "type": "<string>",
    "active": True,
    "bcbCode": "<string>",
    "document": "<string>",
    "ispb": "<string>",
    "metadata": {},
    "nucleaCode": "<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({
    name: '<string>',
    type: '<string>',
    active: true,
    bcbCode: '<string>',
    document: '<string>',
    ispb: '<string>',
    metadata: {},
    nucleaCode: '<string>'
  })
};

fetch('https://slc.sandbox.lerian.net/v1/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_URL => "https://slc.sandbox.lerian.net/v1/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([
    'name' => '<string>',
    'type' => '<string>',
    'active' => true,
    'bcbCode' => '<string>',
    'document' => '<string>',
    'ispb' => '<string>',
    'metadata' => [
        
    ],
    'nucleaCode' => '<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 := "https://slc.sandbox.lerian.net/v1/participants"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"type\": \"<string>\",\n  \"active\": true,\n  \"bcbCode\": \"<string>\",\n  \"document\": \"<string>\",\n  \"ispb\": \"<string>\",\n  \"metadata\": {},\n  \"nucleaCode\": \"<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("https://slc.sandbox.lerian.net/v1/participants")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"type\": \"<string>\",\n  \"active\": true,\n  \"bcbCode\": \"<string>\",\n  \"document\": \"<string>\",\n  \"ispb\": \"<string>\",\n  \"metadata\": {},\n  \"nucleaCode\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://slc.sandbox.lerian.net/v1/participants")

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

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

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

{
  "active": true,
  "connectivityOk": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "lastConnectivityAt": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "type": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "bcbCode": "<string>",
  "document": "<string>",
  "ispb": "<string>",
  "metadata": {},
  "nucleaCode": "<string>"
}

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

{
  "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.

Body

application/json

name

string

required

Participant legal name.

Example:

"Acquirer Example S.A."

type

string

required

Participant role/type in the card-settlement flow.

Example:

"ACQUIRER"

active

boolean | null

Whether the participant is active; defaults to true when omitted.

Example:

true

bcbCode

string

Participant code at the Banco Central.

Example:

"0001"

document

string

Participant CNPJ (14 digits, unformatted).

Example:

"12345678000199"

ispb

string

Participant ISPB (8-digit identifier in the Brazilian payment system).

Example:

"29011780"

metadata

object

Free-form tenant metadata key/value pairs.

Show child attributes

nucleaCode

string

Participant code assigned by Núclea.

Example:

"NU12345"

Response

Created

active

boolean

required

Whether the participant is active.

Example:

true

connectivityOk

boolean | null

required

Last connectivity-probe result; null until a probe runs.

Example:

true

createdAt

string<date-time>

required

Creation timestamp (RFC3339 UTC).

Example:

"2026-06-15T07:50:00Z"

string

required

Participant id (UUID).

Example:

"018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e"

lastConnectivityAt

string<date-time> | null

required

Timestamp of the last connectivity probe (RFC3339 UTC); null until a probe runs.

Example:

"2026-06-15T07:50:00Z"

name

string

required

Participant legal name.

Example:

"Acquirer Example S.A."

type

string

required

Participant role/type in the card-settlement flow.

Example:

"ACQUIRER"

updatedAt

string<date-time>

required

Last-update timestamp (RFC3339 UTC).

Example:

"2026-06-15T07:50:00Z"

bcbCode

string

Participant code at the Banco Central.

Example:

"0001"

document

string

Participant CNPJ (14 digits, unformatted).

Example:

"12345678000199"

ispb

string

Participant ISPB (8-digit identifier).

Example:

"29011780"

metadata

object

Free-form tenant metadata key/value pairs.

Show child attributes

nucleaCode

string

Participant code assigned by Núclea.

Example:

"NU12345"

⌘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)

Create a participant

Authorizations

Body

Response