Create summing group

You need to create a summing group to set up price tiers for:

• amount range-based pricing, or

• amount range-based pricing with a count threshold.

In card price lists, you can select the created summing group as a reference for tiered pricing.

Use case

In this example, we will set up a summing group that counts ATM cash withdrawal transactions during the authorisation stage.

Use case data	API parameters with values
Unique name for transaction grouping.	"transactionGroupingCode": "MONTHLY_WITHDRAWAL_SUM_V"
The number of transactions is counted.	"groupingType": "SUM"
Aggregation restarts at the beginning of each month.	"aggregationLevel": "MONTHLY"
Transactions made with different cards using the same account are aggregated.	"aggregationScope": "ACCOUNT"
Transactions are aggregated at the authorisation stage, when authorisation request or advice is approved (and account reservation or account transaction is created).	"includeReservations": true
Transaction grouping is enabled.	"enabled": true
List of transaction types that are aggregated.	"transactionTypeCodes": [ "ATM_WITHDRAWAL" ]

Sample API call

To create a new summing group, make the following API call:

https://card-api.sandbox.tuumplatform.com/api/v1/transaction-grouping

Learn more about create or update transaction grouping endpoint in the Tuum developer portal.

JSON

{
      "transactionGroupingCode": "MONTHLY_WITHDRAWAL_SUM_V",
      "groupingType": "SUM",
      "aggregationLevel": "MONTHLY",
      "aggregationScope": "ACCOUNT",
      "includeReservations": true,
      "enabled": true,
      "transactionTypeCodes": [
        "ATM_WITHDRAWAL"
      ]
}

cURL

curl --location 'https://card-api.sandbox.tuumplatform.com/api/v1/transaction-grouping' \
--header 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1lIjoiT2ZmaWNlciBUZXN0IiwiZW1wbG95ZWVJZCI6IklELTEyMzgiLCJ0ZW5hbnRDb2RlIjoiTUIuRVUiLCJleHBpcnlEVGltZSI6IjIwMjUtMDMtMDVUMTU6MTI6MjAiLCJleHAiOjE3NDExODc1NDAsInJvbGVzIjpbIkFETUlOIl19.eYVmh9G6G55iOvmTUmDM0XBwQe5YT3UsCsyf0YQDFaw' \
--header 'Content-Type: application/json' \
--data '{
      "transactionGroupingCode": "MONTHLY_WITHDRAWAL_SUM_V",
      "groupingType": "SUM",
      "aggregationLevel": "MONTHLY",
      "aggregationScope": "ACCOUNT",
      "includeReservations": true,
      "enabled": true,
      "transactionTypeCodes": [
        "ATM_WITHDRAWAL"
      ]
}'

Sample response

Below you will find the response to the API request:

Response

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

Result

We have created a new summing group, MONTHLY_WITHDRAWAL_SUM_V, to summarise ATM cash withdrawal transactions during the authorisation stage.