Create institution config and provision keys
curl --request POST \
--url https://sisbajud.sandbox.lerian.net/institutions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"connectorType": "midaz",
"enabled": true,
"institutionCode": "12345678",
"institutionId": "550e8400-e29b-41d4-a716-446655440000",
"connectorMetadata": {
"authAddress": "https://auth.example.com",
"baseUrl": "https://midaz.example.com",
"blockableAccountTypes": [
"deposit"
],
"blockableBalances": [
"default"
],
"credentials": {
"crm_client_id": "midaz-crm-client",
"crm_client_secret": "REPLACE_ME",
"ledger_client_id": "midaz-ledger-client",
"ledger_client_secret": "REPLACE_ME"
},
"crmBaseUrl": "https://midaz-crm.example.com",
"organizations": [
{
"ledgers": [
"019fcd7c-1e18-7034-8cd3-9e39c1759e41"
],
"organizationId": "019fcd7b-97df-71a5-8023-6eb3c661968b"
}
]
},
"retryPolicyConfig": {
"initialBackoffMs": 100,
"maxAttempts": 3
}
}
'import requests
url = "https://sisbajud.sandbox.lerian.net/institutions"
payload = {
"connectorType": "midaz",
"enabled": True,
"institutionCode": "12345678",
"institutionId": "550e8400-e29b-41d4-a716-446655440000",
"connectorMetadata": {
"authAddress": "https://auth.example.com",
"baseUrl": "https://midaz.example.com",
"blockableAccountTypes": ["deposit"],
"blockableBalances": ["default"],
"credentials": {
"crm_client_id": "midaz-crm-client",
"crm_client_secret": "REPLACE_ME",
"ledger_client_id": "midaz-ledger-client",
"ledger_client_secret": "REPLACE_ME"
},
"crmBaseUrl": "https://midaz-crm.example.com",
"organizations": [
{
"ledgers": ["019fcd7c-1e18-7034-8cd3-9e39c1759e41"],
"organizationId": "019fcd7b-97df-71a5-8023-6eb3c661968b"
}
]
},
"retryPolicyConfig": {
"initialBackoffMs": 100,
"maxAttempts": 3
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
connectorType: 'midaz',
enabled: true,
institutionCode: '12345678',
institutionId: '550e8400-e29b-41d4-a716-446655440000',
connectorMetadata: {
authAddress: 'https://auth.example.com',
baseUrl: 'https://midaz.example.com',
blockableAccountTypes: ['deposit'],
blockableBalances: ['default'],
credentials: {
crm_client_id: 'midaz-crm-client',
crm_client_secret: 'REPLACE_ME',
ledger_client_id: 'midaz-ledger-client',
ledger_client_secret: 'REPLACE_ME'
},
crmBaseUrl: 'https://midaz-crm.example.com',
organizations: [
{
ledgers: ['019fcd7c-1e18-7034-8cd3-9e39c1759e41'],
organizationId: '019fcd7b-97df-71a5-8023-6eb3c661968b'
}
]
},
retryPolicyConfig: {initialBackoffMs: 100, maxAttempts: 3}
})
};
fetch('https://sisbajud.sandbox.lerian.net/institutions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sisbajud.sandbox.lerian.net/institutions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'connectorType' => 'midaz',
'enabled' => true,
'institutionCode' => '12345678',
'institutionId' => '550e8400-e29b-41d4-a716-446655440000',
'connectorMetadata' => [
'authAddress' => 'https://auth.example.com',
'baseUrl' => 'https://midaz.example.com',
'blockableAccountTypes' => [
'deposit'
],
'blockableBalances' => [
'default'
],
'credentials' => [
'crm_client_id' => 'midaz-crm-client',
'crm_client_secret' => 'REPLACE_ME',
'ledger_client_id' => 'midaz-ledger-client',
'ledger_client_secret' => 'REPLACE_ME'
],
'crmBaseUrl' => 'https://midaz-crm.example.com',
'organizations' => [
[
'ledgers' => [
'019fcd7c-1e18-7034-8cd3-9e39c1759e41'
],
'organizationId' => '019fcd7b-97df-71a5-8023-6eb3c661968b'
]
]
],
'retryPolicyConfig' => [
'initialBackoffMs' => 100,
'maxAttempts' => 3
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sisbajud.sandbox.lerian.net/institutions"
payload := strings.NewReader("{\n \"connectorType\": \"midaz\",\n \"enabled\": true,\n \"institutionCode\": \"12345678\",\n \"institutionId\": \"550e8400-e29b-41d4-a716-446655440000\",\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 \"credentials\": {\n \"crm_client_id\": \"midaz-crm-client\",\n \"crm_client_secret\": \"REPLACE_ME\",\n \"ledger_client_id\": \"midaz-ledger-client\",\n \"ledger_client_secret\": \"REPLACE_ME\"\n },\n \"crmBaseUrl\": \"https://midaz-crm.example.com\",\n \"organizations\": [\n {\n \"ledgers\": [\n \"019fcd7c-1e18-7034-8cd3-9e39c1759e41\"\n ],\n \"organizationId\": \"019fcd7b-97df-71a5-8023-6eb3c661968b\"\n }\n ]\n },\n \"retryPolicyConfig\": {\n \"initialBackoffMs\": 100,\n \"maxAttempts\": 3\n }\n}")
req, _ := http.NewRequest("POST", 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))
}HttpResponse<String> response = Unirest.post("https://sisbajud.sandbox.lerian.net/institutions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"connectorType\": \"midaz\",\n \"enabled\": true,\n \"institutionCode\": \"12345678\",\n \"institutionId\": \"550e8400-e29b-41d4-a716-446655440000\",\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 \"credentials\": {\n \"crm_client_id\": \"midaz-crm-client\",\n \"crm_client_secret\": \"REPLACE_ME\",\n \"ledger_client_id\": \"midaz-ledger-client\",\n \"ledger_client_secret\": \"REPLACE_ME\"\n },\n \"crmBaseUrl\": \"https://midaz-crm.example.com\",\n \"organizations\": [\n {\n \"ledgers\": [\n \"019fcd7c-1e18-7034-8cd3-9e39c1759e41\"\n ],\n \"organizationId\": \"019fcd7b-97df-71a5-8023-6eb3c661968b\"\n }\n ]\n },\n \"retryPolicyConfig\": {\n \"initialBackoffMs\": 100,\n \"maxAttempts\": 3\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sisbajud.sandbox.lerian.net/institutions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"connectorType\": \"midaz\",\n \"enabled\": true,\n \"institutionCode\": \"12345678\",\n \"institutionId\": \"550e8400-e29b-41d4-a716-446655440000\",\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 \"credentials\": {\n \"crm_client_id\": \"midaz-crm-client\",\n \"crm_client_secret\": \"REPLACE_ME\",\n \"ledger_client_id\": \"midaz-ledger-client\",\n \"ledger_client_secret\": \"REPLACE_ME\"\n },\n \"crmBaseUrl\": \"https://midaz-crm.example.com\",\n \"organizations\": [\n {\n \"ledgers\": [\n \"019fcd7c-1e18-7034-8cd3-9e39c1759e41\"\n ],\n \"organizationId\": \"019fcd7b-97df-71a5-8023-6eb3c661968b\"\n }\n ]\n },\n \"retryPolicyConfig\": {\n \"initialBackoffMs\": 100,\n \"maxAttempts\": 3\n }\n}"
response = http.request(request)
puts response.read_body{
"connectorType": "midaz",
"createdAt": "2024-01-15T10:30:00Z",
"enabled": true,
"institutionCode": "12345678",
"institutionId": "550e8400-e29b-41d4-a716-446655440000",
"updatedAt": "2024-01-15T12:00:00Z",
"connectorMetadata": {
"baseUrl": "https://midaz.example.com",
"blockableAccountTypes": [
"deposit"
],
"blockableBalances": [
"default"
],
"organizations": [
{
"ledgers": [
"019fcd7c-1e18-7034-8cd3-9e39c1759e41"
],
"organizationId": "019fcd7b-97df-71a5-8023-6eb3c661968b"
}
]
},
"retryPolicyConfig": {
"maxAttempts": 3
}
}{
"code": "ERR-0001",
"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"
}
}Create institution config and provision keys
Creates a new institution configuration (create-only; 409 if one already exists for the id) and provisions its tokenization PRF + audit MAC keysets in the same flow. The institution id is supplied in the request body.
POST
/
institutions
Create institution config and provision keys
curl --request POST \
--url https://sisbajud.sandbox.lerian.net/institutions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"connectorType": "midaz",
"enabled": true,
"institutionCode": "12345678",
"institutionId": "550e8400-e29b-41d4-a716-446655440000",
"connectorMetadata": {
"authAddress": "https://auth.example.com",
"baseUrl": "https://midaz.example.com",
"blockableAccountTypes": [
"deposit"
],
"blockableBalances": [
"default"
],
"credentials": {
"crm_client_id": "midaz-crm-client",
"crm_client_secret": "REPLACE_ME",
"ledger_client_id": "midaz-ledger-client",
"ledger_client_secret": "REPLACE_ME"
},
"crmBaseUrl": "https://midaz-crm.example.com",
"organizations": [
{
"ledgers": [
"019fcd7c-1e18-7034-8cd3-9e39c1759e41"
],
"organizationId": "019fcd7b-97df-71a5-8023-6eb3c661968b"
}
]
},
"retryPolicyConfig": {
"initialBackoffMs": 100,
"maxAttempts": 3
}
}
'import requests
url = "https://sisbajud.sandbox.lerian.net/institutions"
payload = {
"connectorType": "midaz",
"enabled": True,
"institutionCode": "12345678",
"institutionId": "550e8400-e29b-41d4-a716-446655440000",
"connectorMetadata": {
"authAddress": "https://auth.example.com",
"baseUrl": "https://midaz.example.com",
"blockableAccountTypes": ["deposit"],
"blockableBalances": ["default"],
"credentials": {
"crm_client_id": "midaz-crm-client",
"crm_client_secret": "REPLACE_ME",
"ledger_client_id": "midaz-ledger-client",
"ledger_client_secret": "REPLACE_ME"
},
"crmBaseUrl": "https://midaz-crm.example.com",
"organizations": [
{
"ledgers": ["019fcd7c-1e18-7034-8cd3-9e39c1759e41"],
"organizationId": "019fcd7b-97df-71a5-8023-6eb3c661968b"
}
]
},
"retryPolicyConfig": {
"initialBackoffMs": 100,
"maxAttempts": 3
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
connectorType: 'midaz',
enabled: true,
institutionCode: '12345678',
institutionId: '550e8400-e29b-41d4-a716-446655440000',
connectorMetadata: {
authAddress: 'https://auth.example.com',
baseUrl: 'https://midaz.example.com',
blockableAccountTypes: ['deposit'],
blockableBalances: ['default'],
credentials: {
crm_client_id: 'midaz-crm-client',
crm_client_secret: 'REPLACE_ME',
ledger_client_id: 'midaz-ledger-client',
ledger_client_secret: 'REPLACE_ME'
},
crmBaseUrl: 'https://midaz-crm.example.com',
organizations: [
{
ledgers: ['019fcd7c-1e18-7034-8cd3-9e39c1759e41'],
organizationId: '019fcd7b-97df-71a5-8023-6eb3c661968b'
}
]
},
retryPolicyConfig: {initialBackoffMs: 100, maxAttempts: 3}
})
};
fetch('https://sisbajud.sandbox.lerian.net/institutions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sisbajud.sandbox.lerian.net/institutions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'connectorType' => 'midaz',
'enabled' => true,
'institutionCode' => '12345678',
'institutionId' => '550e8400-e29b-41d4-a716-446655440000',
'connectorMetadata' => [
'authAddress' => 'https://auth.example.com',
'baseUrl' => 'https://midaz.example.com',
'blockableAccountTypes' => [
'deposit'
],
'blockableBalances' => [
'default'
],
'credentials' => [
'crm_client_id' => 'midaz-crm-client',
'crm_client_secret' => 'REPLACE_ME',
'ledger_client_id' => 'midaz-ledger-client',
'ledger_client_secret' => 'REPLACE_ME'
],
'crmBaseUrl' => 'https://midaz-crm.example.com',
'organizations' => [
[
'ledgers' => [
'019fcd7c-1e18-7034-8cd3-9e39c1759e41'
],
'organizationId' => '019fcd7b-97df-71a5-8023-6eb3c661968b'
]
]
],
'retryPolicyConfig' => [
'initialBackoffMs' => 100,
'maxAttempts' => 3
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sisbajud.sandbox.lerian.net/institutions"
payload := strings.NewReader("{\n \"connectorType\": \"midaz\",\n \"enabled\": true,\n \"institutionCode\": \"12345678\",\n \"institutionId\": \"550e8400-e29b-41d4-a716-446655440000\",\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 \"credentials\": {\n \"crm_client_id\": \"midaz-crm-client\",\n \"crm_client_secret\": \"REPLACE_ME\",\n \"ledger_client_id\": \"midaz-ledger-client\",\n \"ledger_client_secret\": \"REPLACE_ME\"\n },\n \"crmBaseUrl\": \"https://midaz-crm.example.com\",\n \"organizations\": [\n {\n \"ledgers\": [\n \"019fcd7c-1e18-7034-8cd3-9e39c1759e41\"\n ],\n \"organizationId\": \"019fcd7b-97df-71a5-8023-6eb3c661968b\"\n }\n ]\n },\n \"retryPolicyConfig\": {\n \"initialBackoffMs\": 100,\n \"maxAttempts\": 3\n }\n}")
req, _ := http.NewRequest("POST", 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))
}HttpResponse<String> response = Unirest.post("https://sisbajud.sandbox.lerian.net/institutions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"connectorType\": \"midaz\",\n \"enabled\": true,\n \"institutionCode\": \"12345678\",\n \"institutionId\": \"550e8400-e29b-41d4-a716-446655440000\",\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 \"credentials\": {\n \"crm_client_id\": \"midaz-crm-client\",\n \"crm_client_secret\": \"REPLACE_ME\",\n \"ledger_client_id\": \"midaz-ledger-client\",\n \"ledger_client_secret\": \"REPLACE_ME\"\n },\n \"crmBaseUrl\": \"https://midaz-crm.example.com\",\n \"organizations\": [\n {\n \"ledgers\": [\n \"019fcd7c-1e18-7034-8cd3-9e39c1759e41\"\n ],\n \"organizationId\": \"019fcd7b-97df-71a5-8023-6eb3c661968b\"\n }\n ]\n },\n \"retryPolicyConfig\": {\n \"initialBackoffMs\": 100,\n \"maxAttempts\": 3\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sisbajud.sandbox.lerian.net/institutions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"connectorType\": \"midaz\",\n \"enabled\": true,\n \"institutionCode\": \"12345678\",\n \"institutionId\": \"550e8400-e29b-41d4-a716-446655440000\",\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 \"credentials\": {\n \"crm_client_id\": \"midaz-crm-client\",\n \"crm_client_secret\": \"REPLACE_ME\",\n \"ledger_client_id\": \"midaz-ledger-client\",\n \"ledger_client_secret\": \"REPLACE_ME\"\n },\n \"crmBaseUrl\": \"https://midaz-crm.example.com\",\n \"organizations\": [\n {\n \"ledgers\": [\n \"019fcd7c-1e18-7034-8cd3-9e39c1759e41\"\n ],\n \"organizationId\": \"019fcd7b-97df-71a5-8023-6eb3c661968b\"\n }\n ]\n },\n \"retryPolicyConfig\": {\n \"initialBackoffMs\": 100,\n \"maxAttempts\": 3\n }\n}"
response = http.request(request)
puts response.read_body{
"connectorType": "midaz",
"createdAt": "2024-01-15T10:30:00Z",
"enabled": true,
"institutionCode": "12345678",
"institutionId": "550e8400-e29b-41d4-a716-446655440000",
"updatedAt": "2024-01-15T12:00:00Z",
"connectorMetadata": {
"baseUrl": "https://midaz.example.com",
"blockableAccountTypes": [
"deposit"
],
"blockableBalances": [
"default"
],
"organizations": [
{
"ledgers": [
"019fcd7c-1e18-7034-8cd3-9e39c1759e41"
],
"organizationId": "019fcd7b-97df-71a5-8023-6eb3c661968b"
}
]
},
"retryPolicyConfig": {
"maxAttempts": 3
}
}{
"code": "ERR-0001",
"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"
}
}Authorizations
JWT bearer token issued by the identity provider.
Body
application/json
The outbound connector type for this institution.
Example:
"midaz"
Whether the connector configuration is active.
Example:
true
The institution's BACEN CNPJ (8 digits) for return-file headers and file header validation.
Example:
"12345678"
The institution's unique identifier (UUID) that addresses the new configuration.
Example:
"550e8400-e29b-41d4-a716-446655440000"
Connector-specific configuration bag: routing (baseUrl required; organizations[] required — the only targeting form, at least one entry naming a Midaz organizationId with optional ledgers; authAddress required when credentials are present; crmBaseUrl optional), admission sets (blockableBalances/blockableAccountTypes), and the connector's credentials under their snake_case allowlisted names (ledger_client_id, ledger_client_secret, crm_client_id, crm_client_secret). blockableBalances carries the LEDGER's balance-key values (for Midaz: balanceKey, e.g. default/overdraft/a client-registered key) — NOT available/onHold, which are fields of a balance, not keys; the set is open and unvalidated, so a wrong value is not rejected, it only makes the admission gate never match. The presence of the credentials subtree selects authentication; there is no authMode. Credential values are sealed before the row is written and are never echoed.
Example:
{
"authAddress": "https://auth.example.com",
"baseUrl": "https://midaz.example.com",
"blockableAccountTypes": ["deposit"],
"blockableBalances": ["default"],
"credentials": {
"crm_client_id": "midaz-crm-client",
"crm_client_secret": "REPLACE_ME",
"ledger_client_id": "midaz-ledger-client",
"ledger_client_secret": "REPLACE_ME"
},
"crmBaseUrl": "https://midaz-crm.example.com",
"organizations": [
{
"ledgers": ["019fcd7c-1e18-7034-8cd3-9e39c1759e41"],
"organizationId": "019fcd7b-97df-71a5-8023-6eb3c661968b"
}
]
}
Operational retry policy (backoff/attempts) as arbitrary JSON.
Example:
{ "initialBackoffMs": 100, "maxAttempts": 3 }
Response
Created
The outbound connector type for this institution.
Example:
"midaz"
RFC 3339 creation timestamp (UTC).
Example:
"2024-01-15T10:30:00Z"
Whether the connector configuration is active.
Example:
true
The institution's BACEN CNPJ (8 digits) for return-file headers and file header validation.
Example:
"12345678"
The institution's unique identifier (UUID).
Example:
"550e8400-e29b-41d4-a716-446655440000"
RFC 3339 last-update timestamp (UTC).
Example:
"2024-01-15T12:00:00Z"
Connector-specific configuration bag. The non-secret connector-owned keys (baseUrl, authAddress, crmBaseUrl, 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.
Example:
{
"baseUrl": "https://midaz.example.com",
"blockableAccountTypes": ["deposit"],
"blockableBalances": ["default"],
"organizations": [
{
"ledgers": ["019fcd7c-1e18-7034-8cd3-9e39c1759e41"],
"organizationId": "019fcd7b-97df-71a5-8023-6eb3c661968b"
}
]
}
Operational retry policy (backoff/attempts) as arbitrary JSON.
Example:
{ "maxAttempts": 3 }
Was this page helpful?