Create a Package

curl --request POST \
  --url https://ledger.sandbox.lerian.net/v2/organizations/{organization_id}/ledgers/{ledger_id}/packages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "enable": true,
  "feeGroupLabel": "Pacote Padrão",
  "fees": {},
  "maximumAmount": "1000.20",
  "minimumAmount": "100.00",
  "segmentId": "00000000-0000-0000-0000-000000000000",
  "description": "Pacote de taxas administrativas padrão",
  "metadataSelector": {
    "fee_context": "ted_salario"
  },
  "transactionRoute": "00000000-0000-0000-0000-000000000000",
  "waivedAccounts": [
    "acc001",
    "acc002"
  ]
}
'

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"enable\": true,\n  \"feeGroupLabel\": \"Pacote Padrão\",\n  \"fees\": {},\n  \"maximumAmount\": \"1000.20\",\n  \"minimumAmount\": \"100.00\",\n  \"segmentId\": \"00000000-0000-0000-0000-000000000000\",\n  \"description\": \"Pacote de taxas administrativas padrão\",\n  \"metadataSelector\": {\n    \"fee_context\": \"ted_salario\"\n  },\n  \"transactionRoute\": \"00000000-0000-0000-0000-000000000000\",\n  \"waivedAccounts\": [\n    \"acc001\",\n    \"acc002\"\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))

}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    enable: true,
    feeGroupLabel: 'Pacote Padrão',
    fees: {},
    maximumAmount: '1000.20',
    minimumAmount: '100.00',
    segmentId: '00000000-0000-0000-0000-000000000000',
    description: 'Pacote de taxas administrativas padrão',
    metadataSelector: {fee_context: 'ted_salario'},
    transactionRoute: '00000000-0000-0000-0000-000000000000',
    waivedAccounts: ['acc001', 'acc002']
  })
};

fetch('https://ledger.sandbox.lerian.net/v2/organizations/{organization_id}/ledgers/{ledger_id}/packages', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

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

payload = {
    "enable": True,
    "feeGroupLabel": "Pacote Padrão",
    "fees": {},
    "maximumAmount": "1000.20",
    "minimumAmount": "100.00",
    "segmentId": "00000000-0000-0000-0000-000000000000",
    "description": "Pacote de taxas administrativas padrão",
    "metadataSelector": { "fee_context": "ted_salario" },
    "transactionRoute": "00000000-0000-0000-0000-000000000000",
    "waivedAccounts": ["acc001", "acc002"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "createdAt": "2021-01-01T00:00:00Z",
  "deletedAt": "2021-01-01T00:00:00Z",
  "description": "Pacote de taxas administrativas padrão",
  "enable": true,
  "feeGroupLabel": "Pacote Padrão",
  "fees": {},
  "id": "00000000-0000-0000-0000-000000000000",
  "ledgerId": "00000000-0000-0000-0000-000000000000",
  "maximumAmount": "2",
  "minimumAmount": "100",
  "segmentId": "00000000-0000-0000-0000-000000000000",
  "transactionRoute": "00000000-0000-0000-0000-000000000000",
  "updatedAt": "2021-01-01T00:00:00Z",
  "waivedAccounts": [
    "acc001",
    "acc002"
  ],
  "metadataSelector": {
    "fee_context": "ted_salario"
  },
  "rounding": {
    "mode": "floor",
    "scale": 2
  }
}

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

POST

organizations

{organization_id}

ledgers

{ledger_id}

packages

Create a Package

curl --request POST \
  --url https://ledger.sandbox.lerian.net/v2/organizations/{organization_id}/ledgers/{ledger_id}/packages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "enable": true,
  "feeGroupLabel": "Pacote Padrão",
  "fees": {},
  "maximumAmount": "1000.20",
  "minimumAmount": "100.00",
  "segmentId": "00000000-0000-0000-0000-000000000000",
  "description": "Pacote de taxas administrativas padrão",
  "metadataSelector": {
    "fee_context": "ted_salario"
  },
  "transactionRoute": "00000000-0000-0000-0000-000000000000",
  "waivedAccounts": [
    "acc001",
    "acc002"
  ]
}
'

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"enable\": true,\n  \"feeGroupLabel\": \"Pacote Padrão\",\n  \"fees\": {},\n  \"maximumAmount\": \"1000.20\",\n  \"minimumAmount\": \"100.00\",\n  \"segmentId\": \"00000000-0000-0000-0000-000000000000\",\n  \"description\": \"Pacote de taxas administrativas padrão\",\n  \"metadataSelector\": {\n    \"fee_context\": \"ted_salario\"\n  },\n  \"transactionRoute\": \"00000000-0000-0000-0000-000000000000\",\n  \"waivedAccounts\": [\n    \"acc001\",\n    \"acc002\"\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))

}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    enable: true,
    feeGroupLabel: 'Pacote Padrão',
    fees: {},
    maximumAmount: '1000.20',
    minimumAmount: '100.00',
    segmentId: '00000000-0000-0000-0000-000000000000',
    description: 'Pacote de taxas administrativas padrão',
    metadataSelector: {fee_context: 'ted_salario'},
    transactionRoute: '00000000-0000-0000-0000-000000000000',
    waivedAccounts: ['acc001', 'acc002']
  })
};

fetch('https://ledger.sandbox.lerian.net/v2/organizations/{organization_id}/ledgers/{ledger_id}/packages', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

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

payload = {
    "enable": True,
    "feeGroupLabel": "Pacote Padrão",
    "fees": {},
    "maximumAmount": "1000.20",
    "minimumAmount": "100.00",
    "segmentId": "00000000-0000-0000-0000-000000000000",
    "description": "Pacote de taxas administrativas padrão",
    "metadataSelector": { "fee_context": "ted_salario" },
    "transactionRoute": "00000000-0000-0000-0000-000000000000",
    "waivedAccounts": ["acc001", "acc002"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "createdAt": "2021-01-01T00:00:00Z",
  "deletedAt": "2021-01-01T00:00:00Z",
  "description": "Pacote de taxas administrativas padrão",
  "enable": true,
  "feeGroupLabel": "Pacote Padrão",
  "fees": {},
  "id": "00000000-0000-0000-0000-000000000000",
  "ledgerId": "00000000-0000-0000-0000-000000000000",
  "maximumAmount": "2",
  "minimumAmount": "100",
  "segmentId": "00000000-0000-0000-0000-000000000000",
  "transactionRoute": "00000000-0000-0000-0000-000000000000",
  "updatedAt": "2021-01-01T00:00:00Z",
  "waivedAccounts": [
    "acc001",
    "acc002"
  ],
  "metadataSelector": {
    "fee_context": "ted_salario"
  },
  "rounding": {
    "mode": "floor",
    "scale": 2
  }
}

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

organization_id

string

obrigatório

Organization ID (UUID)

ledger_id

string

obrigatório

Ledger ID (UUID)

Corpo

application/json

enable

boolean | null

obrigatório

feeGroupLabel

string

obrigatório

Exemplo:

"Pacote Padrão"

fees

object

obrigatório

Fees keyed by fee key. A key must match ^[a-z][a-zA-Z0-9]*$ (a lowercase ASCII letter, then ASCII letters and digits) and is stored and returned verbatim; any other key is refused with 400.

Show child attributes

maximumAmount

string

obrigatório

Exemplo:

"1000.20"

minimumAmount

string

obrigatório

Exemplo:

"100.00"

segmentId

string | null

obrigatório

Exemplo:

"00000000-0000-0000-0000-000000000000"

description

string

Exemplo:

"Pacote de taxas administrativas padrão"

metadataSelector

object

Metadata pairs a transaction must all carry for this package to apply, each matching only a string metadata value equal to it. Each pair counts one toward package specificity. Omit it to apply the package whatever the metadata.

Show child attributes

Exemplo:

{ "fee_context": "ted_salario" }

rounding

object

Rounds every fee this package charges to one scale, whatever the asset. Omit it to charge unrounded amounts.

Show child attributes

transactionRoute

string

Transaction route identifier this package is scoped to. It must equal the routeId the payment carries, so it is a route UUID and not a free-form name. Omit it, or send it empty, to apply the package to every payment.

Exemplo:

"00000000-0000-0000-0000-000000000000"

waivedAccounts

string[]

Exemplo:

["acc001", "acc002"]

Resposta

Created

createdAt

string<date-time>

obrigatório

Exemplo:

"2021-01-01T00:00:00Z"

deletedAt

string<date-time> | null

obrigatório

Exemplo:

"2021-01-01T00:00:00Z"

description

string | null

obrigatório

Exemplo:

"Pacote de taxas administrativas padrão"

enable

boolean | null

obrigatório

feeGroupLabel

string

obrigatório

Exemplo:

"Pacote Padrão"

fees

object

obrigatório

Show child attributes

string

obrigatório

Exemplo:

"00000000-0000-0000-0000-000000000000"

ledgerId

string

obrigatório

Exemplo:

"00000000-0000-0000-0000-000000000000"

maximumAmount

string

obrigatório

Exemplo:

"2"

minimumAmount

string

obrigatório

Exemplo:

"100"

segmentId

string

obrigatório

Exemplo:

"00000000-0000-0000-0000-000000000000"

transactionRoute

string | null

obrigatório

Transaction route identifier this package is scoped to. It must equal the routeId the payment carries, so it is a route UUID and not a free-form name. An absent or empty value applies the package to every payment.

Exemplo:

"00000000-0000-0000-0000-000000000000"

updatedAt

string<date-time>

obrigatório

Exemplo:

"2021-01-01T00:00:00Z"

waivedAccounts

string[] | null

obrigatório

Exemplo:

["acc001", "acc002"]

metadataSelector

object

Metadata pairs a transaction must all carry for this package to apply, each matching only a string metadata value equal to it. Each pair counts one toward package specificity. Absent or empty applies the package whatever the metadata.

Show child attributes

Exemplo:

{ "fee_context": "ted_salario" }

rounding

object

Show child attributes

Primeiros passos

Núcleo

CRM

Fees

Tratamento de erros

Eventos

Create a Package

Autorizações

Parâmetros de caminho

Corpo

Resposta