Create price list

Price lists must exist before you can create card products or perform any other functions with the card module.

Use case

In this example, we will create a price list with the following sample data:

Use case data	API parameters with values
Description of the price list	"description": "Sample price list"
Validity range of the price list (Date format: YYYY-MM-DD)	"validityRange": { "startDate": "2023-12-01", "endDate": null }
Name of the price list that you are creating (This must be a unique value)	"priceListCode": "PRICELIST-01"

Sample API call

To create a price list, use the following endpoint:

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

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

Sample request

The sample request body is as follows:

JSON

{
  "description": "Sample price list",
  "validityRange": {
    "endDate": null,
    "startDate": "2023-12-01"
  },
  "priceListCode": "PRICELIST-01"
}

cURL

curl --location 'https://card-api.sandbox.tuumplatform.com/api/v1/cards/price-list' \
--header 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEVGltZSI6IjIwMjMtMDYtMTdUMTQ6Mzc6MDkiLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHAiOjE2ODcwMTI2Mjl9.mFpqAQDdOPcaH0C3Vtbew8WcGicnn_5t5ptJ4qo3efg' \
--header 'x-channel-code: system' \
--header 'Content-Type: application/json' \
--data '{
  "description": "Sample price list",
  "validityRange": {
    "endDate": null,
    "startDate": "2023-12-01"
  },
  "priceListCode": "PRICELIST-01"
}'

Sample response

Below you will find the response to the API request:

Response

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

Result

The sample price list with the code PRICELIST-01 is created. You can use this code for other functions, such as assigning it to card products, mapping fees, and creating card applications and offers.