Cedar Partners API
  1. Getting Started
Cedar Partners API
  • Introduction
  • Getting Started
    • Data Model
    • Transaction Lifecycle
    • Authentication
    • API Environments
    • Webhooks Configuration
  • Development Tools
    • API Debugging
    • Error Codes
    • File URLs
  • API Documentation
    • Information
      • Get Countries
      • Get Currencies
    • Merchants
      • Create Merchant
      • Update Merchant
      • Get Merchant by ID
      • Get Merchants with Pagination
    • Onboarding
      • Onboarding Lifecycle
      • Get Legal Agreements
      • Accept Legal Agreements
      • Submit Merchant Onboarding
    • Receiver Accounts
      • Create Receiver Account
      • Update Receiver Account
      • Get Receiver Account by ID
      • Get Receiver Accounts with Pagination
    • Transactions
      • Payout (Crypto-to-Fiat)
        • Calculate FX Rate
        • Create Payout Transaction
        • Get Payout Transaction by ID
        • Get Payout Transactions with Pagination
        • Approve Payout Transaction Quote
        • Approve Payout Transaction Deposit
        • Cancel Payout Transaction
      • End to End (Fiat-to-Fiat)
        • Calculate FX Rate
        • Create End to End Transaction
        • Get End to End Transaction by ID
        • Get End to End Transactions with Pagination
        • Approve End to End Transaction Quote
        • Approve End to End Transaction Deposit
        • Cancel End to End Transaction
      • Collections (Fiat-to-Fiat)
        • Calculate FX Rate
        • Create Collections Transaction
        • Get Collections Transaction by ID
        • Get Collections Transactions with Pagination
        • Approve Collections Transaction Quote
        • Approve Collections Transaction Deposit
        • Cancel Collections Transaction
    • Utilities
      • Upload File
  1. Getting Started

Webhooks Configuration

Overview#

The Partners Platform allows you to configure and manage webhooks, enabling real-time event notifications for your integration. You can activate specific webhooks and define the endpoint URLs where they should be delivered.

Configuring Webhooks#

To set up webhooks:
1.
Log in to the Partners Platform.
2.
Navigate to API > API Webhooks.
3.
Select the webhook events you want to activate.
4.
Enter the URL where webhook events should be sent.
5.
Save your changes to enable webhook delivery.

Webhook Headers#

Each webhook request contains essential headers for security and debugging:
{
  "Content-Type": "application/json",
  "X-Webhook-Security-Fields": "id,status",
  "X-Webhook-Security-Hash": "0f52db1b460e50b6684de069176da48a2f9fe20b1b97336cc7eb550f19bbf805",
  "X-Webhook-Request-UUID": "fa8ff1ec-8eed-44fc-a84b-5a6ffc2b531f"
}

Header Details#

Content-Type: Specifies that the payload is in JSON format.
X-Webhook-Security-Fields: Lists the payload fields used for security hashing.
X-Webhook-Security-Hash: A hash for verifying webhook integrity.
X-Webhook-Request-UUID: A unique identifier for debugging requests in webhook logs.

Webhook Security#

To ensure webhook integrity, a security hash is generated using the specified security fields and a secret key. Below is a typescript code for hash generation:

Obtaining Webhook Secret#

To generate the security hash, you must retrieve your webhook secret from the Partners Platform API Security page.
1.
Log in to the Partners Platform.
2.
Navigate to API > API Security.
3.
Generate or retrieve your Webhook Secret.
4.
Use the webhook secret as described below.

Hash Generation Process#

1.
Extract the fields specified in X-Webhook-Security-Fields from the webhook payload.
2.
Concatenate their values into a single string in the same order as the order in the header.
3.
Concatenate the webhook secret at the end of the string
4.
Generate a SHA-256 hash of the string.
5.
Compare the computed hash with X-Webhook-Security-Hash to verify webhook authenticity.

Available Webhooks#

The following webhook events are available:
Technical NameTitleDescription
BusinessKycStatusChangedMerchant KYC Status ChangedTriggered when the Know Your Customer (KYC) status of a merchant changes. This webhook helps track compliance and verification status updates.
BusinessExternalAccountStatusChangedReceiver Account Status ChangedTriggered when the verification status of a receiver account changes.
BusinessRequestStatusChangedTransaction Status ChangedTriggered when the status of a transaction changes. It allows you to monitor and respond to updates regarding transaction status updates.
BusinessRequestPayoutConfirmationStatusChangedTransaction Payout Confirmation Status ChangedTriggered when the status of a payout confirmation (telex) request changed. It allows you to track when the request is completed and the document is available.

Webhook Log#

The Webhook Log provides a record of all outgoing webhook events, enabling better debugging and monitoring. It allows you to:
View webhook payloads, headers, and responses.
Replay webhook events to troubleshoot failed deliveries.
Test webhook endpoints using mock data.

Accessing the Webhook Log#

1.
Log in to the Partners Platform.
2.
Navigate to API > API Webhook Logs.
3.
Review webhook event details, including status and response codes.
4.
Replay or test webhook events as needed.

Best Practices#

Always validate the webhook hash to ensure data integrity.
Monitor the Webhook Log for failed events and troubleshoot using replays.
Test webhook endpoints with mock data before going live.
Modified at 2025-03-04 13:00:08
Previous
API Environments
Next
API Debugging
Built with