Financing costs

These events are emitted by the Inventory API (btrz-api-inventory) when financing costs are created, updated, or deleted.

Events

Action Event name Endpoint
Creating a financing cost financingcosts.created POST /financing-costs
Editing financing cost financingcosts.updated PUT /financing-costs/:financingcostId
Deleting financing cost financingcosts.deleted DELETE /financing-costs/:financingcostId

Payload example created

{
    "attemptId": "50ed4745-7922-4b2a-aee7-50bb767d434e",
    "created": 1754317982,
    "data": {
      "_id": "6890c47499346c06f2965af2",
      "accountId": "66cfac670bba74052b9e98ca",
      "createdAt": {
        "offset": 0,
        "value": "2025-08-04T14:32:20.788Z"
      },
      "createdBy": "67254d96a63f890539c5b0ea",
      "creditCard": "mastercard",
      "currencyCode": "ARS",
      "dow": {
        "friday": true,
        "monday": true,
        "saturday": true,
        "sunday": true,
        "thursday": true,
        "tuesday": true,
        "wednesday": true
      },
      "enabled": true,
      "interest": [
        {
          "quotaNumber": 6,
          "rate": 0
        },
        {
          "quotaNumber": 12,
          "rate": 0
        }
      ],
      "internalId": "TSTWB",
      "maxQuota": 12,
      "name": "Test Webhook",
      "updatedAt": {
        "offset": 0,
        "value": "2025-08-04T14:32:20.788Z"
      },
      "updatedBy": "67254d96a63f890539c5b0ea"
    },
    "event": "financingcosts.created",
    "id": "5a104d9d-5cdf-4178-8fdd-480adb6093f7",
    "livemode": false
  }

Field descriptions — data (financingcosts.created / financingcosts.updated)

Field Type Description
_id string Financing cost id (24 hex characters).
accountId string Account (provider) id.
name string Name displayed when selecting the payment method.
internalId string Unique code for the financing cost.
currencyCode string Currency ISO code (e.g. ARS, USD).
dow object Days of week when the financing cost is valid (monday–sunday booleans).
creditCard string Credit card brand (visa, mastercard, amex, discover, cabal, naranja, patagonia365).
maxQuota integer Maximum number of quotas; if no interest matches a quota, rate is 0%.
interest array List of { rate, quotaNumber } per quota. rate is in btrz precision (e.g. 14.5% = 14500).
enabled boolean Whether the financing cost is available in the purchase flow.
createdBy string User id that created the resource.
updatedBy string User id that last updated the resource.
createdAt object Creation date (BzDate: value, offset).
updatedAt object Last update date (BzDate: value, offset).

Payload example updated

{
    "attemptId": "22240f19-2345-4832-bebd-fc33f1173b00",
    "created": 1754318150,
    "data": {
      "_id": "6890c47499346c06f2965af2",
      "accountId": "66cfac670bba74052b9e98ca",
      "createdAt": {
        "offset": 0,
        "value": "2025-08-04T14:32:20.788Z"
      },
      "createdBy": "67254d96a63f890539c5b0ea",
      "creditCard": "mastercard",
      "currencyCode": "ARS",
      "dow": {
        "friday": false,
        "monday": true,
        "saturday": true,
        "sunday": true,
        "thursday": false,
        "tuesday": true,
        "wednesday": false
      },
      "enabled": true,
      "interest": [
        {
          "quotaNumber": 6,
          "rate": 0
        },
        {
          "quotaNumber": 12,
          "rate": 0
        },
        {
          "quotaNumber": 3,
          "rate": 0
        }
      ],
      "internalId": "TSTWB",
      "maxQuota": 12,
      "name": "Test Webhook",
      "updatedAt": {
        "offset": 0,
        "value": "2025-08-04T14:34:36.331Z"
      },
      "updatedBy": "67254d96a63f890539c5b0ea"
    },
    "event": "financingcosts.updated",
    "id": "caa6bbd3-512b-43ed-959b-f4c31b647189",
    "livemode": false
  }

(Field descriptions for data are the same as for financingcosts.created above.)

Payload example deleted

{
    "attemptId": "4565e261-f9dc-4d54-8252-596d9d28f79b",
    "created": 1754318232,
    "data": {
      "financingcostId": "6890c47499346c06f2965af2"
    },
    "event": "financingcosts.deleted",
    "id": "fb8f1a73-10dd-4dcc-90bc-2471ab35c8d8",
    "livemode": false
  }

Field descriptions — data (financingcosts.deleted)

Field Type Description
financingcostId string Id of the deleted financing cost (24 hex characters).