Update a package

A package switched off (enable: false) may keep applying, a package whose rounding changed may keep charging the previous one, 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 /v2/organizations/{organization_id}/ledgers/{ledger_id}/packages/{package_id}

Update a package

cURL

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

200

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

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

organization_id · string · requerido

Organization ID (UUID)

ledger_id · string · requerido

Ledger ID (UUID)

package_id · string · requerido

Package ID (UUID)

Cuerpo

application/json

description · string

Ejemplo:

"Pacote de taxas administrativas padrão"

enable · boolean

Ejemplo:

true

feeGroupLabel · string

Ejemplo:

"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

Ejemplo:

"1000"

minimumAmount · string | null

Ejemplo:

"100"

rounding · object

Replaces the stored rounding whole. An update cannot remove a stored rounding.

Show child attributes

waivedAccounts · string[] | null

Ejemplo:

["acc001", "acc002"]

Respuesta

200

application/json

OK

createdAt · string<date-time> · requerido

Ejemplo:

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

deletedAt · string<date-time> | null · requerido

Ejemplo:

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

description · string | null · requerido

Ejemplo:

"Pacote de taxas administrativas padrão"

enable · boolean | null · requerido

feeGroupLabel · string · requerido

Ejemplo:

"Pacote Padrão"

fees · object · requerido

Show child attributes

id · string · requerido

Ejemplo:

"00000000-0000-0000-0000-000000000000"

ledgerId · string · requerido

Ejemplo:

"00000000-0000-0000-0000-000000000000"

maximumAmount · string · requerido

Ejemplo:

"2"

minimumAmount · string · requerido

Ejemplo:

"100"

segmentId · string · requerido

Ejemplo:

"00000000-0000-0000-0000-000000000000"

transactionRoute · string | null · requerido

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.

Ejemplo:

"00000000-0000-0000-0000-000000000000"

updatedAt · string<date-time> · requerido

Ejemplo:

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

waivedAccounts · string[] | null · requerido

Ejemplo:

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

Ejemplo:

{ "fee_context": "ted_salario" }

rounding · object

Show child attributes