Get participant

curl --request GET \
  --url https://api.example.com/api/v1/core/participants/{ispb} \
  --header 'Authorization: Bearer <token>'

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

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

GET

api

core

participants

{ispb}

Get participant

curl --request GET \
  --url https://api.example.com/api/v1/core/participants/{ispb} \
  --header 'Authorization: Bearer <token>'

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

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

Autorizações

Authorization

string

header

obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

ispb

string

obrigatório

ISPB (8 digits or uppercase letters)

Exemplo:

"12345678"

Resposta

contactEmail

string

obrigatório

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

Exemplo:

"med@bancoexemplo.com.br"

contactPhone

string

obrigatório

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

Exemplo:

"+5511999998888"

createdAt

string

obrigatório

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

Exemplo:

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

string

obrigatório

Server-assigned UUID of the participant.

Exemplo:

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

ispb

string

obrigatório

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

Exemplo:

"12345678"

name

string

obrigatório

Legal name of the participant institution.

Exemplo:

"Banco Exemplo S.A."

status

string

obrigatório

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

Exemplo:

"ACTIVE"

type

string

obrigatório

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

Exemplo:

"DIRECT"

updatedAt

string

obrigatório

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

Exemplo:

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

Exemplo:

""