Update a participant

Updates a participant’s mutable fields. Omitted fields are left unchanged. connectivityOk/lastConnectivityAt cannot be set here. 404 when the participant does not exist.

PUT /v1/participants/{id}

Update a participant

cURL

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

200

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

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

id · 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.

Maximum string length: 10

Ejemplo:

"0001"

document · string

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

Pattern: ^$|^.{14}$

Ejemplo:

"12345678000199"

ispb · string

Participant ISPB (8-character 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.

Maximum string length: 255

Ejemplo:

"Acquirer Example S.A."

nucleaCode · string

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

Maximum string length: 20

Ejemplo:

"NU12345"

type · string

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

Ejemplo:

"ACQUIRER"

varreduraOptIn · boolean | null

Whether the participant adhered to the ASLC050/051 varredura (OP108 §13). Nil leaves it unchanged.

Ejemplo:

true

Respuesta

200

application/json

OK

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"

id · 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"