SimpliFi
HomeContact Us
HomeContact Us
  1. Webhook
  • 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
      GET
    • Create a webhook
      POST
    • Update a Webhook
      PUT
    • Delete a Webhook
      DELETE
    • Updates the status of Webhook
      PUT
  1. Webhook

Create a webhook

POST
https://{{env}}-lb.simplifipay.com/v1/webhook
Webhook
This endpoint allows you to create a webhook, where events will be posted
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'https://uat-lb.simplifipay.com/v1/webhook' \
--header 'requestUuid;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Card Status Change",
    "eventType": "CARD_ACTIVATION",
    "endpointUrl": "https://webhook.simplifipay.com",
    "extra": {
        "property1": "string",
        "property2": "string"
    }
}'
Response Response Example
{
    "uuid": "84503d40-93b1-4f1d-b265-41553528a028",
    "name": "Card Status Change",
    "eventType": "CARD_ACTIVATION",
    "status": "ENABLED",
    "endpointUrl": "https://webhook.simplifipay.com",
    "creationDate": "2025-02-28 13:31:00",
    "lastModified": "2025-02-28 13:31:00"
}

Request

Authorization
JWT
Add the parameter
Authorization
to Headers
Example:
Authorization: ********************
or
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
Body Params application/json
name
string 
required
A name to uniquely identify the webhook.
Example:
Card Status Change
eventType
enum<string> 
required
Allowed values:
CARD_ACTIVATIONCARD_ISSUANCECARD_PIN_SETUPCARD_RENEWEDCARD_STATUS_CHANGECARD_TYPE_CHANGECARD_RULE_GROUP_CREATIONCARD_RULE_GROUP_DELETIONCARD_LOADCARD_UNLOADCARD_TO_CARD_TRANSFERCARD_HOLDER_CREATIONCARD_HOLDER_UPDATIONCARD_HOLDER_DELETIONCARD_PROGRAM_CREATIONWALLET_RULE_GROUP_CREATIONWALLET_RULE_GROUP_DELETIONFUNDS_TRANSFERRAISE_FUNDING_SOURCERULE_GROUP_CREATIONRULE_GROUP_UPDATIONRULE_GROUP_DELETIONTRANSACTIONTRANSACTION_ENRICHMENTFEES_APPLY
endpointUrl
string 
required
The endpoint URL hosted by you where webhooks will be sent.
Example:
https://webhook.simplifipay.com
extra
object 
optional
A key-value pair of any extra header to be sent when calling the endpoitnUrl.
Additional properties
string 
optional
Examples

Responses

🟢200OK
application/json
OK
Body
uuid
string 
required
Unique identifier of the webhook.
Example:
84503d40-93b1-4f1d-b265-41553528a028
name
string 
required
A name to uniquely identify the webhook.
Example:
Card Status Change
eventType
enum<string> 
required
Allowed values:
CARD_ACTIVATIONCARD_ISSUANCECARD_PIN_SETUPCARD_RENEWEDCARD_STATUS_CHANGECARD_TYPE_CHANGECARD_RULE_GROUP_CREATIONCARD_RULE_GROUP_DELETIONCARD_LOADCARD_UNLOADCARD_TO_CARD_TRANSFERCARD_HOLDER_CREATIONCARD_HOLDER_UPDATIONCARD_HOLDER_DELETIONCARD_PROGRAM_CREATIONWALLET_RULE_GROUP_CREATIONWALLET_RULE_GROUP_DELETIONFUNDS_TRANSFERRAISE_FUNDING_SOURCERULE_GROUP_CREATIONRULE_GROUP_UPDATIONRULE_GROUP_DELETIONTRANSACTIONTRANSACTION_ENRICHMENTFEES_APPLY
status
enum<string> 
required
Current status of the webhook
Allowed values:
ENABLEDDISABLED
Example:
ENABLED
endpointUrl
string 
required
The endpoint URL hosted by you where webhooks will be sent.
Example:
https://webhook.simplifipay.com
creationDate
string <date-time>
required
Example:
2025-02-28 13:31:00
lastModified
string <date-time>
required
Example:
2025-02-28 13:31:00
🟠401Unauthorized
Modified at 2025-06-27 12:44:57
Previous
Get all events
Next
Update a Webhook
Built with