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": "Acquirer Example S.A.",
  "type": "ACQUIRER",
  "active": true,
  "bcbCode": "0001",
  "document": "12345678000199",
  "ispb": "29011780",
  "metadata": {},
  "nucleaCode": "NU12345",
  "varreduraOptIn": false
}
'

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"name\": \"Acquirer Example S.A.\",\n  \"type\": \"ACQUIRER\",\n  \"active\": true,\n  \"bcbCode\": \"0001\",\n  \"document\": \"12345678000199\",\n  \"ispb\": \"29011780\",\n  \"metadata\": {},\n  \"nucleaCode\": \"NU12345\",\n  \"varreduraOptIn\": false\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))

}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Acquirer Example S.A.',
    type: 'ACQUIRER',
    active: true,
    bcbCode: '0001',
    document: '12345678000199',
    ispb: '29011780',
    metadata: {},
    nucleaCode: 'NU12345',
    varreduraOptIn: false
  })
};

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

import requests

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

payload = {
    "name": "Acquirer Example S.A.",
    "type": "ACQUIRER",
    "active": True,
    "bcbCode": "0001",
    "document": "12345678000199",
    "ispb": "29011780",
    "metadata": {},
    "nucleaCode": "NU12345",
    "varreduraOptIn": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "active": true,
  "connectivityOk": true,
  "createdAt": "2026-06-15T07:50:00Z",
  "id": "018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e",
  "lastConnectivityAt": "2026-06-15T07:50:00Z",
  "name": "Acquirer Example S.A.",
  "type": "ACQUIRER",
  "updatedAt": "2026-06-15T07:50:00Z",
  "varreduraOptIn": false,
  "bcbCode": "0001",
  "document": "12345678000199",
  "ispb": "29011780",
  "metadata": {},
  "nucleaCode": "NU12345"
}

{
  "correlationId": "req-7a3f9c2e",
  "code": "<string>",
  "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",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "code": "<string>",
  "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",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "code": "<string>",
  "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",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "code": "<string>",
  "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",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

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": "Acquirer Example S.A.",
  "type": "ACQUIRER",
  "active": true,
  "bcbCode": "0001",
  "document": "12345678000199",
  "ispb": "29011780",
  "metadata": {},
  "nucleaCode": "NU12345",
  "varreduraOptIn": false
}
'

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"name\": \"Acquirer Example S.A.\",\n  \"type\": \"ACQUIRER\",\n  \"active\": true,\n  \"bcbCode\": \"0001\",\n  \"document\": \"12345678000199\",\n  \"ispb\": \"29011780\",\n  \"metadata\": {},\n  \"nucleaCode\": \"NU12345\",\n  \"varreduraOptIn\": false\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))

}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Acquirer Example S.A.',
    type: 'ACQUIRER',
    active: true,
    bcbCode: '0001',
    document: '12345678000199',
    ispb: '29011780',
    metadata: {},
    nucleaCode: 'NU12345',
    varreduraOptIn: false
  })
};

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

import requests

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

payload = {
    "name": "Acquirer Example S.A.",
    "type": "ACQUIRER",
    "active": True,
    "bcbCode": "0001",
    "document": "12345678000199",
    "ispb": "29011780",
    "metadata": {},
    "nucleaCode": "NU12345",
    "varreduraOptIn": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "active": true,
  "connectivityOk": true,
  "createdAt": "2026-06-15T07:50:00Z",
  "id": "018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e",
  "lastConnectivityAt": "2026-06-15T07:50:00Z",
  "name": "Acquirer Example S.A.",
  "type": "ACQUIRER",
  "updatedAt": "2026-06-15T07:50:00Z",
  "varreduraOptIn": false,
  "bcbCode": "0001",
  "document": "12345678000199",
  "ispb": "29011780",
  "metadata": {},
  "nucleaCode": "NU12345"
}

{
  "correlationId": "req-7a3f9c2e",
  "code": "<string>",
  "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",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "code": "<string>",
  "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",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "code": "<string>",
  "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",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "code": "<string>",
  "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",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Cuerpo

application/json

name

string

requerido

Participant legal name.

Required string length: 1 - 255

Ejemplo:

"Acquirer Example S.A."

type

string

requerido

Participant role/type in the card-settlement flow.

Minimum string length: 1

Ejemplo:

"ACQUIRER"

active

boolean | null

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

Ejemplo:

true

bcbCode

string

Participant code at the Banco Central.

Maximum string length: 10

Ejemplo:

"0001"

document

string

Participant CNPJ: absent, empty, or exactly 14 unformatted positions (digits or letters).

Pattern: ^$|^.{14}$

Ejemplo:

"12345678000199"

ispb

string

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

Ejemplo:

"29011780"

metadata

object

Free-form tenant metadata key/value pairs.

Show child attributes

nucleaCode

string

Participant code assigned by Núclea.

Maximum string length: 20

Ejemplo:

"NU12345"

varreduraOptIn

boolean | null

Whether the participant adhered to the ASLC050/051 varredura (OP108 §13; adesão is optional). Defaults to false when omitted — no sweep file is addressed to a participant that has not adhered.

Ejemplo:

false

Respuesta

Created

active

boolean

requerido

Whether the participant is active.

Ejemplo:

true

connectivityOk

boolean | null

requerido

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

Ejemplo:

true

createdAt

string<date-time>

requerido

Creation timestamp (RFC3339 UTC).

Ejemplo:

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

string

requerido

Participant id (UUID).

Ejemplo:

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

lastConnectivityAt

string<date-time> | null

requerido

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

Ejemplo:

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

name

string

requerido

Participant legal name.

Ejemplo:

"Acquirer Example S.A."

type

string

requerido

Participant role/type in the card-settlement flow.

Ejemplo:

"ACQUIRER"

updatedAt

string<date-time>

requerido

Last-update timestamp (RFC3339 UTC).

Ejemplo:

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

varreduraOptIn

boolean

requerido

Whether the participant adhered to the ASLC050/051 varredura (OP108 §13). False means no sweep file is addressed to it.

Ejemplo:

false

bcbCode

string

Participant code at the Banco Central.

Ejemplo:

"0001"

document

string

Participant CNPJ (exactly 14 unformatted positions; accepts digits or letters).

Ejemplo:

"12345678000199"

ispb

string

Participant ISPB (8-character identifier).

Ejemplo:

"29011780"

metadata

object

Free-form tenant metadata key/value pairs.

Show child attributes

nucleaCode

string

Participant code assigned by Núclea.

Ejemplo:

"NU12345"

Administración

Compensación

Grilla de liquidación

Fondeo

LBTR

Conectividad

Operaciones

Archivos

Participantes

Acuerdos

Informes

Claves de firma

Esquemas XSD

Webhooks

Manejo de errores

Create a participant

Autorizaciones

Cuerpo

Respuesta