Request registration of an indirect participant

curl --request POST \
  --url https://api.example.com/api/v1/core/participants/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "contactEmail": "med@bancoexemplo.com.br",
  "contactPhone": "+5511999998888",
  "ispb": "12345678",
  "name": "Banco Exemplo S.A.",
  "type": "INDIRECT",
  "cnpj": "12345678000199",
  "sponsorISPB": "87654321"
}
'

package main

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

func main() {

	url := "https://api.example.com/api/v1/core/participants/"

	payload := strings.NewReader("{\n  \"contactEmail\": \"med@bancoexemplo.com.br\",\n  \"contactPhone\": \"+5511999998888\",\n  \"ispb\": \"12345678\",\n  \"name\": \"Banco Exemplo S.A.\",\n  \"type\": \"INDIRECT\",\n  \"cnpj\": \"12345678000199\",\n  \"sponsorISPB\": \"87654321\"\n}")

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

	req.Header.Add("X-Idempotency", "<x-idempotency>")
	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: {
    'X-Idempotency': '<x-idempotency>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    contactEmail: 'med@bancoexemplo.com.br',
    contactPhone: '+5511999998888',
    ispb: '12345678',
    name: 'Banco Exemplo S.A.',
    type: 'INDIRECT',
    cnpj: '12345678000199',
    sponsorISPB: '87654321'
  })
};

fetch('https://api.example.com/api/v1/core/participants/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/api/v1/core/participants/"

payload = {
    "contactEmail": "med@bancoexemplo.com.br",
    "contactPhone": "+5511999998888",
    "ispb": "12345678",
    "name": "Banco Exemplo S.A.",
    "type": "INDIRECT",
    "cnpj": "12345678000199",
    "sponsorISPB": "87654321"
}
headers = {
    "X-Idempotency": "<x-idempotency>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "contactEmail": "med@bancoexemplo.com.br",
  "contactPhone": "+5511999998888",
  "createdAt": "2025-03-07T14:30:00Z",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "ispb": "12345678",
  "name": "Banco Exemplo S.A.",
  "status": "ACTIVE",
  "type": "DIRECT",
  "updatedAt": "2025-03-07T14:30:00Z",
  "config": {
    "quotaDailyLimit": 1000000,
    "quotaTransactionLimit": 50000,
    "routingPolicy": "DEFAULT"
  },
  "sponsorISPB": ""
}

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

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

Request registration of an indirect participant

Opens a reda.014 (PtyCreReq) asking the SPI to record this rail as the indirect participant’s liquidante. The participant is created PENDING and stays there: only the BACEN reda.016 COMP advice makes it ACTIVE, and only an ACTIVE indirect has its arriving Pix settled here. A body naming a DIRECT participant is refused — the rail’s own identity is established on the admin route POST /api/v1/core/participants/direct.

POST

api

core

participants

Request registration of an indirect participant

curl --request POST \
  --url https://api.example.com/api/v1/core/participants/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "contactEmail": "med@bancoexemplo.com.br",
  "contactPhone": "+5511999998888",
  "ispb": "12345678",
  "name": "Banco Exemplo S.A.",
  "type": "INDIRECT",
  "cnpj": "12345678000199",
  "sponsorISPB": "87654321"
}
'

package main

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

func main() {

	url := "https://api.example.com/api/v1/core/participants/"

	payload := strings.NewReader("{\n  \"contactEmail\": \"med@bancoexemplo.com.br\",\n  \"contactPhone\": \"+5511999998888\",\n  \"ispb\": \"12345678\",\n  \"name\": \"Banco Exemplo S.A.\",\n  \"type\": \"INDIRECT\",\n  \"cnpj\": \"12345678000199\",\n  \"sponsorISPB\": \"87654321\"\n}")

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

	req.Header.Add("X-Idempotency", "<x-idempotency>")
	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: {
    'X-Idempotency': '<x-idempotency>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    contactEmail: 'med@bancoexemplo.com.br',
    contactPhone: '+5511999998888',
    ispb: '12345678',
    name: 'Banco Exemplo S.A.',
    type: 'INDIRECT',
    cnpj: '12345678000199',
    sponsorISPB: '87654321'
  })
};

fetch('https://api.example.com/api/v1/core/participants/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/api/v1/core/participants/"

payload = {
    "contactEmail": "med@bancoexemplo.com.br",
    "contactPhone": "+5511999998888",
    "ispb": "12345678",
    "name": "Banco Exemplo S.A.",
    "type": "INDIRECT",
    "cnpj": "12345678000199",
    "sponsorISPB": "87654321"
}
headers = {
    "X-Idempotency": "<x-idempotency>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "contactEmail": "med@bancoexemplo.com.br",
  "contactPhone": "+5511999998888",
  "createdAt": "2025-03-07T14:30:00Z",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "ispb": "12345678",
  "name": "Banco Exemplo S.A.",
  "status": "ACTIVE",
  "type": "DIRECT",
  "updatedAt": "2025-03-07T14:30:00Z",
  "config": {
    "quotaDailyLimit": 1000000,
    "quotaTransactionLimit": 50000,
    "routingPolicy": "DEFAULT"
  },
  "sponsorISPB": ""
}

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

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

Encabezados

X-Idempotency

string

requerido

Idempotency key, max 255 characters

Cuerpo

application/json

contactEmail

string

requerido

Lower-case e-mail BACEN uses to reach this participant about a funds-recovery case (DICT 2.12.1 Email pattern). The address must be lower-case: an upper-case one is refused, never rewritten. The service checks the format, not the published schema, so a refusal never echoes the submitted value back.

Ejemplo:

"med@bancoexemplo.com.br"

contactPhone

string

requerido

E.164 phone BACEN uses to reach this participant about a funds-recovery case (DICT 2.12.1 Phone pattern: +, then 2 to 15 digits). The service checks the format, not the published schema, so a refusal never echoes the submitted value back.

Ejemplo:

"+5511999998888"

ispb

string

requerido

ISPB of the participant, exactly 8 digits or uppercase letters.

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

Ejemplo:

"12345678"

name

string

requerido

Legal name of the participant institution. The 256-character bound is Lerian's own — it is what participants.name stores — not a BACEN limit.

Required string length: 1 - 256

Ejemplo:

"Banco Exemplo S.A."

type

enum<string>

requerido

Connection type; must be INDIRECT. A direct participant is registered on the admin route POST /api/v1/core/participants/direct.

Opciones disponibles:

INDIRECT

Ejemplo:

"INDIRECT"

cnpj

string

14-char CNPJ (alphanumeric per PICnpj [0-9A-Z]{12}[0-9]{2}) of the indirect participant; required for INDIRECT registration (rides the reda.014 MktSpcfcAttr CNPJIDRT).

Required string length: 14

Pattern: ^[0-9A-Z]{12}[0-9]{2}$

Ejemplo:

"12345678000199"

config

object

Quota and routing configuration; supplied only for indirect participants.

Show child attributes

ISPB of the sponsoring participant (8 digits or uppercase letters); required for INDIRECT.

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

Ejemplo:

"87654321"

Respuesta

Created

contactEmail

string

requerido

Registered regulator-facing e-mail; travels on every MED 2.0 funds recovery opened for this participant.

Ejemplo:

"med@bancoexemplo.com.br"

contactPhone

string

requerido

Registered regulator-facing phone; travels on every MED 2.0 funds recovery opened for this participant.

Ejemplo:

"+5511999998888"

createdAt

string

requerido

UTC timestamp when the participant was created, RFC 3339 format.

Ejemplo:

"2025-03-07T14:30:00Z"

string

requerido

Server-assigned UUID of the participant.

Ejemplo:

"550e8400-e29b-41d4-a716-446655440000"

ispb

string

requerido

ISPB of the participant, exactly 8 digits or uppercase letters.

Ejemplo:

"12345678"

name

string

requerido

Legal name of the participant institution.

Ejemplo:

"Banco Exemplo S.A."

status

string

requerido

Lifecycle state of the participant: ACTIVE, SUSPENDED, OFFBOARDED, PENDING (indirect reda.014 in flight), REGISTRATION_REJECTED (reda.016 REJT), or OFFBOARD_PENDING (reda.031 in flight).

Ejemplo:

"ACTIVE"

type

string

requerido

Connection type: DIRECT (connects directly to BACEN) or INDIRECT (routes through a sponsor).

Ejemplo:

"DIRECT"

updatedAt

string

requerido

UTC timestamp of the last update to the participant, RFC 3339 format.

Ejemplo:

"2025-03-07T14:30:00Z"

config

object

Quota and routing configuration; present only for indirect participants.

Show child attributes

ISPB of the sponsoring participant (8 digits or uppercase letters); present only for INDIRECT participants.

Ejemplo:

""