Criar uma Conta

curl --request POST \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts \
  --header 'Content-Type: application/json' \
  --data '
{
  "assetCode": "BRL",
  "name": "Customer BRL Account 1",
  "alias": "customer-brl-1",
  "type": "deposit",
  "status": {
    "code": "ACTIVE",
    "description": "Operational retail account for Pix and internal payments"
  },
  "metadata": {
    "bankCode": "341",
    "branchNumber": "0001",
    "accountNumber": "12345678-9",
    "accountPlan": "retail_personal_wallet",
    "dailyLimit": 50000
  }
}
'

import requests

url = "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts"

payload = {
    "assetCode": "BRL",
    "name": "Customer BRL Account 1",
    "alias": "customer-brl-1",
    "type": "deposit",
    "status": {
        "code": "ACTIVE",
        "description": "Operational retail account for Pix and internal payments"
    },
    "metadata": {
        "bankCode": "341",
        "branchNumber": "0001",
        "accountNumber": "12345678-9",
        "accountPlan": "retail_personal_wallet",
        "dailyLimit": 50000
    }
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    assetCode: 'BRL',
    name: 'Customer BRL Account 1',
    alias: 'customer-brl-1',
    type: 'deposit',
    status: {
      code: 'ACTIVE',
      description: 'Operational retail account for Pix and internal payments'
    },
    metadata: {
      bankCode: '341',
      branchNumber: '0001',
      accountNumber: '12345678-9',
      accountPlan: 'retail_personal_wallet',
      dailyLimit: 50000
    }
  })
};

fetch('https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts', 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://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts",
  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([
    'assetCode' => 'BRL',
    'name' => 'Customer BRL Account 1',
    'alias' => 'customer-brl-1',
    'type' => 'deposit',
    'status' => [
        'code' => 'ACTIVE',
        'description' => 'Operational retail account for Pix and internal payments'
    ],
    'metadata' => [
        'bankCode' => '341',
        'branchNumber' => '0001',
        'accountNumber' => '12345678-9',
        'accountPlan' => 'retail_personal_wallet',
        'dailyLimit' => 50000
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "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://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts"

	payload := strings.NewReader("{\n  \"assetCode\": \"BRL\",\n  \"name\": \"Customer BRL Account 1\",\n  \"alias\": \"customer-brl-1\",\n  \"type\": \"deposit\",\n  \"status\": {\n    \"code\": \"ACTIVE\",\n    \"description\": \"Operational retail account for Pix and internal payments\"\n  },\n  \"metadata\": {\n    \"bankCode\": \"341\",\n    \"branchNumber\": \"0001\",\n    \"accountNumber\": \"12345678-9\",\n    \"accountPlan\": \"retail_personal_wallet\",\n    \"dailyLimit\": 50000\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	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://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts")
  .header("Content-Type", "application/json")
  .body("{\n  \"assetCode\": \"BRL\",\n  \"name\": \"Customer BRL Account 1\",\n  \"alias\": \"customer-brl-1\",\n  \"type\": \"deposit\",\n  \"status\": {\n    \"code\": \"ACTIVE\",\n    \"description\": \"Operational retail account for Pix and internal payments\"\n  },\n  \"metadata\": {\n    \"bankCode\": \"341\",\n    \"branchNumber\": \"0001\",\n    \"accountNumber\": \"12345678-9\",\n    \"accountPlan\": \"retail_personal_wallet\",\n    \"dailyLimit\": 50000\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"assetCode\": \"BRL\",\n  \"name\": \"Customer BRL Account 1\",\n  \"alias\": \"customer-brl-1\",\n  \"type\": \"deposit\",\n  \"status\": {\n    \"code\": \"ACTIVE\",\n    \"description\": \"Operational retail account for Pix and internal payments\"\n  },\n  \"metadata\": {\n    \"bankCode\": \"341\",\n    \"branchNumber\": \"0001\",\n    \"accountNumber\": \"12345678-9\",\n    \"accountPlan\": \"retail_personal_wallet\",\n    \"dailyLimit\": 50000\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "assetCode": "<string>",
  "name": "<string>",
  "alias": "<string>",
  "type": "<string>",
  "blocked": false,
  "parentAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "entityId": "<string>",
  "portfolioId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "segmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": {
    "code": "<string>",
    "description": "<string>"
  },
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z"
}

Criar uma Conta

Use este endpoint para criar uma Conta no Midaz. Você pode criar quantas contas forem necessárias para estruturar seu ledger, mas cada requisição cria apenas uma conta por vez.

Importante: Antes de criar uma Conta, certifique-se de que o Ativo correspondente já existe. Use o endpoint Criar um Ativo para registrá-lo, se necessário.

Se você definiu Tipos de Conta anteriormente, certifique-se de que estão configurados corretamente antes da criação da conta. Recomendamos recriar as contas existentes ou atualizá-las para incluir o tipo correto antes de habilitar o recurso de validação de Tipo de Conta — isso ajuda a prevenir erros de validação e garante conformidade com sua estrutura contábil.

Nota: o valor external do campo type é reservado para contas externas gerenciadas pelo sistema e é rejeitado na entrada.

POST

organizations

{organization_id}

ledgers

{ledger_id}

accounts

Criar uma Conta

curl --request POST \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts \
  --header 'Content-Type: application/json' \
  --data '
{
  "assetCode": "BRL",
  "name": "Customer BRL Account 1",
  "alias": "customer-brl-1",
  "type": "deposit",
  "status": {
    "code": "ACTIVE",
    "description": "Operational retail account for Pix and internal payments"
  },
  "metadata": {
    "bankCode": "341",
    "branchNumber": "0001",
    "accountNumber": "12345678-9",
    "accountPlan": "retail_personal_wallet",
    "dailyLimit": 50000
  }
}
'

import requests

url = "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts"

payload = {
    "assetCode": "BRL",
    "name": "Customer BRL Account 1",
    "alias": "customer-brl-1",
    "type": "deposit",
    "status": {
        "code": "ACTIVE",
        "description": "Operational retail account for Pix and internal payments"
    },
    "metadata": {
        "bankCode": "341",
        "branchNumber": "0001",
        "accountNumber": "12345678-9",
        "accountPlan": "retail_personal_wallet",
        "dailyLimit": 50000
    }
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    assetCode: 'BRL',
    name: 'Customer BRL Account 1',
    alias: 'customer-brl-1',
    type: 'deposit',
    status: {
      code: 'ACTIVE',
      description: 'Operational retail account for Pix and internal payments'
    },
    metadata: {
      bankCode: '341',
      branchNumber: '0001',
      accountNumber: '12345678-9',
      accountPlan: 'retail_personal_wallet',
      dailyLimit: 50000
    }
  })
};

fetch('https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts', 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://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts",
  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([
    'assetCode' => 'BRL',
    'name' => 'Customer BRL Account 1',
    'alias' => 'customer-brl-1',
    'type' => 'deposit',
    'status' => [
        'code' => 'ACTIVE',
        'description' => 'Operational retail account for Pix and internal payments'
    ],
    'metadata' => [
        'bankCode' => '341',
        'branchNumber' => '0001',
        'accountNumber' => '12345678-9',
        'accountPlan' => 'retail_personal_wallet',
        'dailyLimit' => 50000
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "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://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts"

	payload := strings.NewReader("{\n  \"assetCode\": \"BRL\",\n  \"name\": \"Customer BRL Account 1\",\n  \"alias\": \"customer-brl-1\",\n  \"type\": \"deposit\",\n  \"status\": {\n    \"code\": \"ACTIVE\",\n    \"description\": \"Operational retail account for Pix and internal payments\"\n  },\n  \"metadata\": {\n    \"bankCode\": \"341\",\n    \"branchNumber\": \"0001\",\n    \"accountNumber\": \"12345678-9\",\n    \"accountPlan\": \"retail_personal_wallet\",\n    \"dailyLimit\": 50000\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	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://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts")
  .header("Content-Type", "application/json")
  .body("{\n  \"assetCode\": \"BRL\",\n  \"name\": \"Customer BRL Account 1\",\n  \"alias\": \"customer-brl-1\",\n  \"type\": \"deposit\",\n  \"status\": {\n    \"code\": \"ACTIVE\",\n    \"description\": \"Operational retail account for Pix and internal payments\"\n  },\n  \"metadata\": {\n    \"bankCode\": \"341\",\n    \"branchNumber\": \"0001\",\n    \"accountNumber\": \"12345678-9\",\n    \"accountPlan\": \"retail_personal_wallet\",\n    \"dailyLimit\": 50000\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"assetCode\": \"BRL\",\n  \"name\": \"Customer BRL Account 1\",\n  \"alias\": \"customer-brl-1\",\n  \"type\": \"deposit\",\n  \"status\": {\n    \"code\": \"ACTIVE\",\n    \"description\": \"Operational retail account for Pix and internal payments\"\n  },\n  \"metadata\": {\n    \"bankCode\": \"341\",\n    \"branchNumber\": \"0001\",\n    \"accountNumber\": \"12345678-9\",\n    \"accountPlan\": \"retail_personal_wallet\",\n    \"dailyLimit\": 50000\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "assetCode": "<string>",
  "name": "<string>",
  "alias": "<string>",
  "type": "<string>",
  "blocked": false,
  "parentAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "entityId": "<string>",
  "portfolioId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "segmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": {
    "code": "<string>",
    "description": "<string>"
  },
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z"
}

Cabeçalhos

Content-Type

string

O tipo de mídia do recurso. O valor recomendado é application/json.

X-Request-Id

string<uuid>

Um identificador único utilizado para rastrear e acompanhar cada requisição.

Authorization

string

Token JWT bearer para autenticação. Obrigatório quando PLUGIN_AUTH_ENABLED=true (exigido em implantações multi-tenant). Opcional no modo OSS single-tenant padrão. Formato: Bearer <token>

Parâmetros de caminho

organization_id

string<uuid>

obrigatório

O identificador único da Organização associada ao Ledger.

ledger_id

string<uuid>

obrigatório

O identificador único do Ledger associado.

Corpo

application/json

assetCode

string

obrigatório

O código que identifica o Ativo utilizado na Conta. Importante: Deve ser um Ativo que você já criou usando o endpoint Criar um Ativo.

Maximum string length: 100

type

string

obrigatório

Especifica o Tipo de Conta associado à conta. Este campo é obrigatório. Importante: Quando a validação de Tipo de Conta está habilitada para sua Organização e Ledger, o valor deve corresponder a um keyValue existente definido na sua configuração de Tipos de Conta. Quando a validação está desabilitada (comportamento padrão), o campo continua sendo obrigatório, mas aceita qualquer string de formato livre sem validação. O valor external é reservado e rejeitado na entrada.

Maximum string length: 256

name

string

O nome da Conta.

Maximum string length: 256

alias

string

Um identificador único e amigável para a conta. Usado para referenciar a conta em transações e outras operações. Se não fornecido, o sistema usará o ID da conta como alias. Nota: o alias não deve conter o prefixo reservado @external/, que é reservado para contas externas gerenciadas pelo sistema.

Maximum string length: 100

Pattern: ^[a-zA-Z0-9@:_-]+$

blocked

boolean

padrão:false

Define se a conta deve começar bloqueada.

parentAccountId

string<uuid> | null

O identificador único da Conta pai, caso esta seja uma subconta.

entityId

string | null

O identificador único da Entidade responsável pela Conta.

Maximum string length: 256

portfolioId

string<uuid> | null

O identificador único do Portfolio associado.

segmentId

string<uuid> | null

O identificador único do Segmento utilizado para agrupar a Conta.

status

object

Um objeto contendo informações sobre o status. Importante: Se não fornecido, o status padrão será 'ACTIVE'.

Show child attributes

metadata

object

Um objeto contendo pares de chave-valor para adicionar como metadata, onde o campo name é a chave e o campo value é o valor. Por exemplo, para adicionar um Centro de Custo, use 'costCenter': 'BR_11101997'.

Restrições: as chaves devem ter no máximo 100 caracteres; valores de string no máximo 2000 caracteres. Objetos aninhados não são permitidos (os valores devem ser string, número ou booleano), a estrutura não pode exceder uma profundidade máxima de 10, e é permitido um máximo de 100 chaves.

Show child attributes

Resposta

Indica que a requisição foi bem-sucedida e a resposta contém os dados esperados.

string<uuid>

O identificador único da Conta.

organizationId

string<uuid>

O identificador único da Organização.

ledgerId

string<uuid>

O identificador único do Ledger.

assetCode

string

O código que identifica o Ativo utilizado na Conta.

name

string

O nome da Conta.

Maximum string length: 256

alias

string

Um identificador único e amigável para a conta. Usado para referenciar a conta em transações e outras operações.

type

string

Especifica o Tipo de Conta associado à conta.

blocked

boolean

padrão:false

Define se a conta deve ser bloqueada.

parentAccountId

string<uuid> | null

O identificador único da Conta Pai.

entityId

string | null

O identificador único da Entidade responsável pela Conta.

portfolioId

string<uuid> | null

O identificador único do Portfolio associado.

segmentId

string<uuid> | null

O identificador único do Segmento utilizado para agrupar a Conta.

status

object

Um objeto contendo informações sobre o status.

Show child attributes

metadata

object

Show child attributes

createdAt

string<date-time>

Data e hora de criação (UTC).

updatedAt

string<date-time>

Data e hora da última atualização (UTC).

deletedAt

string<date-time> | null

Data e hora da exclusão lógica, se aplicável (UTC).

Excluir um Tipo de Conta

Listar Contas

⌘I