Create price for the price list

After creating a price list, we need to add prices. Prices are used to calculate the fee amount for different types of fees such as card opening fees, monthly fees, and transaction fees.

Use case

In this scenario, we will define a price for transaction fees. A fixed amount of 1.05€ will be charged for transactions in the range of 700€ - 1000€.

Use case data	API parameters with values
The path for the request is the price list code.	".../PRICELIST-01/price"
Fee type code	"feeTypeCode": "TRANSACTION_FEE_OWN_CURRENCY"
Currency code	"currencyCode": "EUR"
Fee calculation rule	"calculationRule": "FIX"
Fixed fee amount	"fixedAmount": "1.05"
Validity of the price (Date format: YYYY-MM-DD)	"validityRange": { "startDate": "2023-12-01", "endDate": null }
Range of the transaction amount for which the fee is charged.	"transactionAmountRange": { "startValue": "700.01", "endValue": "1000.01" }

Sample API call

To create the price, use the following endpoint:

https://card-api.sandbox.tuumplatform.com/api/v1/cards/price-list/PRICELIST-01/price

Learn more about the create price for the price list endpoint in the Tuum developer portal.

Sample request

The sample request body is as follows:

JSON

{
  "calculationRule": "FIX",
  "fixedAmount": "1.05",
  "validityRange": {
    "startDate": "2023-12-01",
    "endDate": null
  },
  "transactionAmountRange": {
    "startValue": "700.01",
    "endValue": "1000.01"
  },
  "currencyCode": "EUR",
  "feeTypeCode": "TRANSACTION_FEE_OWN_CURRENCY"
}

cURL

curl --location 'https://card-api.sandbox.tuumplatform.com/api/v1/cards/price-list/PRICELIST-001/price' \
--header 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEVGltZSI6IjIwMjMtMDYtMjlUMTM6MTc6NTEiLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHAiOjE2ODgwNDQ2NzF9.XU8rZzaH7SCkoYtEhiztY4blllz6-qwNNP-slrxguJY' \
--header 'x-channel-code: system' \
--header 'Content-Type: application/json' \
--data '{
  "calculationRule": "FIX",
  "fixedAmount": "1.05",
  "validityRange": {
    "startDate": "2023-12-01",
    "endDate": null
  },
  "transactionAmountRange": {
    "startValue": "700.01",
    "endValue": "1000.01"
  },
  "currencyCode": "EUR",
  "feeTypeCode": "TRANSACTION_FEE_OWN_CURRENCY"
}'

Sample response

Below you will find the response to the API request:

Response

{
    "errors": null,
    "validationErrors": null,
    "data": null
}

Result

We have now created a price item for the price list. Similarly, you can create prices with different calculation rules with transaction amount ranges or count ranges.