Webhooks
Webhooks are used to notify about any event on your objects at LinkCy (consumers, corporates, ledgers, cards, ...).
These event can either be triggered by you (using the API) or by external events (incoming transaction for instance).
We use SVIX for managing these webhooks.
Step 1: Access Your SVIX Portal
To configure webhooks and manage endpoints, you must first have access to your SVIX portal.
Use the following API endpoint to retrieve the URL of your SVIX portal:
GET /api/partner/webhooksThis endpoint will return the URL where you can manage your webhooks in the SVIX portal.
Step 2: Configure Webhook Endpoints
Once you have accessed your SVIX portal:
- Navigate to the Endpoints section to add or modify your webhook destinations.
- For each endpoint, you will have the option to specify details such as the URL to receive payloads.
Important Notes
- Webhook Events: You can choose from a range of events, such as transaction status updates, new user sign-ups, and more.
- Security: SVIX handles webhook signing for enhanced security. Ensure you verify signatures to protect against unauthorized requests.
For any additional questions on configuring your SVIX portal or managing webhooks, please consult the SVIX documentation.
Webhook Catalog
There are differents type of webhooks. You can find the complete list of the different events below.
| Event type | Description |
|---|---|
| BENEFICIARY_CREATED | A beneficiary has been created |
| BENEFICIARY_UPDATED | A beneficiary status has been modified |
| CARD_CREATED | A Card has been created (except renew) |
| CARD_UPDATED | Card status is modified (suspended or unsuspended) |
| CARD_CLOSED | A Card is definitively closed |
| CONSUMER_CREATED | A Consumer has been created |
| CONSUMER_UPDATED | A Consumer has been modified (excepted KYC status) |
| CONSUMER_KYC_CREATED | KYC status moved to “CREATED” |
| CONSUMER_KYC_UPDATED | KYC status has been modified (excepted “CREATED” & “VALIDATED”) |
| CONSUMER_LOGGED_IN | When a consumer logs in |
| CONSUMER_SCA_UPDATED | When a consumer end-user SCA is set |
| CONSUMER_STATUS_UPDATED | When a consumer end-user status has been updated |
| CORPORATE_CREATED | A Corporate has been created |
| CORPORATE_UPDATED | A Corporate has been modified (excepted KYB status) |
| CORPORATE_KYB_UPDATED | KYB status has been modified (excepted “CREATED” & “VALIDATED”) |
| CORPORATE_KYB_VALIDATED | KYB status moved to “VALIDATED” |
| CORPORATE_RELATED_KYC_CREATED | KYC status of a Corporate Related moved to created |
| CORPORATE_RELATED_KYC_UPDATED | KYC status of a Corporate Related has been modified (excepted “CREATED” & “VALIDATED”) |
| CORPORATE_LOGGED_IN | When a corporate logs in |
| CORPORATE_RELATED_CORPORATE_CREATED | When a corporate has been added to a corporate end-user |
| CORPORATE_RELARED_PHYSICAL_PERSON_CREATED | When a physical person has been added to a corporate end-user |
| CORPORATE_SCA_UPDATED | When a corporate end-user SCA is set |
| CORPORATE_STATUS_UPDATED | When a corporate end-user status has been updated |
| LEDGER_CREATED | A Ledger has been created |
| LEDGER_UPGRADED | A ledger has been upgraded |
| LEDGER_UPDATED | Status of a Ledger has been updated (except closed) |
| LEDGER_BALANCE_UPDATED | Balance of a Ledger has been modified (amount, currentAmount, or reservedAmount) |
| LEDGER_CLOSED | A ledger status moved to “CLOSED” |
| TRANSACTION_CREATED | A transaction has been created |
| TRANSACTION_UPDATED | Status of a Transaction has been modified |
| CRYPTO_BENEFICIARY_CREATED | When a crypto beneficiary is created and ready to use |
| CRYPTO_TRANSACTION_CREATED | When a new crypto transaction has been created |
| DIRECT_DEBIT_MANDATE_ACTIVATED | When a direct debit mandate is activated |
| DIRECT_DEBIT_MANDATE_CANCELED | When a direct debit mandate is canceled |
| DIRECT_DEBIT_MANDATE_CREATED | When a direct debit mandate is created but not activated yet |
| DIRECT_DEBIT_MANDATE_UPDATED | When a direct debit mandate is updated |
| DOCUMENT_DELETED | When a document has been deleted |
| DOCUMENT_REQUESTED | When a document has been requested |
| DOCUMENT_UPLOADED | When a document has been uploaded |
| EXTERNAL_CARD_CREATED | When an external card is added through acquiring transaction |
| WALLET_ASSETS_UPDATED | When the wallet assets have changed |
| WALLET_CREATED | When a wallet has been created and is ready to use |