Transfer (Webhook-Ramp)

Event metadata

name: TRANSFER
types:
- ramp.transfer.submitted – transfer request submitted
- ramp.transfer.pending – transfer in progress
- ramp.transfer.failed – transfer failed
- ramp.transfer.success – transfer completed successfully
- ramp.transfer.submitted.failed – transfer submission failed

Field	Type	Description
event_id	string	Unique event ID
event_name	string	Event name
event_type	string	Event type
source_id	string	Order ID
version	string	API Version number
data	object	Conversion details object

Notification example

The structure is consistent with the Retrieve Transfer API response.

Transfer In

{
  "version": "V1.6.0",
  "event_name": "TRANSFER",
  "event_type": "ramp.transfer.success",
  "event_id": "a57da6b5-2428-441f-a2c5-8db8e812d5a0",
  "source_id": "0efd964b-e87f-498d-8da5-d1956af02bca",
  "data": {
    "account_id": "b1b89684-c2c4-4d54-b8a8-3572727fd120",
    "account_name": "UQPAY PTE LTD",
    "amount": "100",
    "complete_time": "2026-03-12 17:41:42 +0800 CST",
    "create_time": "2026-03-12 17:41:27 +0800 CST",
    "currency": "USD",
    "direct_id": "0",
    "fee": "0",
    "order_id": "0efd964b-e87f-498d-8da5-d1956af02bca",
    "order_status": "Success",
    "reason": "test",
    "short_order_id": "TI260312-3TK6FFK5",
    "transaction_type": "Transfer In"
  }
}

Transfer Out

{
  "version": "V1.6.0",
  "event_name": "TRANSFER",
  "event_type": "ramp.transfer.success",
  "event_id": "2745f00a-8c01-44d7-b88c-ef2cac063a3b",
  "source_id": "5e305630-b4af-41f2-97de-0b8a88bb6324",
  "data": {
    "account_id": "b1b89684-c2c4-4d54-b8a8-3572727fd120",
    "account_name": "UQPAY PTE LTD",
    "amount": "10",
    "complete_time": "2026-03-12 17:42:42 +0800 CST",
    "create_time": "2026-03-12 17:42:29 +0800 CST",
    "currency": "USD",
    "direct_id": "0",
    "fee": "0",
    "order_id": "5e305630-b4af-41f2-97de-0b8a88bb6324",
    "order_status": "Success",
    "reason": "test-f",
    "short_order_id": "TO260312-6OK7TDML",
    "transaction_type": "Transfer Out"
  }
}