Status updates - Webhooks

Partners can receive event related to the transactions and replenish by registering their URL with Zynk.

Webhook URL can be registered in the Settings section on the Partner Experience Dashboard

Webhook Signature Verification

For security, each webhook request includes a signature header that you should verify to ensure the webhook is sent by our system.

Headers

z-webhook-signature: timestamp:signature

Signature Verification
Use the following code to verify the signature.

Verification Process

Extract the timestamp and signature from the z-webhook-signature header

Recreate the signed body by adding the timestamp to your received payload

Generate the expected signature using your secret

Compare the received signature with the expected signature

Event Details

Event category - alm_transaction

Events -

disburse : Triggered when an ALM disburse transaction is processed

replenish : Triggered when an ALM replenish transaction is processed

Examples

Disburse Event:

{
  "eventId": "zynk_1f4953b1_68a9_4371_a39b_9d8bd2624fc6",
  "eventCategory": "alm_transaction",
  "eventStatus": "CONFIRMED", // DRAFT, INITIATED, PENDING, CONFIRMED, FAILED, RETRY
  "eventType": "disburse",
  "eventObject": {
    "transactionId": "txn_1a81a1e5_a562_4cd8_ae10_23ebc97339d3",
    "transactionHash": "4it74Q1GZNbM5yZkFnPMDtFkWBUmjAtfNEqmzWsY5vPEnnBx7LAa7CFR9fMN33W3J8ovBN4cEp91Ud2bhyDs3S3S",
    "transactionStatus": "CONFIRMED", // same as eventStatus
    "transactionAmount": 1,
    "transactionreplenishStatus": "OPEN", // INITIATED, OPEN, PARTIAL, CLOSED, FAILED
    "chainId": "103",
    "tokenAddress": "Kk4sTVi1FMABcKLGjvhXUmXhzoCk8M5xP9LSrwJi8P6",
    "destinationWallet": "2Cbvd6ALj9RyY3wZG41YhEAp2HDeAPycwpCefTpmCDcG"
  }
}

Replenish Event:

{
  "eventId": "zynk_b79c759b_24e5_45f1_8ad2_d8877d79ddca",
  "eventCategory": "alm_transaction",
  "eventStatus": "CONFIRMED", // DRAFT, INITIATED, PENDING, CONFIRMED, FAILED, RETRY
  "eventType": "replenish",
  "eventObject": {
    "replenishQuoteId": "repq_c81b78fd_0d16_4660_b620_f1cb75a9379b",
    "replenishTxnId": "rept_746e6e48_3ed5_49e2_b73a_25143deb6c14",
    "replenishTxnHash": "62kKh6hqCYrPit1pHnRpaxW7Ck9EqRfgRCmGSicrPYv2927WKmgXLk46Ujds9xABJ4Gr1XJheKPaHGe5E8wLZU1H",
    "replenishAmount": 0.613,
    "replenishTxnStatus": "CONFIRMED", // same as eventStatus
    "transactionId": "txn_1a81a1e5_a562_4cd8_ae10_23ebc97339d3",
    "transactionAmount": 1,
    "transactionPendingAmount": 0.5,
    "transactionreplenishStatus": "PARTIAL" // INITIATED, OPEN, PARTIAL, CLOSED, FAILED
  }
}

ALM Transaction Status Values

Status	Description
`DRAFT`	The transaction has been created but not yet initiated
`INITIATED`	The transaction has been initiated
`PENDING`	The transaction is pending confirmation
`CONFIRMED`	The transaction has been confirmed on the blockchain
`FAILED`	The transaction has failed
`RETRY`	The transaction is being retried

ALM Transaction Replenish Status Values

Status	Description
`INITIATED`	The replenishment process has been initiated
`OPEN`	The transaction is open for replenishment
`PARTIAL`	The transaction has been partially replenished
`CLOSED`	The transaction has been fully replenished
`FAILED`	The replenishment has failed

Status updates - Webhooks

Webhook Signature Verification#

Event Details#

ALM Transaction Status Values#

ALM Transaction Replenish Status Values#

Webhook Signature Verification

Event Details

ALM Transaction Status Values

ALM Transaction Replenish Status Values