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

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

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

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Path Parameters

organization_id

string

required

Organization ID (UUID)

ledger_id

string

required

Ledger ID (UUID)

Body

application/json

enable

boolean | null

required

feeGroupLabel

string

required

Example:

"Pacote Padrão"

fees

object

required

Show child attributes

maximumAmount

string

required

Example:

"1000.20"

minimumAmount

string

required

Example:

"100.00"

segmentId

string | null

required

Example:

"00000000-0000-0000-0000-000000000000"

description

string

Example:

"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

Example:

{ "fee_context": "ted_salario" }

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.

Example:

"00000000-0000-0000-0000-000000000000"

waivedAccounts

string[]

Example:

["acc001", "acc002"]

Response

Created

createdAt

string<date-time>

required

Example:

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

deletedAt

string<date-time> | null

required

Example:

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

description

string | null

required

Example:

"Pacote de taxas administrativas padrão"

enable

boolean | null

required

feeGroupLabel

string

required

Example:

"Pacote Padrão"

fees

object

required

Show child attributes

string

required

Example:

"00000000-0000-0000-0000-000000000000"

ledgerId

string

required

Example:

"00000000-0000-0000-0000-000000000000"

maximumAmount

string

required

Example:

"2"

minimumAmount

string

required

Example:

"100"

segmentId

string

required

Example:

"00000000-0000-0000-0000-000000000000"

transactionRoute

string | null

required

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.

Example:

"00000000-0000-0000-0000-000000000000"

updatedAt

string<date-time>

required

Example:

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

waivedAccounts

string[] | null

required

Example:

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

Example:

{ "fee_context": "ted_salario" }

Getting started

Core

CRM

Fees

Error handling

Events

Create a Package

Authorizations

Path Parameters

Body

Response