Webhook (Optional)

Configuring your Webhook SettingsCopied!

Webhooks are configured in your Rampnow dashboard's API Hub. Add a new URL for receiving webhooks.

You can enter any URL as the destination for events. However, there should be a dedicated API on your server that is set up to receive webhook notifications on EVENTS. You can choose to be notified of all event types, or only specific ones.

ORDER Events Copied!

processing
completed
failed

Python With Flask Example

from flask import Flask, request, jsonify

app = Flask(__name__)

@app.route('/order/external', methods=['POST'])
def orderwebhook():
    data = request.json  
    # partner logic based on event

    return jsonify({"status": "success"}), 200

if __name__ == '__main__':
    app.run(port=3000)

Order Webhook Schema

{
  "orderUid": "asdasnd-askdjnasjkdn-aksdnaksdn",
  "externalOrderUid": "vsdasnd-askdjnasjkdn-aksdnaksdn",
  "createTime": "2024-10-01T11:59:45",
  "updateTime": "2024-10-01T12:00:00Z",
  "partnerGeneratedUid": "jkansdasd-asdjknasdkasd-aksdnasjdk",
  "orderType": "buy",
  "orderStatus": "processing | completed | failed",
  "paymentStatus": "settled",
  "paymentMode": "card",
  "srcCurrency": "USD",
  "srcChain": "fiat",
  "srcAmount": 100,
  "dstCurrency": "ETH",
  "dstChain": "ethereum",
  "dstAmount": 0.3,
  "walletAddress": "0xINF98983WKJENRIKjjDEER989",
  "walletAddressTag": "",
  "transactionHash": ["OxtransactionHash"]
}