Offramp API Integration.
Web hook - Offramp

5min
This section explains the steps to configure callback URLs for receiving events about the completed transaction.
Configuring Webhook
Webhooks are configured in merchant dashboard.
Inside API Setup section, webhook can be added and modified under Callback URL's section
﻿
Generating HMAC
Signature is computed using Hash-based message authentication code (HMAC) using a secret key. The secret key is the API Secret present in your merchant dashboard.

The example implementation in Nodejs is show below ⬇️
Node.js
let hmac = crypto.createHmac('sha256', apiSecret);
hmac.update(JSON.stringify(postBody));
let hash = hmac.digest('hex');
assert(hash == headers["X-Onmeta-Signature"])
let hmac = crypto.createHmac('sha256', apiSecret);
hmac.update(JSON.stringify(postBody));
let hash = hmac.digest('hex');
assert(hash == headers["X-Onmeta-Signature"])
﻿
This callback will be triggered when the crypto coins are deposited to the given receiver address. will use the configured webhook url to send order completed details in POST body.
POST
Request
Header Parameters
Content-Type	
String
optional
application/json; charset=utf-8
X-Onmeta-Signature
String
required
{{signature-of-the-request}} as computed above.
Body Parameters
fiat
Number
required
fiat amount 
senderWalletAddress
String
required
receiver Wallet address
sellTokenSymbol
String
required
token symbol ex: BTC/USDC
sellTokenAddress
String
required
smart contract of the token example : "0x9c3C9283D3e44854697Cd22D3Faa240Cfb032889" for WMATIC
orderId
String
required
order ID - unique for a given ID
status
String
required
order status : "completed"
currency
Number
required
currency type example: "inr"
chainId
Number
required
block chain ID : example: "80001" for polygon testnet
customer
Object
required
created_at
String
required
created time
updated_at
String
required
updated time 
tenantId
String
required
merchant Id
transactionId
String
required
unique transaction ID for payout.
tokensDeducted
Number
required
tokens deducted to create this order.
tds
Number
required
Tax Deducted at Source for this order.
eventType
String
required
onramp/offramp
source
String
required
﻿
eventType will be offramp for this order  

Make sure you have firewall rule allowed for receiving the webhook body if not your firewall might block our webhook requests.
Sample body
JS
{
    "fiat": 100,
    "senderWalletAddress": "0x12E217bf293b242r1r1414fcw42g1",
    "sellTokenSymbol": "MATIC",
    "sellTokenAddress": "0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee",
    "orderId": "63c51a9e598f1f0fabbe8fbc",
    "status": "completed",
    "currency": "inr",
    "source": "",
    "chainId": 80001,
    "customer": {
      "id": "63c514c142e2ae343ed283ed",
      "name": "",
      "email": "[email protected]",
      "phone": {
        "countrycode": "",
        "number": ""
      },
      "created_at":
    },
    "created_at": ,
    "updated_at": ,
    "tenantId": "122345677",
    "transactionId":"S11FWKNM931"
    "tokensDeducted": 1.22,
    "tds": 1,
    "eventType": "offramp"
  }
{
    "fiat": 100,
    "senderWalletAddress": "0x12E217bf293b242r1r1414fcw42g1",
    "sellTokenSymbol": "MATIC",
    "sellTokenAddress": "0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee",
    "orderId": "63c51a9e598f1f0fabbe8fbc",
    "status": "completed",
    "currency": "inr",
    "source": "",
    "chainId": 80001,
    "customer": {
      "id": "63c514c142e2ae343ed283ed",
      "name": "",
      "email": "test@onmeta.com",
      "phone": {
        "countrycode": "",
        "number": ""
      },
      "created_at":
    },
    "created_at": ,
    "updated_at": ,
    "tenantId": "122345677",
    "transactionId":"S11FWKNM931"
    "tokensDeducted": 1.22,
    "tds": 1,
    "eventType": "offramp"
  }
﻿
Offramp Webhook Events
Onmeta offramp flow allows you to receive real-time notifications through webhook events when certain events occur. There are four types of webhook events that are supported in this flow:
pending - This event is triggered when a user has initialised the order but crypto transfer is pending.
orderReceived - This event is triggered when a user transfers crypto and the tokens are received by Onmeta. 
InProgress (Optional) - This event is triggered when the order is in-progress on the blockchain while swapping tokens (in case of non-base tokens). 
CryptoReceived - When we successfully validate the crypto received from user we send this event. 
PayoutSuccess - This event is triggered when the fiat amount is successfully deposited in the users bank account 
refunded - This event is triggered when refund is successfully completed in case of amount/token mismatch 
Example Webhook Request :
JSON
{
    "fiat":100,
    "senderWalletAddress":"0xf12dcsdadefed2eeb4d0475de270447a92a481635caf4a",
    "sellTokenSymbol":"MATIC",
    "sellTokenAddress":"0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee",
    "chainId":137,
    "orderId":"641c311afdsaddfwcd2768aa5e",
    "status":"PayoutSuccess",
    "currency":"inr",
    "created_at":"2023-03-23T10:59:38.494Z",
    "updated_at":"0001-01-01T00:00:00Z",
    "source":"",
    "customer":
    {
        "id":"63b52390dsaddefsfefwfw25d377ae",
        "email":"[email protected]",
        "phone":{},
        "created_at":"2023-01-04T06:58:24.968Z"
        },
    "tenantId":"",
    "transactionId":"TRAREFXXXXXXXXX",
    "tokensDeducted":1051823.63,    
    "tds":1,
    "eventType":"offramp",
    "metaData":{"submeta1":"metadata"}
}

{
    "fiat":100,
    "senderWalletAddress":"0xf12dcsdadefed2eeb4d0475de270447a92a481635caf4a",
    "sellTokenSymbol":"MATIC",
    "sellTokenAddress":"0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee",
    "chainId":137,
    "orderId":"641c311afdsaddfwcd2768aa5e",
    "status":"PayoutSuccess",
    "currency":"inr",
    "created_at":"2023-03-23T10:59:38.494Z",
    "updated_at":"0001-01-01T00:00:00Z",
    "source":"",
    "customer":
    {
        "id":"63b52390dsaddefsfefwfw25d377ae",
        "email":"documentation@onmeta.in",
        "phone":{},
        "created_at":"2023-01-04T06:58:24.968Z"
        },
    "tenantId":"",
    "transactionId":"TRAREFXXXXXXXXX",
    "tokensDeducted":1051823.63,    
    "tds":1,
    "eventType":"offramp",
    "metaData":{"submeta1":"metadata"}
}
﻿
﻿
Updated 02 Dec 2023
Did this page help you?
Quotation - Crypto input
Sample response