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
      • Card Activation webhook
      • Card Issuance webhook
      • Card PIN Setup webhook
      • Card Renewed webhook
      • Card Status Change webhook
      • Card Type Change webhook
      • Card Load webhook
      • Card Unload webhook
      • Card Unload webhook
      • User creation webhook
      • User updation webhook
      • User deletion webhook
      • Card Program Creation webhook
      • Funds transfer webhook
      • Raise funding webhook
      • Transaction webhook
      • Transaction Enrichment webhook
      • Fees apply webhook
      • Rule group creation webhook
      • Rule group updation webhook
      • Rule group deletion webhook
      • Wallet rule group creation webhook
      • Wallet rule group deletion webhook
      • Card rule group creation webhook
      • Card rule group deletion webhook
    • Schemas
      • Schemas
        • InstrumentType
        • ErrorModel
        • UserRequestModel
        • AddressModel
        • ContactModel
        • AuthRequestModel
        • UserDetailModel
        • AuthResponseModel
        • UserModel
        • DocumentUploadModel
        • MerchantModel
        • FundingSourceResponseModel
        • FundingSourceRequestModel
        • RaiseFundingDocumentModel
        • CardConfigModel
        • CardPoi
        • CardProgramRequestModel
        • CardAmountModel
        • FeesApplicationCardRequest
        • FeeApplicationEventResponse
        • StatementResponse
        • MerchantDetailModel
        • MerchantListModel
        • VelocityControlConfigModel
        • StatementResponseDetails
        • VelocityControlDetailConfigModel
        • RuleGroupResponseModel
        • TransactionResponse
        • RuleGroupModel
        • TransactionResponseDetails
        • RuleGroupTransactionRestrictions
        • TransactionRequestModel
        • RuleGroupMerchantRules
        • FileUploadModel
        • RuleGroupLoadRestrictions
        • DocumentModel
        • RuleGroupSpendRestrictions
        • CardStatusModel
        • CardRenewalModel
        • ApplyFeesOnCardRequest
        • FeesStatusUpdateModel
        • FeesSetupModel
        • CardProgramTransferFundsModel
        • RaiseFundingRequestModel
        • Webhook
        • CardRequestModel
        • FeeConfigurationModel
        • CardResponseModel
        • CardStatementResponse
        • CardProgramStatusChangeRequestModel
        • CardProgramCreationWebhook
        • AmountModel
        • WebhookEventType
        • WebhookEventModel
        • WebhookRequestModel
        • WebhookResponseModel
        • CardActivationWebhook
        • FundingSourceBalanceModel
        • CompanyUuidParameter
        • CardIssuanceWebhook
        • RequestUuidParameter
        • CardPinSetupWebhook
        • UserUuidParameter
        • CardRenewedWebhook
        • CardUuidParameter
        • MaskedPanParameter
        • CardProgramResponseModel
        • CardStatusChangeWebhook
        • CardTypeChangeWebhook
        • CardStatusParameter
        • CardLoadWebhook
        • TransactionIdParameter
        • TransactionUuidParameter
        • CardUnloadWebhook
        • TransactionTypeParameter
        • CardToCardTransferWebhook
        • CardToHolderCreationWebhook
        • CardToHolderUpdationWebhook
        • CardToHolderDeletionWebhook
        • FundTransferWebhook
        • RaiseFundingWebhook
        • CardHolderCreationWebhook
        • TransactionWebhook
        • CardHolderUpdationWebhook
        • TransactionEnrichmentWebhook
        • CardHolderDeletionWebhook
        • FeesApplyWebhook
        • UserWebhook
        • RuleGroupCreationWebhook
        • RuleGroupUpdationWebhook
        • RuleGroupDeletionWebhook
        • WalletRuleGroupCreationWebhook
        • WalletRuleGroupDeletionWebhook
        • CardRuleGroupCreationWebhook
        • CardRuleGroupDeletionWebhook
      • Response
        • EntityNotFoundError

    Webhook

    All the asynchronous API calls that are made using the endpoints published by the SimpliFi platform, return a webhook. The purpose of these webhooks is to inform the API user about the status of the endpoint that was initiated.
    The webhook structure remains the same in all the asynchronously running API calls with the only difference in eventType field and eventPayload object. These two fields are unique for every webhook response. eventType describes the event for which the webhook was generated and eventPayload describes the payload for that event.
    Modified at 2025-06-26 08:42:05
    Previous
    Apply fee against card uuid present in queue
    Next
    Get all events
    Built with