Create counting group

PreviousCard counting and summing groups NextCreate summing group

Last updated 1 month ago

Was this helpful?

Create counting group

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

count range-based pricing, or
amount range-based pricing with a count threshold.

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

Use case

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

Use case data

API parameters with values

Unique name for transaction grouping.

The number of transactions is counted.

Aggregation restarts at the beginning of each month.

Transactions made with different cards using the same account are aggregated.

Transactions are aggregated at the authorisation stage, when authorisation request or advice is approved (and account reservation or account transaction is created).

Transaction grouping is enabled.

List of transaction types that are aggregated.

Sample API call

To create a new counting 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.

Sample request

The sample request body is as follows:

{
      "transactionGroupingCode": "MONTHLY_WITHDRAWAL_COUNT_V",
      "groupingType": "COUNT",
      "aggregationLevel": "MONTHLY",
      "aggregationScope": "ACCOUNT",
      "includeReservations": true,
      "enabled": true,
      "transactionTypeCodes": [
        "ATM_WITHDRAWAL"
      ]

curl --location 'https://card-api.sandbox.tuumplatform.com/api/v1/transaction-grouping' \
--header 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1lIjoiTGlpdmEgS2FzdCIsImVtcGxveWVlSWQiOiJJRC0xMjU4IiwidGVuYW50Q29kZSI6Ik1CLkVVIiwiZXhwaXJ5RFRpbWUiOiIyMDI1LTAzLTA1VDE0OjMwOjEyIiwiZXhwIjoxNzQxMTg1MDEyLCJyb2xlcyI6WyJGVUxMX0NBUkRfTUFOQUdFTUVOVCIsIlNZU1RFTSJdfQ.ZVincGpeLedTc1UtbjFefr-V7n8G3QVOn63FimgVPhM' \
--header 'Content-Type: application/json' \
--data '{
      "transactionGroupingCode": "MONTHLY_WITHDRAWAL_COUNT_V",
      "groupingType": "COUNT",
      "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 counting group, MONTHLY_WITHDRAWAL_COUNT_V, that counts ATM cash withdrawal transactions during the authorisation stage.