Create Card Program

POST

https://{{env}}-lb.simplifipay.com/v1/card-program

Card Program

The Create Card Program endpoint allows API users to create a new card program
to be associated with cards of the SimpliFi platform.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https://uat-lb.simplifipay.com/v1/card-program' \
--header 'requestUuid;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "uuid": "68de4d4a-20ed-48c6-8594-dc74e1730cb7",
    "name": "Marketing Budget",
    "cardProgramTemplateUuid": "36fad307-416e-4333-920a-b07fba57a658",
    "feesOperationEnabled": false,
    "config": {
        "poi": {
            "ecommerce": "true",
            "atm": "true",
            "pos": "true",
            "international": "true",
            "contactless": "true",
            "dcc": "true"
        },
        "velocityControls": {
            "activeVelocityAdapterKey": "SPF-VL-002",
            "velocityControlList": [
                {
                    "velocityAdapterKey": "201",
                    "name": "Velocity 201"
                }
            ]
        },
        "merchantControls": {
            "whiteList": {
                "name": "whitelist",
                "merchants": [
                    {
                        "mid": "1234"
                    }
                ]
            },
            "blackList": {
                "name": "whitelist",
                "merchants": [
                    {
                        "mid": "1234"
                    }
                ]
            }
        }
    }
}'

Response Example

{
    "uuid": "68de4d4a-20ed-48c6-8594-dc74e1730cb7",
    "name": "Marketing Budget",
    "cardProgramTemplateUuid": "36fad307-416e-4333-920a-b07fba57a658",
    "feesOperationEnabled": false,
    "config": {
        "poi": {
            "ecommerce": "true",
            "atm": "true",
            "pos": "true",
            "international": "true",
            "contactless": "true",
            "dcc": "true"
        },
        "velocityControls": {
            "activeVelocityAdapterKey": "SPF-VL-002",
            "velocityControlList": [
                {
                    "velocityAdapterKey": "201",
                    "name": "Velocity 201"
                }
            ]
        },
        "merchantControls": {
            "whiteList": {
                "name": "whitelist",
                "merchants": [
                    {
                        "mid": "1234"
                    }
                ]
            },
            "blackList": {
                "name": "whitelist",
                "merchants": [
                    {
                        "mid": "1234"
                    }
                ]
            }
        }
    }
}

Request

Authorization

JWT

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Header Params

requestUuid

string

required

A unique id is required to be passed as part of the header whenever a SimpliFi API is called from your
system. This would help us in debugging in case of a discrepancy in the expected behavior of the API.

Example:

00d366f2-a6e9-4714-b172-02c4e58c29d8

Body Params application/json

uuid

string

optional

This is a system-generated unique identifier for the card program that was created by this endpoint.

Example:

68de4d4a-20ed-48c6-8594-dc74e1730cb7

name

string

required

This is a custom name for the card program. We recommend choosing a unique name to identify the
card programs that are created under your company.

Example:

Marketing Budget

cardProgramTemplateUuid

string

required

This is a unique identifier that represents a specific card program template. A Card Program
Template contains all the features applicable on a card that would be issued under a card program.
This information is shared by SimpliFi separately. If you don’t have them already, click
on this link.

Example:

36fad307-416e-4333-920a-b07fba57a658

feesOperationEnabled

boolean

optional

This field checks if fee operation is enabled or not.

Default:

false

Example:

true

config

object (CardConfigModel)

optional

This object is a collection of configuration fields including both Point of Interest and Velocity
Control fields. It contains sub-fields explained in the rows below.

poi

object (CardPoi)

required

This object is a collection of Point of Interest configuration fields showing where the card
issued under this card program can be used. It contains sub-fields explained in the rows below.

velocityControls

object (VelocityControlConfigModel)

required

This object is a collection of velocity control fields that defines the frequency of card's usage,
issued under this card program. It contains sub-fields explained in the rows below.

merchantControls

object (MerchantDetailModel)

required

This object is a collection of merchant control fields. These are customizable controls over the
top of pre-configured ones. For example, restriction over certain types of merchants such as drugs
nd gambling merchants etc. It contains sub-fields explained in the rows below.

Examples

Responses

🟢200OK

application/json

Body

uuid

string

optional

This is a system-generated unique identifier for the card program that was created by this endpoint.

Example:

68de4d4a-20ed-48c6-8594-dc74e1730cb7

name

string

required

This is a custom name for the card program. We recommend choosing a unique name to identify the
card programs that are created under your company.

Example:

Marketing Budget

cardProgramTemplateUuid

string

required

Example:

36fad307-416e-4333-920a-b07fba57a658

feesOperationEnabled

boolean

optional

This field checks if fee operation is enabled or not.

Default:

false

Example:

true

config

object (CardConfigModel)

optional

This object is a collection of configuration fields including both Point of Interest and Velocity
Control fields. It contains sub-fields explained in the rows below.

poi

object (CardPoi)

required

This object is a collection of Point of Interest configuration fields showing where the card
issued under this card program can be used. It contains sub-fields explained in the rows below.

velocityControls

object (VelocityControlConfigModel)

required

This object is a collection of velocity control fields that defines the frequency of card's usage,
issued under this card program. It contains sub-fields explained in the rows below.

merchantControls

object (MerchantDetailModel)

required

🟠401Unauthorized

Modified at 2025-06-27 12:44:57

Card Program

Get Card Program