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

    SimpliFi Architecture

    SimpliFi uses Async architecture to let the clients use its APIs in a modular set-up. Every API call made to SimpliFi would result in response code in the 2xx series, if the request was successfully received. Once the request is received it gets handled internally to get it processed.
    Once the request is processed, the response of the request is provided to the clients at their configurable endpoints through webhooks. Webhook body would provide appropriate values in case the request was completed as well as error codes in case the request resulted in failure.

    Understanding API Resources#

    CardProduct: This is the highest level of the resource hierarchy with-in SimpliFi platform. CardProduct are implemented at the partnering processors depending upon client requirements and approvals from regulatory bodies and schemes. CardProduct implementation once completed would return a CardProgramTemplateUUID which can be used to create card programs.
    Funding Source: Every client (or company i.e. client of SimpliFi client) would get a dedicated funding source in each approved currencies for CardProduct. One funding source can be linked with multiple Cards Products or Card Programs. Funding source is the Account number that is created to specifically run the card programs created under a Company.
    CardProgram: These are configured templates and define the unique use case per client. These can also be configured and provided dedicated names to identify unique company in case the SimpliFi client is not the end client issuing the cards to its customers. Any client can have multiple Card Program using the same template (product type) or different template (product type). CardProgram have below segments:
    CardTemplate: This aspect of CardProgram captures those variables which are expected not to change in the medium to long run. These variables include information like Issuing bank, currencies, card limits, Program type (corporate/consumer funded, corporate/consumer owned), Scheme, markets, fees etc.
    CardControl: SimpliFi provides a multi faceted control structure to its clients. Any number of card controls can be pre configured under a card product and can be accessed through APIs. These card controls can be applied at card group level as well as individual card level and can be changed during any time of the card lifecycle. It categorizes controls in to three broader flavors:
    Authorization control: Authorization controls define the channels on which the cards can be used. These are binary controls and can be configured to be either allowed or not-allowed. Channels could be Online Usage, POS Usage, ATM Usage, Cross Border, Cross currency usage, etc.
    Velocity Control: Velocity controls define usage in rolling windows across the channels. These are the settings which can be established at transaction, daily, weekly, monthly or any customized time period across channels. Any number of velocity controls can be pre configured and could be invoked using APIs.
    Merchant Control: Merchant controls are the third layer of the controls which provides a capability to put any of the merchant category (MCC ID) or Merchant ID in blocklist or allowlist. This is a powerful control which can be used to make any open loop card into restricted usage thus making it restricted loop cards.
    User: Users are cardholders to whom the cards would be issued. Users can be created using APIs. At the time of user creation; users are assigned under a card program. During card issuance for the users the cardprogram can be overwritten by providing a different card program as an input. If card program as an input during card issuance is not provided then the default card program used during user creation can be used.
    Card: These are payment cards which can be issued in virtual or physical form and can be used to conduct transactions. One user can have multiple cards.
    Wallet/Currency: SimpliFi supports multi currency environment. Currently the SimpliFi platform supports 7 currencies. If the card requires more than one currency on the card, a dedicated wallet would be created supporting each currency. Supported currencies are listed below.
    PCI DSS Compliant SDK: Both iOS and Android SDKs which can be wrapped under client App to enable cardholders access their card details on the app. The SDKs can be integrated using the integration document.
    Transactions: Transactions on SimpliFi platform could be accessed using two mechanisms:
    API: The API can be called to see all the transactions at Card, User or Card Program level. However this API would not be enough to update the client system with real time transactions.
    Webhook: To support clients update their system with real time transactions (which the card holders would be conducting outside of their system), SimpliFi would send the webhooks with all the transactional details.

    Supported Currencies#

    AED
    BHD
    SAR
    JOD
    KWD
    OMR
    QAR
    AUD
    CAD
    EUR
    GBP
    USD
    HKD

    Getting API Keys#

    To request API keys for the SimpliFi platform please place a request here. Once we receive your request we’d be able to send you:
    Client ID
    User ID
    Temporary Password
    Dummy funding source in USD currency
    CardProgramTemplateUUID
    You will be able to use the first three credentials to start testing APIs (or access SimpliFi Portal). You can use the dummy funding source to link it with the card programs you would have created. We would also be setting up a CardProgramTemplateUUID for you to start creating a card program.
    Modified at 2025-06-25 12:06:43
    Previous
    Introduction
    Next
    Webhooks
    Built with