# SimpliFi - Bayzat ## Docs - [Introduction](https://bayzat-docs.simplifipay.com/introduction-2032071m0.md): - [SimpliFi Architecture](https://bayzat-docs.simplifipay.com/simplifi-architecture-2032073m0.md): - [SimpliFi Virtual Card SDK Integration Guide](https://bayzat-docs.simplifipay.com/simplifi-virtual-card-sdk-integration-guide-2046977m0.md): ## API Docs - Auth [Login to generate JWT token](https://bayzat-docs.simplifipay.com/login-to-generate-jwt-token-31439162e0.md): The Login endpoint allows you to login to the SimpliFi platform using the provided - Card Program [Create Card Program](https://bayzat-docs.simplifipay.com/create-card-program-31439163e0.md): The Create Card Program endpoint allows API users to create a new card program - Card Program [Get Card Program](https://bayzat-docs.simplifipay.com/get-card-program-31439164e0.md): The Get Card Program endpoint retrieves details about a card program. - Card Program [Change Card Program Status](https://bayzat-docs.simplifipay.com/change-card-program-status-31439165e0.md): The Change Card Program Status endpoint changes the status of a card program. This endpoint is helpful - Card Program [Link Funding Source to Card Program](https://bayzat-docs.simplifipay.com/link-funding-source-to-card-program-31439166e0.md): The Link Funding Source to Card Program endpoint links a funding source to a card program. - Card Program [Get Balance of Funding Source](https://bayzat-docs.simplifipay.com/get-balance-of-funding-source-31439167e0.md): The Get Balance of Funding Source endpoint retrieves the remaining balance of a funding source. - Card Program [Raise Funding](https://bayzat-docs.simplifipay.com/raise-funding-31439168e0.md): The Raise Funding endpoint helps in adding or removing funds from a funding source. This API doesn't - Card Program [Raise Funding Document Upload](https://bayzat-docs.simplifipay.com/raise-funding-document-upload-31439169e0.md): This API should be called before calling Raise Funding API to attach `Proof of funds / Confirmation of - User [Upload Document](https://bayzat-docs.simplifipay.com/upload-document-31439170e0.md): The Upload Document endpoint uploads the user documents to the SimpliFi system which are required - User [List all Users](https://bayzat-docs.simplifipay.com/list-all-users-31439171e0.md): The List all Users endpoint retrieves all the existing users, grouped under a company. - User [Create a User](https://bayzat-docs.simplifipay.com/create-a-user-31439172e0.md): The Create a User endpoint creates a new user. In the SimpliFi platform, it is mandatory - User [Retrieve a User](https://bayzat-docs.simplifipay.com/retrieve-a-user-31439173e0.md): The Retrieve a User endpoint retrieves details about an existing user. - User [Update a User](https://bayzat-docs.simplifipay.com/update-a-user-31439174e0.md): The Update a User endpoint updates the details of an existing user. - User [Delete a User](https://bayzat-docs.simplifipay.com/delete-a-user-31439175e0.md): The Delete a User endpoint deletes an existing user. Deleting a user does not erase data from the - Transaction [List All Transactions](https://bayzat-docs.simplifipay.com/list-all-transactions-31439176e0.md): The List All Transactions endpoint retrieves a paginated array of all the transactions carried - Card [List all Cards](https://bayzat-docs.simplifipay.com/list-all-cards-31439177e0.md): The List all Cards endpoint retrieves all the existing cards, grouped under a company. - Card [Create a Card](https://bayzat-docs.simplifipay.com/create-a-card-31439178e0.md): The Create a Card endpoint creates/issues a card to a user under a Card Program. The card issued - Card [Get Card Details](https://bayzat-docs.simplifipay.com/get-card-details-31439179e0.md): The Get Card Details endpoint retrieves all the details of a specific card. - Card [Activate a Card](https://bayzat-docs.simplifipay.com/activate-a-card-31439180e0.md): The Activate a Card endpoint activates an issued/created card. - Card [Manage Card Status](https://bayzat-docs.simplifipay.com/manage-card-status-31439181e0.md): The Manage Card Status endpoint manages the status of a card. This endpoint is helpful as - Card [Get Rule Groups on Card](https://bayzat-docs.simplifipay.com/get-rule-groups-on-card-31439182e0.md): This endpoint retrieves all the rule groups on a Card. - Card [Create Rule Group on Card](https://bayzat-docs.simplifipay.com/create-rule-group-on-card-31439183e0.md): This endpoint creates a new rule group on a Card. - Card [Update Rule Group on Card](https://bayzat-docs.simplifipay.com/update-rule-group-on-card-31439184e0.md): This endpoint updates an existing rule group on a Card. - Webhook [Get all events](https://bayzat-docs.simplifipay.com/get-all-events-31439185e0.md): This endpoint fetches all available events for webhooks - Webhook [Create a webhook](https://bayzat-docs.simplifipay.com/create-a-webhook-31439186e0.md): This endpoint allows you to create a webhook, where events will be posted - Webhook [Update a Webhook](https://bayzat-docs.simplifipay.com/update-a-webhook-31439187e0.md): This endpoint allows you to update an existing webhook - Webhook [Delete a Webhook](https://bayzat-docs.simplifipay.com/delete-a-webhook-31439188e0.md): This endpoint allows you to delete an existing webhook - Webhook [Updates the status of Webhook](https://bayzat-docs.simplifipay.com/updates-the-status-of-webhook-31439189e0.md): This endpoint allows you to update the status of an existing webhook - Webhook [Card Holder Creation Success webhook](https://bayzat-docs.simplifipay.com/card-holder-creation-success-webhook-31439190e0.md): When card holder creation is a success, `eventPayload` will have all the required values. - Webhook [Card Holder Update Success webhook](https://bayzat-docs.simplifipay.com/card-holder-update-success-webhook-31439191e0.md): When card holder update is a success, `eventPayload` will have all the required values. - Webhook [Card Holder Deletion Success webhook](https://bayzat-docs.simplifipay.com/card-holder-deletion-success-webhook-31439192e0.md): When card holder delete is a success, `eventPayload` will have all the required values. - Webhook [Card Program Creation Success webhook](https://bayzat-docs.simplifipay.com/card-program-creation-success-webhook-31439193e0.md): When card program create is a success, `eventPayload` will have all the required values. - Webhook [Card Program Update Success webhook](https://bayzat-docs.simplifipay.com/card-program-update-success-webhook-31439194e0.md): When card program update is a success, `eventPayload` will have all the required values. - Webhook [Card Program Status Change Success webhook](https://bayzat-docs.simplifipay.com/card-program-status-change-success-webhook-31439195e0.md): When card program status change is a success, `eventPayload` will have all the required values. - Webhook [Raise Funding Success webhook](https://bayzat-docs.simplifipay.com/raise-funding-success-webhook-31439196e0.md): When raise funding is a success, `eventPayload` will have all the required values. - Webhook [Card Activation Success webhook](https://bayzat-docs.simplifipay.com/card-activation-success-webhook-31439197e0.md): - Webhook [Card Activation Failure webhook](https://bayzat-docs.simplifipay.com/card-activation-failure-webhook-31439198e0.md): - Webhook [Card Issuance Success webhook](https://bayzat-docs.simplifipay.com/card-issuance-success-webhook-31439199e0.md): When card issuance is a success, `eventPayload` will have all the required values. - Webhook [Card Issuance Failure webhook](https://bayzat-docs.simplifipay.com/card-issuance-failure-webhook-31439200e0.md): In case card issuance had a failure, error fields will be populated, - Webhook [Card Status Change Success webhook](https://bayzat-docs.simplifipay.com/card-status-change-success-webhook-31439201e0.md): When card status change is a success, `eventPayload` will have all the required values. - Webhook [Rule Group Creation Success webhook](https://bayzat-docs.simplifipay.com/rule-group-creation-success-webhook-31439202e0.md): When rule group create is a success, `eventPayload` will have all the required values. - Webhook [Rule Group Update Success webhook](https://bayzat-docs.simplifipay.com/rule-group-update-success-webhook-31439203e0.md): When rule group update is a success, `eventPayload` will have all the required values. - Webhook [Rule Group Delete Success webhook](https://bayzat-docs.simplifipay.com/rule-group-delete-success-webhook-31439204e0.md): When rule group delete is a success, `eventPayload` will have all the required values. - Webhook [Transaction Success webhook](https://bayzat-docs.simplifipay.com/transaction-success-webhook-31444929e0.md): When transaction is a success or failure, `eventPayload` will have all the required values. ## Schemas - [ErrorModel](https://bayzat-docs.simplifipay.com/errormodel-13734962d0.md): - [AuthRequestModel](https://bayzat-docs.simplifipay.com/authrequestmodel-13594999d0.md): - [AuthResponseModel](https://bayzat-docs.simplifipay.com/authresponsemodel-13595000d0.md): - [CardProgramRequestModel](https://bayzat-docs.simplifipay.com/cardprogramrequestmodel-13595001d0.md): - [CardProgramResponseModel](https://bayzat-docs.simplifipay.com/cardprogramresponsemodel-13595002d0.md): - [CardProgramStatusChangeRequestModel](https://bayzat-docs.simplifipay.com/cardprogramstatuschangerequestmodel-13595003d0.md): - [FundingSourceRequestModel](https://bayzat-docs.simplifipay.com/fundingsourcerequestmodel-13595004d0.md): - [FundingSourceResponseModel](https://bayzat-docs.simplifipay.com/fundingsourceresponsemodel-13595005d0.md): - [FundingSourceBalanceModel](https://bayzat-docs.simplifipay.com/fundingsourcebalancemodel-13595006d0.md): - [RaiseFundingRequestModel](https://bayzat-docs.simplifipay.com/raisefundingrequestmodel-13595007d0.md): - [RaiseFundingResponseModel](https://bayzat-docs.simplifipay.com/raisefundingresponsemodel-13595008d0.md): - [RaiseFundingDocumentModel](https://bayzat-docs.simplifipay.com/raisefundingdocumentmodel-13595009d0.md): - [FileUploadModel](https://bayzat-docs.simplifipay.com/fileuploadmodel-13595010d0.md): - [DocumentUploadModel](https://bayzat-docs.simplifipay.com/documentuploadmodel-13595011d0.md): - [DocumentModel](https://bayzat-docs.simplifipay.com/documentmodel-13595012d0.md): - [TransactionRequestModel](https://bayzat-docs.simplifipay.com/transactionrequestmodel-13595013d0.md): - [TransactionResponse](https://bayzat-docs.simplifipay.com/transactionresponse-13595014d0.md): - [TransactionResponseDetails](https://bayzat-docs.simplifipay.com/transactionresponsedetails-13595015d0.md): - [UserDetailModel](https://bayzat-docs.simplifipay.com/userdetailmodel-13595016d0.md): - [ContactModel](https://bayzat-docs.simplifipay.com/contactmodel-13595017d0.md): - [UserRequestModel](https://bayzat-docs.simplifipay.com/userrequestmodel-13595018d0.md): - [UserModel](https://bayzat-docs.simplifipay.com/usermodel-13595019d0.md): - [InstrumentType](https://bayzat-docs.simplifipay.com/instrumenttype-13595020d0.md): - [CardRequestModel](https://bayzat-docs.simplifipay.com/cardrequestmodel-13595021d0.md): - [CardResponseModel](https://bayzat-docs.simplifipay.com/cardresponsemodel-13595022d0.md): - [CardStatusModel](https://bayzat-docs.simplifipay.com/cardstatusmodel-13595023d0.md): - [RuleGroupResponseModel](https://bayzat-docs.simplifipay.com/rulegroupresponsemodel-13595024d0.md): - [RuleGroupModel](https://bayzat-docs.simplifipay.com/rulegroupmodel-13595025d0.md): - [RuleGroupSpendRestrictions](https://bayzat-docs.simplifipay.com/rulegroupspendrestrictions-13595026d0.md): - [WebhookEventType](https://bayzat-docs.simplifipay.com/webhookeventtype-13595027d0.md): - [WebhookEventModel](https://bayzat-docs.simplifipay.com/webhookeventmodel-13595028d0.md): - [WebhookRequestModel](https://bayzat-docs.simplifipay.com/webhookrequestmodel-13595029d0.md): - [WebhookResponseModel](https://bayzat-docs.simplifipay.com/webhookresponsemodel-13595030d0.md): - [CompanyUuidParameter](https://bayzat-docs.simplifipay.com/companyuuidparameter-13595031d0.md): - [RequestUuidParameter](https://bayzat-docs.simplifipay.com/requestuuidparameter-13595032d0.md): - [UserUuidParameter](https://bayzat-docs.simplifipay.com/useruuidparameter-13595033d0.md): - [CardUuidParameter](https://bayzat-docs.simplifipay.com/carduuidparameter-13595034d0.md): - [MaskedPanParameter](https://bayzat-docs.simplifipay.com/maskedpanparameter-13595035d0.md): - [CardStatusParameter](https://bayzat-docs.simplifipay.com/cardstatusparameter-13595036d0.md): - [TransactionIdParameter](https://bayzat-docs.simplifipay.com/transactionidparameter-13595037d0.md): - [TransactionUuidParameter](https://bayzat-docs.simplifipay.com/transactionuuidparameter-13595038d0.md): - [TransactionTypeParameter](https://bayzat-docs.simplifipay.com/transactiontypeparameter-13595039d0.md): - [WebhookSuccess](https://bayzat-docs.simplifipay.com/webhooksuccess-13595040d0.md): - [Error40089](https://bayzat-docs.simplifipay.com/error40089-13597149d0.md): - [WebhookFailure](https://bayzat-docs.simplifipay.com/webhookfailure-13595041d0.md): - [Error30003](https://bayzat-docs.simplifipay.com/error30003-13597150d0.md): - [CardActivationSuccessWebhook](https://bayzat-docs.simplifipay.com/cardactivationsuccesswebhook-13595042d0.md): - [UserSuccessWebhook](https://bayzat-docs.simplifipay.com/usersuccesswebhook-13734963d0.md): - [CardActivationFailureWebhook](https://bayzat-docs.simplifipay.com/cardactivationfailurewebhook-13595043d0.md): - [CardHolderCreationSuccessWebhook](https://bayzat-docs.simplifipay.com/cardholdercreationsuccesswebhook-13734964d0.md): - [CardIssuanceSuccessWebhook](https://bayzat-docs.simplifipay.com/cardissuancesuccesswebhook-13595044d0.md): - [CardHolderUpdationSuccessWebhook](https://bayzat-docs.simplifipay.com/cardholderupdationsuccesswebhook-13734965d0.md): - [CardIssuanceFailureWebhook](https://bayzat-docs.simplifipay.com/cardissuancefailurewebhook-13595045d0.md): - [CardHolderDeletionSuccessWebhook](https://bayzat-docs.simplifipay.com/cardholderdeletionsuccesswebhook-13734966d0.md): - [CardProgramSuccessWebhook](https://bayzat-docs.simplifipay.com/cardprogramsuccesswebhook-13734967d0.md): - [CardProgramCreationSuccessWebhook](https://bayzat-docs.simplifipay.com/cardprogramcreationsuccesswebhook-13734968d0.md): - [CardProgramUpdationSuccessWebhook](https://bayzat-docs.simplifipay.com/cardprogramupdationsuccesswebhook-13734969d0.md): - [CardProgramStatusChangeSuccessWebhook](https://bayzat-docs.simplifipay.com/cardprogramstatuschangesuccesswebhook-13734970d0.md): - [RaiseFundingSuccessWebhook](https://bayzat-docs.simplifipay.com/raisefundingsuccesswebhook-13734971d0.md): - [CardStatusChangeSuccessWebhook](https://bayzat-docs.simplifipay.com/cardstatuschangesuccesswebhook-13734972d0.md): - [RuleGroupCreationWebhook](https://bayzat-docs.simplifipay.com/rulegroupcreationwebhook-13734973d0.md): - [RuleGroupCreationSuccessWebhook](https://bayzat-docs.simplifipay.com/rulegroupcreationsuccesswebhook-13734974d0.md): - [RuleGroupUpdationSuccessWebhook](https://bayzat-docs.simplifipay.com/rulegroupupdationsuccesswebhook-13734975d0.md): - [RuleGroupDeletionSuccessWebhook](https://bayzat-docs.simplifipay.com/rulegroupdeletionsuccesswebhook-13734976d0.md): - [Error99997](https://bayzat-docs.simplifipay.com/error99997-13734977d0.md): - [TransactionSuccessWebhook](https://bayzat-docs.simplifipay.com/transactionsuccesswebhook-13735990d0.md): - [Error40065](https://bayzat-docs.simplifipay.com/error40065-13734978d0.md): - [Error40007](https://bayzat-docs.simplifipay.com/error40007-13734979d0.md): - [Error40056](https://bayzat-docs.simplifipay.com/error40056-13734980d0.md): - [Error15017](https://bayzat-docs.simplifipay.com/error15017-13734981d0.md): - [Error40081](https://bayzat-docs.simplifipay.com/error40081-13734982d0.md): - [Error30022](https://bayzat-docs.simplifipay.com/error30022-13734983d0.md): - [Error15015](https://bayzat-docs.simplifipay.com/error15015-13734984d0.md): - [Error15016](https://bayzat-docs.simplifipay.com/error15016-13734985d0.md): - [Error30049](https://bayzat-docs.simplifipay.com/error30049-13734986d0.md): - [Error40006](https://bayzat-docs.simplifipay.com/error40006-13734987d0.md): - [Error40010](https://bayzat-docs.simplifipay.com/error40010-13734988d0.md): - [Error40080](https://bayzat-docs.simplifipay.com/error40080-13734989d0.md): - [Error40053](https://bayzat-docs.simplifipay.com/error40053-13734990d0.md): - [Error40113](https://bayzat-docs.simplifipay.com/error40113-13734991d0.md): - [Error40067](https://bayzat-docs.simplifipay.com/error40067-13734992d0.md): - [Error40069](https://bayzat-docs.simplifipay.com/error40069-13734993d0.md): - [Error50010](https://bayzat-docs.simplifipay.com/error50010-13734994d0.md): - [Error50011](https://bayzat-docs.simplifipay.com/error50011-13734995d0.md): - [Error50008](https://bayzat-docs.simplifipay.com/error50008-13734996d0.md): - [Error50004](https://bayzat-docs.simplifipay.com/error50004-13734997d0.md): - [Error10003](https://bayzat-docs.simplifipay.com/error10003-13734998d0.md): - [Error20046](https://bayzat-docs.simplifipay.com/error20046-13734999d0.md): - [Error35004](https://bayzat-docs.simplifipay.com/error35004-13735000d0.md): - [Error35005](https://bayzat-docs.simplifipay.com/error35005-13735001d0.md): - [Error35006](https://bayzat-docs.simplifipay.com/error35006-13735002d0.md): - [Error35007](https://bayzat-docs.simplifipay.com/error35007-13735003d0.md): - [Error35009](https://bayzat-docs.simplifipay.com/error35009-13735004d0.md): - [Error10001](https://bayzat-docs.simplifipay.com/error10001-13735005d0.md): - [Error20133](https://bayzat-docs.simplifipay.com/error20133-13735006d0.md): - [Error20017](https://bayzat-docs.simplifipay.com/error20017-13735007d0.md): - [Error20001](https://bayzat-docs.simplifipay.com/error20001-13735008d0.md): - [Error20005](https://bayzat-docs.simplifipay.com/error20005-13735009d0.md): - [Error20039](https://bayzat-docs.simplifipay.com/error20039-13735010d0.md): - [Error20011](https://bayzat-docs.simplifipay.com/error20011-13735011d0.md): - [Error20038](https://bayzat-docs.simplifipay.com/error20038-13735012d0.md): - [Error20127](https://bayzat-docs.simplifipay.com/error20127-13735013d0.md): - [Error20018](https://bayzat-docs.simplifipay.com/error20018-13735014d0.md): - [Error20002](https://bayzat-docs.simplifipay.com/error20002-13735015d0.md): - [Error20004](https://bayzat-docs.simplifipay.com/error20004-13735016d0.md): - [Error20006](https://bayzat-docs.simplifipay.com/error20006-13735017d0.md): - [Error20032](https://bayzat-docs.simplifipay.com/error20032-13735018d0.md): - [Error30012](https://bayzat-docs.simplifipay.com/error30012-13735019d0.md): - [Error20086](https://bayzat-docs.simplifipay.com/error20086-13735020d0.md): - [Error20019](https://bayzat-docs.simplifipay.com/error20019-13735021d0.md): - [Error20132](https://bayzat-docs.simplifipay.com/error20132-13735022d0.md): - [Error20008](https://bayzat-docs.simplifipay.com/error20008-13735023d0.md): - [Error40054](https://bayzat-docs.simplifipay.com/error40054-13735024d0.md): - [Error20015](https://bayzat-docs.simplifipay.com/error20015-13735025d0.md): - [Error20074](https://bayzat-docs.simplifipay.com/error20074-13735026d0.md): - [Error21090](https://bayzat-docs.simplifipay.com/error21090-13735027d0.md): - [Error20161](https://bayzat-docs.simplifipay.com/error20161-13735028d0.md): - [Error20162](https://bayzat-docs.simplifipay.com/error20162-13735029d0.md): - [Error20089](https://bayzat-docs.simplifipay.com/error20089-13735030d0.md): - [Error20076](https://bayzat-docs.simplifipay.com/error20076-13735031d0.md): - [Error30023](https://bayzat-docs.simplifipay.com/error30023-13735032d0.md): - [Error30013](https://bayzat-docs.simplifipay.com/error30013-13735033d0.md): - [Error20087](https://bayzat-docs.simplifipay.com/error20087-13735034d0.md): - [Error30028](https://bayzat-docs.simplifipay.com/error30028-13735035d0.md): - [Error20070](https://bayzat-docs.simplifipay.com/error20070-13735036d0.md): - [Error20050](https://bayzat-docs.simplifipay.com/error20050-13735037d0.md): - [Error82028](https://bayzat-docs.simplifipay.com/error82028-13735038d0.md): - [Error30004](https://bayzat-docs.simplifipay.com/error30004-13735039d0.md): - [Error30044](https://bayzat-docs.simplifipay.com/error30044-13735040d0.md): - [Error30001](https://bayzat-docs.simplifipay.com/error30001-13735041d0.md): - [Error30006](https://bayzat-docs.simplifipay.com/error30006-13735042d0.md): - [Error30048](https://bayzat-docs.simplifipay.com/error30048-13735043d0.md): - [Error30024](https://bayzat-docs.simplifipay.com/error30024-13735044d0.md): - [Error35043](https://bayzat-docs.simplifipay.com/error35043-13735045d0.md): - [Error30025](https://bayzat-docs.simplifipay.com/error30025-13735046d0.md): - [Error30010](https://bayzat-docs.simplifipay.com/error30010-13735047d0.md): - [Error30047](https://bayzat-docs.simplifipay.com/error30047-13735048d0.md): - [ErrorReason99997](https://bayzat-docs.simplifipay.com/errorreason99997-13735049d0.md): - [Error81040](https://bayzat-docs.simplifipay.com/error81040-13735050d0.md): - [Error40128](https://bayzat-docs.simplifipay.com/error40128-13735051d0.md): - [Error40136](https://bayzat-docs.simplifipay.com/error40136-13735052d0.md): - [Error10035](https://bayzat-docs.simplifipay.com/error10035-13735053d0.md): - [Error35024](https://bayzat-docs.simplifipay.com/error35024-13735054d0.md): - [Error60001](https://bayzat-docs.simplifipay.com/error60001-13735055d0.md): - [Error60002](https://bayzat-docs.simplifipay.com/error60002-13735056d0.md): - [Error60003](https://bayzat-docs.simplifipay.com/error60003-13735057d0.md): - [Error60004](https://bayzat-docs.simplifipay.com/error60004-13735058d0.md): - [Error60005](https://bayzat-docs.simplifipay.com/error60005-13735059d0.md): - [Error60021](https://bayzat-docs.simplifipay.com/error60021-13735060d0.md): - [Error60012](https://bayzat-docs.simplifipay.com/error60012-13735061d0.md): - [Error60009](https://bayzat-docs.simplifipay.com/error60009-13735062d0.md):