All pages
Powered by GitBook
1 of 3

Loading...

Loading...

Loading...

Fee quotation

This service provides a pre-transaction fee quote, emphasising the applicable service fee based on specific transaction conditions. Below are two example use cases:

  1. Test future price list: Learn how to test price lists that are scheduled to enter into force in the future by submitting quote request to assess that it is working as expected.

  2. Calculate fee for specific account: Learn how to get a precise quote about the price on a particular transaction if it were to be executed on a particular account.

Test future price list
Calculate fee for specific account

Calculate fee for specific account

It calculates the applicable fee for a given transaction based on parameters such as transaction amount, currency, associated fees, tiers, and labels. The response consists of a calculated total price along with a breakdown of associated fees.

Use case

Here, you will learn how to use the fee quotation service to calculate the fee for a specific account in Tuum.

If accountId is provided, the parameters situationCode, priceListCode, currentTransactionAmount, and currentTransactionCount are not used. In this case, the system uses current data from the specified account.

Use case data
API parameters with values

Posting date is the date the transaction is posted. The format is YYYY-MM-DD.

Transaction type

Amount details

Labels are used to define the association between transaction types and fee types.

Card account technical identifier

Card technical identifier

Always include the cardId in fee calculation requests for debit, prepaid, or gift cards. This ensures the correct card-level price list is used, as multiple cards may be linked to the same current account.

Sample API call

To request the fee quotation, use the following endpoint:

https://card-api.sandbox.tuumplatform.com/api/v1/transactions/calculate-fees

Learn more about the calculate fee quotation for transaction endpoint in the Tuum developer portal.

Sample request

The sample request body is as follows:

{
	"postingDate": "2025-07-01",
	"transactionTypeCode": "CARD_CREDIT",
	"transactionAmount": {
		"amount": 100,
		"currencyCode": "EUR"
	},
	"labels": [
		"CASH_DEPOSIT"
	],
        "accountId": "C001664282533",
        "cardId": "C001664282530"
}
curl --location 'https://card-api.sandbox.tuumplatform.com/api/v1/transactions/calculate-fees' \
--header 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1lIjoiTGlpdmEgS2FzdCIsImVtcGxveWVlSWQiOiJJRC0xMDcxIiwidGVuYW50Q29kZSI6Ik1CIiwiZXhwaXJ5RFRpbWUiOiIyMDI1LTA2LTEwVDEwOjQ2OjA4IiwiZXhwIjoxNzQ5NTUyMzY4LCJyb2xlcyI6WyJBRE1JTiIsIkRBU0hCT0FSRF9CQUxBTkNFX1ZJRVdFUiIsIlNZU1RFTSJdfQ.GENLDkd1m0fp44xPYqMZ_vgNgdVDWcQcHcyOLwMghIY' \
--header 'Content-Type: application/json' \
--data '{
	"postingDate": "2025-07-01",
	"transactionTypeCode": "CARD_CREDIT",
	"transactionAmount": {
		"amount": 100,
		"currencyCode": "EUR"
	},
	"labels": [
		"CASH_DEPOSIT"
	],
        "accountId": "C001664282533",
        "cardId": "C001664282530"
}'

Sample response

Below you will find the response to the sample request:

Response
{
    "errors": null,
    "validationErrors": null,
    "data": {
        "totalFeeAmount": {
            "amount": 3.00,
            "currencyCode": "EUR"
        },
        "fees": [
            {
                "feeTypeCode": "ATM_CASH_DEPOSIT_FEE",
                "feeMoney": {
                    "amount": 3.00,
                    "currencyCode": "EUR"
                }
            }
        ]
    }
}

Test future price list

It calculates the applicable fee for a given transaction based on parameters such as transaction amount, currency, associated fees, tiers, and labels. The response consists of a calculated total price along with a breakdown of associated fees.

Use case

Here, you will learn how to use the fee quotation service to test the price list that will be in effect in the future in Tuum.

For this use case, do not specify accountId.

Use case data
API parameters with values

Sample API call

To request the fee quotation, use the following endpoint:

https://card-api.sandbox.tuumplatform.com/api/v1/transactions/calculate-fees

Learn more about the endpoint in the Tuum developer portal.

Sample request

The sample request body is as follows:

Sample response

Below you will find the response to the sample request:

Response

Posting date is the date the transaction is posted. The format is YYYY-MM-DD.

"postingDate": "2027-12-01"

Transaction type

"transactionTypeCode": "ATM_WITHDRAWAL"

Amount details

"transactionAmount": {
    "amount": 100,
    "currencyCode": "EUR"
  }

Enter a list of labels when label-based pricing is applied.

"labels": [
		"OTHER_CURRENCY",
		"ATM_FOREIGN"
	]

Situation code refers to the transaction status.

The allowed values are NORMAL and OVERLIMIT.

"situationCode": "NORMAL"

Price list code

"priceListCode": "DEBIT_CARD"

Enter the monthly transaction amount when pricing is based on monthly transaction amount.

"currentTransactionAmount": {
		"amount": 1320,
		"currencyCode": "EUR"
	}

Enter the monthly transaction count when pricing is based on monthly transaction count.

"currentTransactionCount": 8
{
	"postingDate": "2027-12-01",
	"transactionTypeCode": "ATM_WITHDRAWAL",
	"transactionAmount": {
		"amount": 100,
		"currencyCode": "EUR"
	},
	"labels": [
		"OTHER_CURRENCY",
		"ATM_FOREIGN"
	],
	"situationCode": "NORMAL",
	"priceListCode": "DEBIT_CARD",
	"currentTransactionAmount": {
		"amount": 1320,
		"currencyCode": "EUR"
	},
	"currentTransactionCount": 8
}
curl --location 'https://card-api.sandbox.tuumplatform.com/api/v1/transactions/calculate-fees' \
--header 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1lIjoiTGlpdmEgS2FzdCIsImVtcGxveWVlSWQiOiJJRC0xMDcxIiwidGVuYW50Q29kZSI6Ik1CIiwiZXhwaXJ5RFRpbWUiOiIyMDI1LTA2LTEwVDExOjA1OjMyIiwiZXhwIjoxNzQ5NTUzNTMyLCJyb2xlcyI6WyJBRE1JTiIsIkRBU0hCT0FSRF9CQUxBTkNFX1ZJRVdFUiIsIlNZU1RFTSJdfQ.ks3EOPYI1b-vAApsiJpwoRKHrAXrLRzm8oncKVQ84_A' \
--header 'Content-Type: application/json' \
--data '{
	"postingDate": "2027-12-01",
	"transactionTypeCode": "ATM_WITHDRAWAL",
	"transactionAmount": {
		"amount": 100,
		"currencyCode": "EUR"
	},
	"labels": [
		"OTHER_CURRENCY",
		"ATM_FOREIGN"
	],
	"situationCode": "NORMAL",
	"priceListCode": "DEBIT_CARD",
	"currentTransactionAmount": {
		"amount": 1320,
		"currencyCode": "EUR"
	},
	"currentTransactionCount": 8
}'
{
    "errors": null,
    "validationErrors": null,
    "data": {
        "totalFeeAmount": {
            "amount": 4.50,
            "currencyCode": "EUR"
        },
        "fees": [
            {
                "feeTypeCode": "FX_CONVERSION_FEE",
                "feeMoney": {
                    "amount": 2.00,
                    "currencyCode": "EUR"
                }
            },
            {
                "feeTypeCode": "ATM_WITHDRAWAL_FEE",
                "feeMoney": {
                    "amount": 2.50,
                    "currencyCode": "EUR"
                }
            }
        ]
    }
}
calculate fee quotation for transaction
"postingDate": "2027-12-10"
"transactionTypeCode": "CARD_CREDIT"
"transactionAmount": {
    "amount": 100,
    "currencyCode": "EUR"
  }
	"labels": [
		"CASH_DEPOSIT"
	]
"accountId": "C001664282533"
"cardId": "C001664282530"