Criar uma Rota de Transação

curl --request POST \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transaction-routes \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "PIX",
  "description": "Pix from external bank account",
  "operationRoutes": [
    "019c96a0-1071-7a0d-9916-a831221de252",
    "019c96a0-2222-3333-4444-555566667777"
  ],
  "metadata": {}
}
'

import requests

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

payload = {
    "title": "PIX",
    "description": "Pix from external bank account",
    "operationRoutes": ["019c96a0-1071-7a0d-9916-a831221de252", "019c96a0-2222-3333-4444-555566667777"],
    "metadata": {}
}
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({
    title: 'PIX',
    description: 'Pix from external bank account',
    operationRoutes: ['019c96a0-1071-7a0d-9916-a831221de252', '019c96a0-2222-3333-4444-555566667777'],
    metadata: {}
  })
};

fetch('https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transaction-routes', 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}/transaction-routes",
  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([
    'title' => 'PIX',
    'description' => 'Pix from external bank account',
    'operationRoutes' => [
        '019c96a0-1071-7a0d-9916-a831221de252',
        '019c96a0-2222-3333-4444-555566667777'
    ],
    'metadata' => [
        
    ]
  ]),
  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}/transaction-routes"

	payload := strings.NewReader("{\n  \"title\": \"PIX\",\n  \"description\": \"Pix from external bank account\",\n  \"operationRoutes\": [\n    \"019c96a0-1071-7a0d-9916-a831221de252\",\n    \"019c96a0-2222-3333-4444-555566667777\"\n  ],\n  \"metadata\": {}\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}/transaction-routes")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"PIX\",\n  \"description\": \"Pix from external bank account\",\n  \"operationRoutes\": [\n    \"019c96a0-1071-7a0d-9916-a831221de252\",\n    \"019c96a0-2222-3333-4444-555566667777\"\n  ],\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"title\": \"PIX\",\n  \"description\": \"Pix from external bank account\",\n  \"operationRoutes\": [\n    \"019c96a0-1071-7a0d-9916-a831221de252\",\n    \"019c96a0-2222-3333-4444-555566667777\"\n  ],\n  \"metadata\": {}\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",
  "title": "<string>",
  "description": "<string>",
  "operationRoutes": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "code": "<string>",
      "description": "<string>",
      "accountingEntries": {
        "direct": {
          "debit": {
            "code": "<string>",
            "description": "<string>"
          },
          "credit": {
            "code": "<string>",
            "description": "<string>"
          }
        },
        "hold": {
          "debit": {
            "code": "<string>",
            "description": "<string>"
          },
          "credit": {
            "code": "<string>",
            "description": "<string>"
          }
        },
        "commit": {
          "debit": {
            "code": "<string>",
            "description": "<string>"
          },
          "credit": {
            "code": "<string>",
            "description": "<string>"
          }
        },
        "cancel": {
          "debit": {
            "code": "<string>",
            "description": "<string>"
          },
          "credit": {
            "code": "<string>",
            "description": "<string>"
          }
        },
        "revert": {
          "debit": {
            "code": "<string>",
            "description": "<string>"
          },
          "credit": {
            "code": "<string>",
            "description": "<string>"
          }
        },
        "overdraft": {
          "debit": {
            "code": "<string>",
            "description": "<string>"
          },
          "credit": {
            "code": "<string>",
            "description": "<string>"
          }
        }
      },
      "account": {
        "validIf": [
          [
            "current_asset",
            "payment_account"
          ]
        ]
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z",
      "metadata": {}
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z",
  "metadata": {}
}

POST

organizations

{organization_id}

ledgers

{ledger_id}

transaction-routes

Criar uma Rota de Transação

curl --request POST \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transaction-routes \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "PIX",
  "description": "Pix from external bank account",
  "operationRoutes": [
    "019c96a0-1071-7a0d-9916-a831221de252",
    "019c96a0-2222-3333-4444-555566667777"
  ],
  "metadata": {}
}
'

import requests

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

payload = {
    "title": "PIX",
    "description": "Pix from external bank account",
    "operationRoutes": ["019c96a0-1071-7a0d-9916-a831221de252", "019c96a0-2222-3333-4444-555566667777"],
    "metadata": {}
}
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({
    title: 'PIX',
    description: 'Pix from external bank account',
    operationRoutes: ['019c96a0-1071-7a0d-9916-a831221de252', '019c96a0-2222-3333-4444-555566667777'],
    metadata: {}
  })
};

fetch('https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transaction-routes', 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}/transaction-routes",
  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([
    'title' => 'PIX',
    'description' => 'Pix from external bank account',
    'operationRoutes' => [
        '019c96a0-1071-7a0d-9916-a831221de252',
        '019c96a0-2222-3333-4444-555566667777'
    ],
    'metadata' => [
        
    ]
  ]),
  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}/transaction-routes"

	payload := strings.NewReader("{\n  \"title\": \"PIX\",\n  \"description\": \"Pix from external bank account\",\n  \"operationRoutes\": [\n    \"019c96a0-1071-7a0d-9916-a831221de252\",\n    \"019c96a0-2222-3333-4444-555566667777\"\n  ],\n  \"metadata\": {}\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}/transaction-routes")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"PIX\",\n  \"description\": \"Pix from external bank account\",\n  \"operationRoutes\": [\n    \"019c96a0-1071-7a0d-9916-a831221de252\",\n    \"019c96a0-2222-3333-4444-555566667777\"\n  ],\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"title\": \"PIX\",\n  \"description\": \"Pix from external bank account\",\n  \"operationRoutes\": [\n    \"019c96a0-1071-7a0d-9916-a831221de252\",\n    \"019c96a0-2222-3333-4444-555566667777\"\n  ],\n  \"metadata\": {}\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",
  "title": "<string>",
  "description": "<string>",
  "operationRoutes": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "code": "<string>",
      "description": "<string>",
      "accountingEntries": {
        "direct": {
          "debit": {
            "code": "<string>",
            "description": "<string>"
          },
          "credit": {
            "code": "<string>",
            "description": "<string>"
          }
        },
        "hold": {
          "debit": {
            "code": "<string>",
            "description": "<string>"
          },
          "credit": {
            "code": "<string>",
            "description": "<string>"
          }
        },
        "commit": {
          "debit": {
            "code": "<string>",
            "description": "<string>"
          },
          "credit": {
            "code": "<string>",
            "description": "<string>"
          }
        },
        "cancel": {
          "debit": {
            "code": "<string>",
            "description": "<string>"
          },
          "credit": {
            "code": "<string>",
            "description": "<string>"
          }
        },
        "revert": {
          "debit": {
            "code": "<string>",
            "description": "<string>"
          },
          "credit": {
            "code": "<string>",
            "description": "<string>"
          }
        },
        "overdraft": {
          "debit": {
            "code": "<string>",
            "description": "<string>"
          },
          "credit": {
            "code": "<string>",
            "description": "<string>"
          }
        }
      },
      "account": {
        "validIf": [
          [
            "current_asset",
            "payment_account"
          ]
        ]
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z",
      "metadata": {}
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z",
  "metadata": {}
}

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

title

string

obrigatório

Texto curto que resume o propósito da transação. Usado como nota de entrada para identificação.

Maximum string length: 50

operationRoutes

string<uuid>[]

obrigatório

Uma lista de IDs de Rotas de Operação que definem a lógica de origem e destino para a transação. Importante: Uma rota de transação deve incluir pelo menos uma rota de operação com tipo 'source' e pelo menos uma com tipo 'destination'.

description

string

Uma descrição para a Rota de Transação.

Maximum string length: 250

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 o recurso foi criado com sucesso e a operação foi concluída conforme esperado.

string<uuid>

O identificador único da Rota de Transação.

organizationId

string<uuid>

O identificador único da Organização.

ledgerId

string<uuid>

O identificador único do Ledger.

title

string

Texto curto que resume o propósito da transação. Usado como nota de entrada para identificação.

description

string

Uma descrição para a Rota de Transação.

operationRoutes

object[]

Lista de objetos contendo informações sobre as Rotas de Operação da Rota de Transação.

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).

metadata

object

Show child attributes

Excluir uma Rota de Operação

Listar Rotas de Transação

⌘I