SimpliFi
HomeContact Us
HomeContact Us
  1. Card
  • 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

Create a Card

POST
https://{{env}}-lb.simplifipay.com/v1/card
The Create a Card endpoint creates/issues a card to a user under a Card Program. The card issued
using this endpoint would inherit the characteristics defined in its card program such as
authorization controls, velocity controls etc. Following are the properties of this endpoint.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'https://uat-lb.simplifipay.com/v1/card' \
--header 'requestUuid;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "userUuid": "f5ba1741-983f-4f51-8375-701461c5bacc",
    "cardProgramUuid": "56db03b7-29ef-46e3-82ad-68b94abb051f",
    "customerTitle": "Founding Member",
    "instrument": "VIRTUAL"
}'
Response Response Example
{
    "uuid": "8105fb1b-852c-4d93-88eb-2fb2361d4b45",
    "userUuid": "7ace3a56-3cb1-44db-a81d-2735e54c7c15",
    "companyUuid": "10cdeb1d-c3af-4288-b770-5d7620171f37",
    "cardProgramUuid": "dfb04381-3a10-4185-9ed3-5a97f43dd1a2",
    "instrument": "VIRTUAL",
    "creationDate": "2025-02-28 13:31:00",
    "cardStatus": "PENDING",
    "expiryDate": "12/31",
    "maskedPan": "**********1234",
    "cardMode": "PRIMARY",
    "currency": "USD",
    "customerTitle": "Founding Member",
    "physicalCardUuid": "a1f65835-be50-450c-a197-8676aa4565d0",
    "linkedVirtualCardUuid": "86d3111d-6d55-45e0-91c1-32c1397f39ab"
}

Request

Authorization
JWT
Add the parameter
Authorization
to Headers，whose value is to concatenate the Token after the Bearer.
Example:
Authorization: Bearer ********************
or
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
userUuid
string 
required
This is a system-generated unique identifier of the user
that was created using the Create User API.
Example:
f5ba1741-983f-4f51-8375-701461c5bacc
cardProgramUuid
string 
optional
This is a system-generated unique identifier of the card program
that was created using the Create Card Program API.
Example:
56db03b7-29ef-46e3-82ad-68b94abb051f
customerTitle
string 
optional
This is a specific name for the user to be displayed on the card in addition
to the cardholder name. This field adds another layer of individuality and exclusivity
for the user. Also known as 4th line embossing.
Example:
Founding Member
instrument
enum<string> 
required
This field specifies the type of card that is being issued.
Allowed values:
VIRTUALPHYSICALVIRTUAL_AND_PHYSICAL
Example:
VIRTUAL
Examples

Responses

🟢200OK
application/json
OK
Body
uuid
string 
required
This is a system-generated unique identifier of the card issued.
Example:
8105fb1b-852c-4d93-88eb-2fb2361d4b45
userUuid
string 
required
This is a system-generated unique identifier of the user
that was created using the Create User API.
Example:
7ace3a56-3cb1-44db-a81d-2735e54c7c15
companyUuid
string 
required
This field contains a unique identifier of the company for which the card has been configured.
Example:
10cdeb1d-c3af-4288-b770-5d7620171f37
cardProgramUuid
string 
required
This is a system-generated unique identifier for the card program
that was created using the Create Card Program API.
Example:
dfb04381-3a10-4185-9ed3-5a97f43dd1a2
instrument
enum<string> 
required
This field specifies the type of card that is being issued.
Allowed values:
VIRTUALPHYSICALVIRTUAL_AND_PHYSICAL
Example:
VIRTUAL
creationDate
string <date-time>
required
This field contains the date on which the card was created.
Example:
2025-02-28 13:31:00
cardStatus
enum<string> 
required
This field contains the current status of the card.
Allowed values:
PENDINGISSUEDACTIVATEDDISABLEDLOCKEDREPLACEDREJECTEDEXPIRED
Example:
ISSUED
expiryDate
string 
optional
This field contains the expiry date of the card.
Example:
12/31
maskedPan
string 
required
This field contains the partially hidden Primary Account Number
i.e. all digits are masked, except for the last four ones.
Example:
**********1234
cardMode
enum<string> 
required
This field contains the mode of the card.
Allowed values:
PRIMARYSECONDARY
Example:
PRIMARY
currency
string 
required
This field contains the Primary currency of Card
Example:
USD
customerTitle
string 
optional
This field contains the fourth line embossing of the card.
Example:
Founding Member
physicalCardUuid
string 
optional
This is a system-generated unique identifier of the PHYSICAL card issued.
Example:
a1f65835-be50-450c-a197-8676aa4565d0
linkedVirtualCardUuid
string 
optional
This is a system-generated unique identifier of the linked VIRTUAL card.
Example:
86d3111d-6d55-45e0-91c1-32c1397f39ab
🟠401Unauthorized
Modified at 2025-06-27 12:44:57
Previous
List all Cards
Next
Get Card Details
Built with