SimpliFi
HomeContact Us
HomeContact Us
  1. Card Program
  • Introduction
  • SimpliFi Architecture
  • Webhooks
  • Auth
    • Login to generate JWT token
      POST
  • Card Program
    • Create Card Program
      POST
    • Get Card Program
      GET
    • Change Card Program Status
      PATCH
    • Link Funding Source to Card Program
      POST
    • Get Balance of Funding Source
      GET
    • Transfer funds from one Card Program to other
      POST
    • Raise Funding Document Upload
      POST
    • Raise Funding
      POST
    • Funding Source Statement
      GET
  • Funding Source
    • Create Rule Group on Funding Account
      POST
    • Update Rule Group on Funding Account
      PUT
    • Delete Rule Group on Funding Account
      DELETE
    • Get Rule Groups on Funding Account
      GET
    • Appply Rule Group on Funding Account
      POST
    • Remove Rule Group on Funding Account
      DELETE
  • Card
    • List all Cards
      GET
    • Create a Card
      POST
    • Get Card Details
      GET
    • Retrieve Balance on the Card
      GET
    • Activate a Card
      POST
    • Manage Card Status
      POST
    • Load a Card
      POST
    • Unload a Card
      POST
    • Renewal of the Card
      POST
    • Request a Physical Card
      POST
    • Get Card Statement
      GET
    • Apply rule group on card
      POST
    • Remove rule group on card
      DELETE
  • User
    • List all Users
    • Create a User
    • Upload Document
    • Retrieve a User
    • Update a User
    • Delete a User
  • Transaction
    • List All Transactions
  • Fee
    • Add fee configuration
    • Fetch fee config
    • Change the status of fee config
    • Add Fee event against card uuid in queue
    • Apply fee against card uuid present in queue
  • Webhook
    • Get all events
    • Create a webhook
    • Update a Webhook
    • Delete a Webhook
    • Updates the status of Webhook
  1. Card Program

Get Card Program

GET
https://{{env}}-lb.simplifipay.com/v1/card-program/{uuid}
The Get Card Program endpoint retrieves details about a card program.
Following are the properties of this endpoint.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://uat-lb.simplifipay.com/v1/card-program/' \
--header 'requestUuid;'
Response Response Example
200 - Example 1
{
    "uuid": "2143c065-a8af-4fd7-a839-17371f760e03",
    "name": "Marketing Budget",
    "companyUuid": "306182e4-c3e9-41d6-9184-de5bfec1fad1",
    "parentAccountId": "1234567",
    "productId": "0031",
    "fundingSourceUuid": "86bada5e-d67f-4efb-975f-4a20b86a5b13",
    "cardProgramStatus": "CREATED",
    "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"
                    }
                ]
            }
        }
    },
    "cardProgramTemplateUuid": "b13dc7ac-163b-49d1-b9e9-98ed7b73cccf",
    "walletThreshold": "100",
    "autoLoadAmount": "100",
    "currency": "AED",
    "feesOperationEnabled": false
}

Request

Authorization
JWT
Add the parameter
Authorization
to Headers，whose value is to concatenate the Token after the Bearer.
Example:
Authorization: Bearer ********************
or
Path Params
uuid
string 
required
This is a unique identifier for the program that was created using the Create Card Program API.
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

Responses

🟢200OK
application/json
OK
Body
uuid
string 
required
This is the unique identifier for the card program to which the card program belongs.
Example:
2143c065-a8af-4fd7-a839-17371f760e03
name
string 
required
This is the name of the card program.
Example:
Marketing Budget
companyUuid
string 
required
This is the unique identifier for the company to which the card program belongs.
Example:
306182e4-c3e9-41d6-9184-de5bfec1fad1
parentAccountId
string 
optional
Account ID associated with funding source
Example:
1234567
productId
string 
optional
Product ID associated with processor mapping
Example:
0031
fundingSourceUuid
string 
optional
This is a unique identifier of the funding source linked to this card program.
Example:
86bada5e-d67f-4efb-975f-4a20b86a5b13
cardProgramStatus
enum<string> 
required
This field specifies the status of the card program.
Allowed values:
CREATEDACTIVEINACTIVESUSPENDEDDEFAULT
Example:
ACTIVE
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.
cardProgramTemplateUuid
string 
required
This field contains the unique identifier of the card program template of this card program.
Example:
b13dc7ac-163b-49d1-b9e9-98ed7b73cccf
walletThreshold
number 
optional
load threshold
Example:
100
autoLoadAmount
number 
optional
auto load amount
Example:
100
currency
string 
optional
This field contains the currency of the card program.
Example:
AED
feesOperationEnabled
boolean 
optional
This field checks if fee operation is enabled or not.
Default:
false
Example:
true
🟠400Bad Request
🟠401Unauthorized
Modified at 2025-06-27 12:44:57
Previous
Create Card Program
Next
Change Card Program Status
Built with