SimpliFi - Bayzat
HomeContact Us
HomeContact Us
    • Introduction
    • SimpliFi Architecture
    • SimpliFi Virtual Card SDK Integration Guide
    • 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
      • Raise Funding
        POST
      • Raise Funding Document Upload
        POST
    • User
      • Upload Document
        POST
      • List all Users
        GET
      • Create a User
        POST
      • Retrieve a User
        GET
      • Update a User
        PUT
      • Delete a User
        DELETE
    • Transaction
      • List All Transactions
        POST
    • Card
      • List all Cards
        GET
      • Create a Card
        POST
      • Get Card Details
        GET
      • Activate a Card
        POST
      • Manage Card Status
        POST
      • Get Rule Groups on Card
        GET
      • Create Rule Group on Card
        POST
      • Update Rule Group on Card
        PUT
    • Webhook
      • Get all events
      • Create a webhook
      • Update a Webhook
      • Delete a Webhook
      • Updates the status of Webhook
      • Card Holder Creation Success webhook
      • Card Holder Update Success webhook
      • Card Holder Deletion Success webhook
      • Card Program Creation Success webhook
      • Card Program Update Success webhook
      • Card Program Status Change Success webhook
      • Raise Funding Success webhook
      • Card Activation Success webhook
      • Card Activation Failure webhook
      • Card Issuance Success webhook
      • Card Issuance Failure webhook
      • Card Status Change Success webhook
      • Rule Group Creation Success webhook
      • Rule Group Update Success webhook
      • Rule Group Delete Success webhook
      • Transaction Success webhook
    • Schemas
      • ErrorModel
      • AuthRequestModel
      • AuthResponseModel
      • CardProgramRequestModel
      • CardProgramResponseModel
      • CardProgramStatusChangeRequestModel
      • FundingSourceRequestModel
      • FundingSourceResponseModel
      • FundingSourceBalanceModel
      • RaiseFundingRequestModel
      • RaiseFundingResponseModel
      • RaiseFundingDocumentModel
      • FileUploadModel
      • DocumentUploadModel
      • DocumentModel
      • TransactionRequestModel
      • TransactionResponse
      • TransactionResponseDetails
      • UserDetailModel
      • ContactModel
      • UserRequestModel
      • UserModel
      • InstrumentType
      • CardRequestModel
      • CardResponseModel
      • CardStatusModel
      • RuleGroupResponseModel
      • RuleGroupModel
      • RuleGroupSpendRestrictions
      • WebhookEventType
      • WebhookEventModel
      • WebhookRequestModel
      • WebhookResponseModel
      • CompanyUuidParameter
      • RequestUuidParameter
      • UserUuidParameter
      • CardUuidParameter
      • MaskedPanParameter
      • CardStatusParameter
      • TransactionIdParameter
      • TransactionUuidParameter
      • TransactionTypeParameter
      • WebhookSuccess
      • Error40089
      • WebhookFailure
      • Error30003
      • CardActivationSuccessWebhook
      • UserSuccessWebhook
      • CardActivationFailureWebhook
      • CardHolderCreationSuccessWebhook
      • CardIssuanceSuccessWebhook
      • CardHolderUpdationSuccessWebhook
      • CardIssuanceFailureWebhook
      • CardHolderDeletionSuccessWebhook
      • CardProgramSuccessWebhook
      • CardProgramCreationSuccessWebhook
      • CardProgramUpdationSuccessWebhook
      • CardProgramStatusChangeSuccessWebhook
      • RaiseFundingSuccessWebhook
      • CardStatusChangeSuccessWebhook
      • RuleGroupCreationWebhook
      • RuleGroupCreationSuccessWebhook
      • RuleGroupUpdationSuccessWebhook
      • RuleGroupDeletionSuccessWebhook
      • Error99997
      • TransactionSuccessWebhook
      • Error40065
      • Error40007
      • Error40056
      • Error15017
      • Error40081
      • Error30022
      • Error15015
      • Error15016
      • Error30049
      • Error40006
      • Error40010
      • Error40080
      • Error40053
      • Error40113
      • Error40067
      • Error40069
      • Error50010
      • Error50011
      • Error50008
      • Error50004
      • Error10003
      • Error20046
      • Error35004
      • Error35005
      • Error35006
      • Error35007
      • Error35009
      • Error10001
      • Error20133
      • Error20017
      • Error20001
      • Error20005
      • Error20039
      • Error20011
      • Error20038
      • Error20127
      • Error20018
      • Error20002
      • Error20004
      • Error20006
      • Error20032
      • Error30012
      • Error20086
      • Error20019
      • Error20132
      • Error20008
      • Error40054
      • Error20015
      • Error20074
      • Error21090
      • Error20161
      • Error20162
      • Error20089
      • Error20076
      • Error30023
      • Error30013
      • Error20087
      • Error30028
      • Error20070
      • Error20050
      • Error82028
      • Error30004
      • Error30044
      • Error30001
      • Error30006
      • Error30048
      • Error30024
      • Error35043
      • Error30025
      • Error30010
      • Error30047
      • ErrorReason99997
      • Error81040
      • Error40128
      • Error40136
      • Error10035
      • Error35024
      • Error60001
      • Error60002
      • Error60003
      • Error60004
      • Error60005
      • Error60021
      • Error60012
      • Error60009

    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).
    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 50+ 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.
    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 2026-03-17 11:15:11
    Previous
    Introduction
    Next
    SimpliFi Virtual Card SDK Integration Guide
    Built with