Update a package

curl --request PATCH \
  --url https://ledger.sandbox.lerian.net/v2/organizations/{organization_id}/ledgers/{ledger_id}/packages/{package_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "Pacote de taxas administrativas padrão",
  "enable": true,
  "feeGroupLabel": "Pacote Padrão",
  "fees": {},
  "maximumAmount": "1000",
  "minimumAmount": "100",
  "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/{package_id}"

	payload := strings.NewReader("{\n  \"description\": \"Pacote de taxas administrativas padrão\",\n  \"enable\": true,\n  \"feeGroupLabel\": \"Pacote Padrão\",\n  \"fees\": {},\n  \"maximumAmount\": \"1000\",\n  \"minimumAmount\": \"100\",\n  \"waivedAccounts\": [\n    \"acc001\",\n    \"acc002\"\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))

}

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    description: 'Pacote de taxas administrativas padrão',
    enable: true,
    feeGroupLabel: 'Pacote Padrão',
    fees: {},
    maximumAmount: '1000',
    minimumAmount: '100',
    waivedAccounts: ['acc001', 'acc002']
  })
};

fetch('https://ledger.sandbox.lerian.net/v2/organizations/{organization_id}/ledgers/{ledger_id}/packages/{package_id}', 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/{package_id}"

payload = {
    "description": "Pacote de taxas administrativas padrão",
    "enable": True,
    "feeGroupLabel": "Pacote Padrão",
    "fees": {},
    "maximumAmount": "1000",
    "minimumAmount": "100",
    "waivedAccounts": ["acc001", "acc002"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(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"
  }
}

Update a package

A package switched off (enable: false) may keep applying, and a fee whose deferrable changed to false may still open fee debt when unfunded, for up to 60 seconds when a transaction read the packages concurrently with the update. Closing an account is permanent. To retire a fee account, point the fee package at the new fee account and leave the old account open: reverts of earlier transactions and collections of fee debt already owed to it still post there.

PATCH

organizations

{organization_id}

ledgers

{ledger_id}

packages

{package_id}

Update a package

curl --request PATCH \
  --url https://ledger.sandbox.lerian.net/v2/organizations/{organization_id}/ledgers/{ledger_id}/packages/{package_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "Pacote de taxas administrativas padrão",
  "enable": true,
  "feeGroupLabel": "Pacote Padrão",
  "fees": {},
  "maximumAmount": "1000",
  "minimumAmount": "100",
  "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/{package_id}"

	payload := strings.NewReader("{\n  \"description\": \"Pacote de taxas administrativas padrão\",\n  \"enable\": true,\n  \"feeGroupLabel\": \"Pacote Padrão\",\n  \"fees\": {},\n  \"maximumAmount\": \"1000\",\n  \"minimumAmount\": \"100\",\n  \"waivedAccounts\": [\n    \"acc001\",\n    \"acc002\"\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))

}

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    description: 'Pacote de taxas administrativas padrão',
    enable: true,
    feeGroupLabel: 'Pacote Padrão',
    fees: {},
    maximumAmount: '1000',
    minimumAmount: '100',
    waivedAccounts: ['acc001', 'acc002']
  })
};

fetch('https://ledger.sandbox.lerian.net/v2/organizations/{organization_id}/ledgers/{ledger_id}/packages/{package_id}', 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/{package_id}"

payload = {
    "description": "Pacote de taxas administrativas padrão",
    "enable": True,
    "feeGroupLabel": "Pacote Padrão",
    "fees": {},
    "maximumAmount": "1000",
    "minimumAmount": "100",
    "waivedAccounts": ["acc001", "acc002"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(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)

package_id

string

required

Package ID (UUID)

Body

application/json

description

string

Example:

"Pacote de taxas administrativas padrão"

enable

boolean

Example:

true

feeGroupLabel

string

Example:

"Pacote Padrão"

fees

object

Fee patches keyed by fee key. An entry naming a stored key verbatim edits that fee, or removes it when the entry sets no field. Any other key adds a fee and must match ^[a-z][a-zA-Z0-9]*$ (a lowercase ASCII letter, then ASCII letters and digits), or the update is refused with 400; a key equal to a stored key except for letter case is also refused with 400, and the stored key must be used, unless the same patch removes that stored key, which renames the fee (the new key must still match the grammar).

Show child attributes

maximumAmount

string | null

Example:

"1000"

minimumAmount

string | null

Example:

"100"

waivedAccounts

string[] | null

Example:

["acc001", "acc002"]

Response

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

Update a package

Authorizations

Path Parameters

Body

Response