List all Cards

GET

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

Card

The List all Cards endpoint retrieves all the existing cards, grouped under a company.
Following are the properties of this endpoint.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://uat-lb.simplifipay.com/v1/card' \
--header 'requestUuid;'

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

Example:

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

Query Params

startDate

string <date>

optional

Represents the start date of the user's registration with the SimpliFi system. Note All the
dates in the SimpliFi system are stored and displayed in the following format yyyy-mm-dd hh:mm:ss

Example:

2025-02-28

endDate

string <date>

optional

Represents the end date of the user's registration with the SimpliFi system. Note All the
dates in the SimpliFi system are stored and displayed in the following format yyyy-mm-dd hh:mm:ss

Example:

2025-02-28

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

Body

array of:

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

Card

Create a Card