Switch the institution's result channel (Mensageria or DIRECT)

curl --request PUT \
  --url https://api.example.com/v1/institutions/{institutionId}/channel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "channel": "DIRECT"
}
'

package main

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

func main() {

	url := "https://api.example.com/v1/institutions/{institutionId}/channel"

	payload := strings.NewReader("{\n  \"channel\": \"DIRECT\"\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))

}

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({channel: 'DIRECT'})
};

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

import requests

url = "https://api.example.com/v1/institutions/{institutionId}/channel"

payload = { "channel": "DIRECT" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "changed": true,
  "changedAt": "2023-11-07T05:31:56Z",
  "changedBy": "<string>",
  "channel": "<string>",
  "institutionId": "<string>",
  "previousChannel": "<string>"
}

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

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "details": {}
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "details": {}
}

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

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

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "details": {}
}

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

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "details": {}
}

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

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

Switch the institution's result channel (Mensageria or DIRECT)

Switches the channel an institution’s results take back to Sisbajud. A human platform-administrator action (institution_channel:write, never held by M2M): an application token or a tenant-carrying token is refused with 403. Every attempt, accepted or refused with 403/409/422, is recorded append-only in the audit trail. 422: DIRECT in a multi-tenant deployment, DIRECT with PLUGIN_AUTH_ENABLED=false, or DIRECT while the stored institution_code is not the 8-character CNPJ root of the RESPONSIBLE GROUPING (CNPJ_INSTITUICAO_RESPONSAVEL), ^[A-Z0-9]$ exactly as stored, never the executing institution’s CNPJ. 409: the institution has any open order (in either direction); 409 SBJ-0060: the institution’s execution owner is not this executor’s M2M subject (another executor’s institution, also when the current channel is requested): set the owner before switching. 404: unknown institution. 400: channel is not DIRECT or MENSAGERIA. Requesting the current channel answers 200 with changed=false.

PUT

institutions

{institutionId}

channel

Switch the institution's result channel (Mensageria or DIRECT)

curl --request PUT \
  --url https://api.example.com/v1/institutions/{institutionId}/channel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "channel": "DIRECT"
}
'

package main

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

func main() {

	url := "https://api.example.com/v1/institutions/{institutionId}/channel"

	payload := strings.NewReader("{\n  \"channel\": \"DIRECT\"\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))

}

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({channel: 'DIRECT'})
};

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

import requests

url = "https://api.example.com/v1/institutions/{institutionId}/channel"

payload = { "channel": "DIRECT" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "changed": true,
  "changedAt": "2023-11-07T05:31:56Z",
  "changedBy": "<string>",
  "channel": "<string>",
  "institutionId": "<string>",
  "previousChannel": "<string>"
}

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

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "details": {}
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "details": {}
}

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

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

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "details": {}
}

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

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "details": {}
}

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

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

institutionId

string

obrigatório

The institution's unique identifier (UUID).

Exemplo:

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

Corpo

application/json

channel

string

obrigatório

Target channel: DIRECT or MENSAGERIA (exact, upper case).

Exemplo:

"DIRECT"

Resposta

changed

boolean

obrigatório

False when the institution was already on the requested channel.

changedAt

string<date-time>

obrigatório

Instant of the request (UTC).

changedBy

string

obrigatório

Subject of the platform administrator who made the request.

channel

string

obrigatório

The channel now in charge.

institutionId

string

obrigatório

The institution's unique identifier.

previousChannel

string

obrigatório

The channel before the request (equal to channel when nothing changed).

SISBAJUD Mensageria · Instituições

SISBAJUD Mensageria · Ordens e arquivos

SISBAJUD Mensageria · Monitoramento

SISBAJUD Mensageria · Arquivos de retorno

SISBAJUD Mensageria · Solicitações LGPD

SISBAJUD Mensageria · Segurança

SISBAJUD Mensageria · Conformidade

SISBAJUD Mensageria · Dead letter do Lerian STA

SISBAJUD executor · Instituições e conector Midaz

SISBAJUD executor · Canal direto

SISBAJUD executor · Ordens que precisam de atenção

SISBAJUD executor · Roteamento de ledger

SISBAJUD executor · Segurança

SISBAJUD executor · Auditoria

Tratamento de erros

Switch the institution's result channel (Mensageria or DIRECT)

Autorizações

Parâmetros de caminho

Corpo

Resposta