Update institution config by id

curl --request PATCH \
  --url https://api.example.com/v1/institutions/{institutionId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accountFormat": "^[0-9]{1,12}$",
  "branchFormat": "^[0-9]{4}$",
  "connectorMetadata": {
    "authAddress": "https://auth.example.com",
    "baseUrl": "https://midaz.example.com",
    "blockableAccountTypes": [
      "deposit"
    ],
    "blockableBalances": [
      "default"
    ],
    "crmBaseUrl": "https://midaz-crm.example.com",
    "crmMode": "legacy",
    "organizations": [
      {
        "ledgers": [
          "019fcd7c-1e18-7034-8cd3-9e39c1759e41"
        ],
        "organizationId": "019fcd7b-97df-71a5-8023-6eb3c661968b"
      }
    ]
  },
  "connectorType": "midaz",
  "enabled": false,
  "institutionCode": "12345678",
  "retryPolicyConfig": {
    "maxAttempts": 5
  }
}
'

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"accountFormat\": \"^[0-9]{1,12}$\",\n  \"branchFormat\": \"^[0-9]{4}$\",\n  \"connectorMetadata\": {\n    \"authAddress\": \"https://auth.example.com\",\n    \"baseUrl\": \"https://midaz.example.com\",\n    \"blockableAccountTypes\": [\n      \"deposit\"\n    ],\n    \"blockableBalances\": [\n      \"default\"\n    ],\n    \"crmBaseUrl\": \"https://midaz-crm.example.com\",\n    \"crmMode\": \"legacy\",\n    \"organizations\": [\n      {\n        \"ledgers\": [\n          \"019fcd7c-1e18-7034-8cd3-9e39c1759e41\"\n        ],\n        \"organizationId\": \"019fcd7b-97df-71a5-8023-6eb3c661968b\"\n      }\n    ]\n  },\n  \"connectorType\": \"midaz\",\n  \"enabled\": false,\n  \"institutionCode\": \"12345678\",\n  \"retryPolicyConfig\": {\n    \"maxAttempts\": 5\n  }\n}")

	req, _ := http.NewRequest("PATCH", 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: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    accountFormat: '^[0-9]{1,12}$',
    branchFormat: '^[0-9]{4}$',
    connectorMetadata: {
      authAddress: 'https://auth.example.com',
      baseUrl: 'https://midaz.example.com',
      blockableAccountTypes: ['deposit'],
      blockableBalances: ['default'],
      crmBaseUrl: 'https://midaz-crm.example.com',
      crmMode: 'legacy',
      organizations: [
        {
          ledgers: ['019fcd7c-1e18-7034-8cd3-9e39c1759e41'],
          organizationId: '019fcd7b-97df-71a5-8023-6eb3c661968b'
        }
      ]
    },
    connectorType: 'midaz',
    enabled: false,
    institutionCode: '12345678',
    retryPolicyConfig: {maxAttempts: 5}
  })
};

fetch('https://api.example.com/v1/institutions/{institutionId}', 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}"

payload = {
    "accountFormat": "^[0-9]{1,12}$",
    "branchFormat": "^[0-9]{4}$",
    "connectorMetadata": {
        "authAddress": "https://auth.example.com",
        "baseUrl": "https://midaz.example.com",
        "blockableAccountTypes": ["deposit"],
        "blockableBalances": ["default"],
        "crmBaseUrl": "https://midaz-crm.example.com",
        "crmMode": "legacy",
        "organizations": [
            {
                "ledgers": ["019fcd7c-1e18-7034-8cd3-9e39c1759e41"],
                "organizationId": "019fcd7b-97df-71a5-8023-6eb3c661968b"
            }
        ]
    },
    "connectorType": "midaz",
    "enabled": False,
    "institutionCode": "12345678",
    "retryPolicyConfig": { "maxAttempts": 5 }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "connectorType": "midaz",
  "createdAt": "2024-01-15T10:30:00Z",
  "enabled": true,
  "institutionCode": "12345678",
  "institutionId": "550e8400-e29b-41d4-a716-446655440000",
  "updatedAt": "2024-01-15T12:00:00Z",
  "accountFormat": "^[0-9]{1,12}$",
  "branchFormat": "^[0-9]{4}$",
  "connectorMetadata": {
    "baseUrl": "https://midaz.example.com",
    "blockableAccountTypes": [
      "deposit"
    ],
    "blockableBalances": [
      "default"
    ],
    "organizations": [
      {
        "ledgers": [
          "019fcd7c-1e18-7034-8cd3-9e39c1759e41"
        ],
        "organizationId": "019fcd7b-97df-71a5-8023-6eb3c661968b"
      }
    ]
  },
  "connectorMetadataValid": false,
  "effectiveCrmMode": "legacy",
  "retryPolicyConfig": {
    "maxAttempts": 3
  }
}

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

Update institution config by id

Applies a partial update (connectorType/institutionCode/retryPolicyConfig/connectorMetadata/branchFormat/accountFormat/enabled) to an existing institution configuration addressed by the path id. connectorMetadata, when present, replaces the entire bag wholesale. Invalid input is refused with 400 SBJ-0001, including a branchFormat/accountFormat that does not compile or is longer than 64 characters, and a merged configuration left without a valid institutionCode. Returns 404 when the institution has no configuration.

PATCH

institutions

{institutionId}

curl --request PATCH \
  --url https://api.example.com/v1/institutions/{institutionId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accountFormat": "^[0-9]{1,12}$",
  "branchFormat": "^[0-9]{4}$",
  "connectorMetadata": {
    "authAddress": "https://auth.example.com",
    "baseUrl": "https://midaz.example.com",
    "blockableAccountTypes": [
      "deposit"
    ],
    "blockableBalances": [
      "default"
    ],
    "crmBaseUrl": "https://midaz-crm.example.com",
    "crmMode": "legacy",
    "organizations": [
      {
        "ledgers": [
          "019fcd7c-1e18-7034-8cd3-9e39c1759e41"
        ],
        "organizationId": "019fcd7b-97df-71a5-8023-6eb3c661968b"
      }
    ]
  },
  "connectorType": "midaz",
  "enabled": false,
  "institutionCode": "12345678",
  "retryPolicyConfig": {
    "maxAttempts": 5
  }
}
'

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"accountFormat\": \"^[0-9]{1,12}$\",\n  \"branchFormat\": \"^[0-9]{4}$\",\n  \"connectorMetadata\": {\n    \"authAddress\": \"https://auth.example.com\",\n    \"baseUrl\": \"https://midaz.example.com\",\n    \"blockableAccountTypes\": [\n      \"deposit\"\n    ],\n    \"blockableBalances\": [\n      \"default\"\n    ],\n    \"crmBaseUrl\": \"https://midaz-crm.example.com\",\n    \"crmMode\": \"legacy\",\n    \"organizations\": [\n      {\n        \"ledgers\": [\n          \"019fcd7c-1e18-7034-8cd3-9e39c1759e41\"\n        ],\n        \"organizationId\": \"019fcd7b-97df-71a5-8023-6eb3c661968b\"\n      }\n    ]\n  },\n  \"connectorType\": \"midaz\",\n  \"enabled\": false,\n  \"institutionCode\": \"12345678\",\n  \"retryPolicyConfig\": {\n    \"maxAttempts\": 5\n  }\n}")

	req, _ := http.NewRequest("PATCH", 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: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    accountFormat: '^[0-9]{1,12}$',
    branchFormat: '^[0-9]{4}$',
    connectorMetadata: {
      authAddress: 'https://auth.example.com',
      baseUrl: 'https://midaz.example.com',
      blockableAccountTypes: ['deposit'],
      blockableBalances: ['default'],
      crmBaseUrl: 'https://midaz-crm.example.com',
      crmMode: 'legacy',
      organizations: [
        {
          ledgers: ['019fcd7c-1e18-7034-8cd3-9e39c1759e41'],
          organizationId: '019fcd7b-97df-71a5-8023-6eb3c661968b'
        }
      ]
    },
    connectorType: 'midaz',
    enabled: false,
    institutionCode: '12345678',
    retryPolicyConfig: {maxAttempts: 5}
  })
};

fetch('https://api.example.com/v1/institutions/{institutionId}', 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}"

payload = {
    "accountFormat": "^[0-9]{1,12}$",
    "branchFormat": "^[0-9]{4}$",
    "connectorMetadata": {
        "authAddress": "https://auth.example.com",
        "baseUrl": "https://midaz.example.com",
        "blockableAccountTypes": ["deposit"],
        "blockableBalances": ["default"],
        "crmBaseUrl": "https://midaz-crm.example.com",
        "crmMode": "legacy",
        "organizations": [
            {
                "ledgers": ["019fcd7c-1e18-7034-8cd3-9e39c1759e41"],
                "organizationId": "019fcd7b-97df-71a5-8023-6eb3c661968b"
            }
        ]
    },
    "connectorType": "midaz",
    "enabled": False,
    "institutionCode": "12345678",
    "retryPolicyConfig": { "maxAttempts": 5 }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "connectorType": "midaz",
  "createdAt": "2024-01-15T10:30:00Z",
  "enabled": true,
  "institutionCode": "12345678",
  "institutionId": "550e8400-e29b-41d4-a716-446655440000",
  "updatedAt": "2024-01-15T12:00:00Z",
  "accountFormat": "^[0-9]{1,12}$",
  "branchFormat": "^[0-9]{4}$",
  "connectorMetadata": {
    "baseUrl": "https://midaz.example.com",
    "blockableAccountTypes": [
      "deposit"
    ],
    "blockableBalances": [
      "default"
    ],
    "organizations": [
      {
        "ledgers": [
          "019fcd7c-1e18-7034-8cd3-9e39c1759e41"
        ],
        "organizationId": "019fcd7b-97df-71a5-8023-6eb3c661968b"
      }
    ]
  },
  "connectorMetadataValid": false,
  "effectiveCrmMode": "legacy",
  "retryPolicyConfig": {
    "maxAttempts": 3
  }
}

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

accountFormat

string

Regular expression (Go RE2 syntax, at most 64 characters) the institution DECLARES for the account number a court may indicate in a BLOQUEIO restriction. A value is proven invalid (TARGET_INVALID) only when it fails the WHOLE pattern; with no declaration nothing is ever proven invalid. Per institution and never defaulted. A pattern that does not compile, or is longer than 64 characters, is refused with 400. Omitted leaves the stored declaration unchanged; an empty string clears it.

Exemplo:

"^[0-9]{1,12}$"

branchFormat

string

Regular expression (Go RE2 syntax, at most 64 characters) the institution DECLARES for the branch (agência) number a court may indicate in a BLOQUEIO restriction. A value is proven invalid (TARGET_INVALID) only when it fails the WHOLE pattern; with no declaration nothing is ever proven invalid. Per institution and never defaulted. A pattern that does not compile, or is longer than 64 characters, is refused with 400. Omitted leaves the stored declaration unchanged; an empty string clears it.

Exemplo:

"^[0-9]{4}$"

connectorMetadata

any

Connector-specific configuration bag. When present, replaces the entire bag wholesale, with ONLY the connector-owned credentials subtree carried over when omitted. baseUrl, organizations[] and authAddress are NOT carried over, so a replacing bag must re-supply baseUrl and organizations[] (both always required) and authAddress (required whenever credentials remain, supplied or carried), or the write is rejected. A credentials subtree in the patched bag is REFUSED with 400: credentials are written only by PUT /v1/institutions/{institutionId}/connector-credentials. Omitting credentials leaves the stored ones untouched (they are carried over). There is no authMode. crmMode is part of the replaced bag like any other key: a patched bag that omits it drops the override and the institution falls back to inheriting MIDAZ_CRM_MODE. Omit this field entirely to leave the stored bag untouched — an explicitly supplied null decodes to the same absent pointer and is likewise a no-op on this column, not a request to clear it (true of every field of this body, since they are all pointers).

Exemplo:

{
  "authAddress": "https://auth.example.com",
  "baseUrl": "https://midaz.example.com",
  "blockableAccountTypes": ["deposit"],
  "blockableBalances": ["default"],
  "crmBaseUrl": "https://midaz-crm.example.com",
  "crmMode": "legacy",
  "organizations": [
    {
      "ledgers": ["019fcd7c-1e18-7034-8cd3-9e39c1759e41"],
      "organizationId": "019fcd7b-97df-71a5-8023-6eb3c661968b"
    }
  ]
}

connectorType

string

The outbound connector type. Omitted fields are left unchanged.

Exemplo:

"midaz"

enabled

boolean

Whether the connector configuration is active. Omitted leaves the flag unchanged; explicitly false disables it.

Exemplo:

false

institutionCode

string

The institution's BACEN CNPJ (8 digits). When present, replaces the stored value.

Exemplo:

"12345678"

retryPolicyConfig

any

Operational retry policy as arbitrary JSON. When present, replaces the stored value.

Exemplo:

{ "maxAttempts": 5 }

Resposta

connectorType

string

obrigatório

The outbound connector type for this institution.

Exemplo:

"midaz"

createdAt

string

obrigatório

RFC 3339 creation timestamp (UTC).

Exemplo:

"2024-01-15T10:30:00Z"

enabled

boolean

obrigatório

Whether the connector configuration is active.

Exemplo:

true

institutionCode

string

obrigatório

The institution's BACEN CNPJ (8 digits) for return-file headers and file header validation.

Exemplo:

"12345678"

institutionId

string

obrigatório

The institution's unique identifier (UUID).

Exemplo:

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

updatedAt

string

obrigatório

RFC 3339 last-update timestamp (UTC).

Exemplo:

"2024-01-15T12:00:00Z"

accountFormat

string

The regular expression the institution declared for the account number of a court-indicated target; omitted when none is declared.

Exemplo:

"^[0-9]{1,12}$"

branchFormat

string

The regular expression the institution declared for the branch (agência) number of a court-indicated target; omitted when none is declared.

Exemplo:

"^[0-9]{4}$"

connectorMetadata

any

Connector-specific configuration bag. The non-secret connector-owned keys (baseUrl, authAddress, crmBaseUrl, crmMode, organizations[], blockableBalances, blockableAccountTypes, salaryAccountTypes) are preserved verbatim; secret-bearing keys — the whole credentials subtree included — are removed and never echoed. blockableBalances carries the LEDGER's balance-key values — for Midaz, balanceKey (default/overdraft/a client-registered key), not the available/onHold fields of a balance.

Exemplo:

{
  "baseUrl": "https://midaz.example.com",
  "blockableAccountTypes": ["deposit"],
  "blockableBalances": ["default"],
  "organizations": [
    {
      "ledgers": ["019fcd7c-1e18-7034-8cd3-9e39c1759e41"],
      "organizationId": "019fcd7b-97df-71a5-8023-6eb3c661968b"
    }
  ]
}

connectorMetadataValid

boolean

read-only

Present and false only when the stored connector metadata cannot be parsed by its connector; absent otherwise. The offending value is never echoed.

Exemplo:

false

effectiveCrmMode

enum<string>

read-only

The CRM surface this institution resolves to (legacy|embedded): its own crmMode override when the connector metadata names one, the service-wide default otherwise. Derived and read-only; omitted when the connector metadata cannot be parsed.

Opções disponíveis:

legacy,

embedded

Exemplo:

"legacy"

retryPolicyConfig

any

Operational retry policy (backoff/attempts) as arbitrary JSON.

Exemplo:

{ "maxAttempts": 3 }

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 · Ordens que precisam de atenção

SISBAJUD executor · Roteamento de ledger

SISBAJUD executor · Segurança

SISBAJUD executor · Auditoria

Tratamento de erros

Update institution config by id

Autorizações

Parâmetros de caminho

Corpo

Resposta