Actualizar la configuración de institución por id

curl --request PATCH \
  --url https://sisbajud.sandbox.lerian.net/institutions/{institutionId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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"
      }
    ]
  },
  "connectorType": "midaz",
  "enabled": false,
  "institutionCode": "12345678",
  "retryPolicyConfig": {
    "maxAttempts": 5
  }
}
'

import requests

url = "https://sisbajud.sandbox.lerian.net/institutions/{institutionId}"

payload = {
    "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"
            }
        ]
    },
    "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)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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'
        }
      ]
    },
    connectorType: 'midaz',
    enabled: false,
    institutionCode: '12345678',
    retryPolicyConfig: {maxAttempts: 5}
  })
};

fetch('https://sisbajud.sandbox.lerian.net/institutions/{institutionId}', 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/{institutionId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    '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'
                ]
        ]
    ],
    'connectorType' => 'midaz',
    'enabled' => false,
    'institutionCode' => '12345678',
    'retryPolicyConfig' => [
        'maxAttempts' => 5
    ]
  ]),
  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/{institutionId}"

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

}

HttpResponse<String> response = Unirest.patch("https://sisbajud.sandbox.lerian.net/institutions/{institutionId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\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  \"connectorType\": \"midaz\",\n  \"enabled\": false,\n  \"institutionCode\": \"12345678\",\n  \"retryPolicyConfig\": {\n    \"maxAttempts\": 5\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sisbajud.sandbox.lerian.net/institutions/{institutionId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\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  \"connectorType\": \"midaz\",\n  \"enabled\": false,\n  \"institutionCode\": \"12345678\",\n  \"retryPolicyConfig\": {\n    \"maxAttempts\": 5\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"
  }
}

Actualizar la configuración de institución por id

Aplica una actualización parcial (connectorType/institutionCode/retryPolicyConfig/connectorMetadata/enabled/credentials) a una configuración de institución existente direccionada por el id de la ruta. connectorMetadata, cuando está presente, reemplaza por completo todo el conjunto. credentials, cuando está presente, rota las credenciales del conector de la institución. Devuelve 404 cuando la institución no tiene configuración.

PATCH

institutions

{institutionId}

curl --request PATCH \
  --url https://sisbajud.sandbox.lerian.net/institutions/{institutionId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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"
      }
    ]
  },
  "connectorType": "midaz",
  "enabled": false,
  "institutionCode": "12345678",
  "retryPolicyConfig": {
    "maxAttempts": 5
  }
}
'

import requests

url = "https://sisbajud.sandbox.lerian.net/institutions/{institutionId}"

payload = {
    "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"
            }
        ]
    },
    "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)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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'
        }
      ]
    },
    connectorType: 'midaz',
    enabled: false,
    institutionCode: '12345678',
    retryPolicyConfig: {maxAttempts: 5}
  })
};

fetch('https://sisbajud.sandbox.lerian.net/institutions/{institutionId}', 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/{institutionId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    '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'
                ]
        ]
    ],
    'connectorType' => 'midaz',
    'enabled' => false,
    'institutionCode' => '12345678',
    'retryPolicyConfig' => [
        'maxAttempts' => 5
    ]
  ]),
  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/{institutionId}"

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

}

HttpResponse<String> response = Unirest.patch("https://sisbajud.sandbox.lerian.net/institutions/{institutionId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\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  \"connectorType\": \"midaz\",\n  \"enabled\": false,\n  \"institutionCode\": \"12345678\",\n  \"retryPolicyConfig\": {\n    \"maxAttempts\": 5\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sisbajud.sandbox.lerian.net/institutions/{institutionId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\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  \"connectorType\": \"midaz\",\n  \"enabled\": false,\n  \"institutionCode\": \"12345678\",\n  \"retryPolicyConfig\": {\n    \"maxAttempts\": 5\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"
  }
}

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

institutionId

string

requerido

The institution's unique identifier (UUID).

Ejemplo:

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

Cuerpo

application/json

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 ROTATES the stored credentials: it is sealed under a fresh data key in this same write, and this is the only credential-rotation path (there is no separate endpoint). Rotating here does NOT revoke the previous credential upstream and does not take effect on other replicas until their connector cache expires, so rotating a LEAKED credential also requires revoking it at the identity provider. Omitting credentials leaves the stored ones untouched; credentials cannot be removed by PATCH (an empty or partial subtree is rejected). There is no authMode; a rotation supplies the full four-field set. 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).

Ejemplo:

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

connectorType

string

The outbound connector type. Omitted fields are left unchanged.

Ejemplo:

"midaz"

enabled

boolean

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

Ejemplo:

false

institutionCode

string

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

Ejemplo:

"12345678"

retryPolicyConfig

any

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

Ejemplo:

{ "maxAttempts": 5 }

Respuesta

connectorType

string

requerido

The outbound connector type for this institution.

Ejemplo:

"midaz"

createdAt

string

requerido

RFC 3339 creation timestamp (UTC).

Ejemplo:

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

enabled

boolean

requerido

Whether the connector configuration is active.

Ejemplo:

true

institutionCode

string

requerido

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

Ejemplo:

"12345678"

institutionId

string

requerido

The institution's unique identifier (UUID).

Ejemplo:

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

updatedAt

string

requerido

RFC 3339 last-update timestamp (UTC).

Ejemplo:

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

connectorMetadata

any

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.

Ejemplo:

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

retryPolicyConfig

any

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

Ejemplo:

{ "maxAttempts": 3 }

Pix — Lerian SPI (mensajería nativa)

Pix Lerian

Pix — JD (interfaz, directo)

Pix — BTG (interfaz, indirecto)

TED — Lerian SPB (mensajería nativa)

TED — JD (interfaz)

Boletos — BTG (interfaz)

Lerian SILOC (mensajería nativa)

Lerian SLC (mensajería nativa)

Lerian STA (mensajería nativa)

Lerian SISBAJUD (mensajería nativa)

Lerian Consignado — Dataprev

Actualizar la configuración de institución por id

Autorizaciones

Parámetros de ruta

Cuerpo

Respuesta