Actualizar un participante

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

import requests

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

payload = {
    "active": True,
    "bcbCode": "<string>",
    "document": "<string>",
    "ispb": "<string>",
    "metadata": {},
    "name": "<string>",
    "nucleaCode": "<string>",
    "type": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    active: true,
    bcbCode: '<string>',
    document: '<string>',
    ispb: '<string>',
    metadata: {},
    name: '<string>',
    nucleaCode: '<string>',
    type: '<string>'
  })
};

fetch('https://slc.sandbox.lerian.net/v1/participants/{id}', 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/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'active' => true,
    'bcbCode' => '<string>',
    'document' => '<string>',
    'ispb' => '<string>',
    'metadata' => [
        
    ],
    'name' => '<string>',
    'nucleaCode' => '<string>',
    'type' => '<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/{id}"

	payload := strings.NewReader("{\n  \"active\": true,\n  \"bcbCode\": \"<string>\",\n  \"document\": \"<string>\",\n  \"ispb\": \"<string>\",\n  \"metadata\": {},\n  \"name\": \"<string>\",\n  \"nucleaCode\": \"<string>\",\n  \"type\": \"<string>\"\n}")

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

require 'uri'
require 'net/http'

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

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

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

PUT

participants

{id}

Actualizar un participante

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

import requests

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

payload = {
    "active": True,
    "bcbCode": "<string>",
    "document": "<string>",
    "ispb": "<string>",
    "metadata": {},
    "name": "<string>",
    "nucleaCode": "<string>",
    "type": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    active: true,
    bcbCode: '<string>',
    document: '<string>',
    ispb: '<string>',
    metadata: {},
    name: '<string>',
    nucleaCode: '<string>',
    type: '<string>'
  })
};

fetch('https://slc.sandbox.lerian.net/v1/participants/{id}', 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/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'active' => true,
    'bcbCode' => '<string>',
    'document' => '<string>',
    'ispb' => '<string>',
    'metadata' => [
        
    ],
    'name' => '<string>',
    'nucleaCode' => '<string>',
    'type' => '<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/{id}"

	payload := strings.NewReader("{\n  \"active\": true,\n  \"bcbCode\": \"<string>\",\n  \"document\": \"<string>\",\n  \"ispb\": \"<string>\",\n  \"metadata\": {},\n  \"name\": \"<string>\",\n  \"nucleaCode\": \"<string>\",\n  \"type\": \"<string>\"\n}")

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

require 'uri'
require 'net/http'

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

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

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

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

string

requerido

Participant id (UUID).

Ejemplo:

"0190b5a0-0000-7000-8000-0000000000aa"

Cuerpo

application/json

active

boolean | null

Whether the participant is active. Nil leaves it unchanged.

Ejemplo:

true

bcbCode

string

Participant code at the Banco Central. Omitted leaves it unchanged.

Ejemplo:

"0001"

document

string

Participant CNPJ (14 digits, unformatted). Omitted leaves it unchanged.

Ejemplo:

"12345678000199"

ispb

string

Participant ISPB (8-digit identifier). Omitted leaves it unchanged.

Ejemplo:

"29011780"

metadata

object

Free-form tenant metadata; a non-nil map replaces the stored value, nil leaves it unchanged.

Show child attributes

name

string

Participant legal name. Omitted leaves it unchanged.

Ejemplo:

"Acquirer Example S.A."

nucleaCode

string

Participant code assigned by Núclea. Omitted leaves it unchanged.

Ejemplo:

"NU12345"

type

string

Participant role/type in the card-settlement flow. Omitted leaves it unchanged.

Ejemplo:

"ACQUIRER"

Respuesta

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"

bcbCode

string

Participant code at the Banco Central.

Ejemplo:

"0001"

document

string

Participant CNPJ (14 digits, unformatted).

Ejemplo:

"12345678000199"

ispb

string

Participant ISPB (8-digit 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"

⌘I

Pix — Lerian SPI (mensajería nativa)

Pix — JD (interfaz, directo)

Pix — BTG (interfaz, indirecto)

TED — Lerian SPB (mensajería nativa)

TED — JD (interfaz)

Boletos — BTG (interfaz)

Lerian SILOC (mensajería nativa)

Lerian SLC (mensajería nativa)

Lerian STA (mensajería nativa)

Lerian SISBAJUD (mensajería nativa)

Lerian Consignado (mensajería nativa)

Actualizar un participante

Autorizaciones

Parámetros de ruta

Cuerpo

Respuesta