Create card custom booking

Here, you will learn how to create a card custom booking in Tuum.

Use case

In this example, we will demonstrate how to make a card top-up using a custom booking, automatically applying the service fee from the card's associated price list.

circle-info

The example below applies when the card balance is held on the account managed by the Card API. If the account balance is maintained within Tuum Core, a similar endpoint from that respective API should be used instead.

Use case data
API parameters with values

The card account ID to which the funds are added.

The ID of the card to which the funds are to be added.

Note: It is recommended to always provide the card ID. This is necessary to identify the correct card-level price list in cases where multiple cards are associated with the same account.

The transaction type code.

Note: Only a subset of transaction types is available for custom bookings. For more information, refer to the transaction type setuparrow-up-right in the Tuum developer portal.

The amount of money that will be added to the card account.

Fees must be charged.

Note: This applies only if a fee has been specified for the transaction type and if the current price list for the card includes a price for that fee.

Sample API call

To create a new card custom booking, use the following endpoint:

https://card-api.sandbox.tuumplatform.com/api/v1/accounts/{accountId}/custom-bookings

circle-info

Learn more about the create custom bookingarrow-up-right endpoint in the Tuum developer portal.

Sample request

The sample request body is as follows:

{
  "cardId": "C001664282657",
  "transactionTypeCode": "CARD_TOPUP",
  "valueDateRule": "APPROVAL_DATE",
  "valueDate": "2025-07-08",
  "money": {
    "amount": 10000,
    "currencyCode": "EUR"
  },
  "applyFee": true,
  "details": "Adding funds to card account"
}

Sample response

Below you will find the response to the API request:

chevron-rightResponsehashtag

Result

The result includes the full set of custom booking data, including the calculated fee of 4 EUR.

Last updated

Was this helpful?