Skip to main content
POST
/
subscribed-events
Update subscribed events
curl --request POST \
  --url https://ramp-sandbox.hexarails.ai/subscribed-events \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "events": [
    "CUSTOMER_APPROVED",
    "CUSTOMER_REJECTED",
    "CUSTOMER_DELETED",
    "VIRTUAL_ACCOUNT_APPROVED",
    "VIRTUAL_ACCOUNT_REJECTED",
    "DEPOSIT_ADDRESS_APPROVED",
    "DEPOSIT_ADDRESS_REJECTED",
    "DEPOSIT_RECEIVED",
    "DEPOSIT_APPROVED",
    "DEPOSIT_REJECTED",
    "TRADE_CREATED",
    "TRADE_SETTLED",
    "PAYMENT_SETTLED"
  ]
}
'
{
  "status": "SUCCESS",
  "data": {
    "message": "Subscribed events updated successfully"
  }
}

Authorizations

X-API-Key
string
header
required

Body

application/json
events
enum<string>[]
required

Subscribed events

Event Payload Structures:

See WebhookEvent schema for detailed payload structures for each event type.

Available options:
CUSTOMER_APPROVED,
CUSTOMER_REJECTED,
CUSTOMER_DELETED,
VIRTUAL_ACCOUNT_APPROVED,
VIRTUAL_ACCOUNT_REJECTED,
DEPOSIT_ADDRESS_REJECTED,
DEPOSIT_ADDRESS_APPROVED,
DEPOSIT_RECEIVED,
DEPOSIT_APPROVED,
DEPOSIT_REJECTED,
TRADE_CREATED,
TRADE_SETTLED,
PAYMENT_SETTLED,
user.approved,
user.rejected,
va.approved,
va.rejected,
deposit.received,
deposit.approved,
deposit.rejected,
trade.created,
trade.settled
Example:
[
"CUSTOMER_APPROVED",
"CUSTOMER_REJECTED",
"CUSTOMER_DELETED",
"VIRTUAL_ACCOUNT_APPROVED",
"VIRTUAL_ACCOUNT_REJECTED",
"DEPOSIT_ADDRESS_APPROVED",
"DEPOSIT_ADDRESS_REJECTED",
"DEPOSIT_RECEIVED",
"DEPOSIT_APPROVED",
"DEPOSIT_REJECTED",
"TRADE_CREATED",
"TRADE_SETTLED",
"PAYMENT_SETTLED"
]

Response

Update subscribed events successful

status
enum<string>
required

Success response status

Available options:
SUCCESS
Example:

"SUCCESS"

data
object
required

Response data