Webhooks

Webhooks associated to an account in this section are used for Crypto and ON:OFF Ramp transactions.

🚧
Invoice, Send to address, LURL (Pay and Withdraw) Webhooks
Webhooks for this transactions are created when calling their respective endpoints. Webhooks created in this section do NOT get called for this transaction types.

Crypto

Crypto webhooks are triggered when a Send or Receive transaction have reached a terminal status (completed or failed).

Webhook body

{
  "transaction": {
    "amount": "number (float64)",
    "accountId": "string (UUID)",
    "networkFee": "number (float64)",
    "transactionTypeId": "number (int)",
    "createdAt": "string (ISO 8601 Timestamp)",
    "settledAt": "string (ISO 8601 Timestamp) | null",
    "status": "string"
  },
  "secret": "string | null"
}

Ramp

Ramp webhooks are triggered when a Deposit or Withdrawal transaction have reached a terminal status (completed or failed).

Webhook body

{
  "transaction": {
    "id": "string (UUID)",
    "accountId": "string (UUID)",
    "amount": "number (float64)",
    "networkFee": "number (float64)",
    "currencyId": "number (int)",
    "transactionTypeId": "number (int)",
    "createdAt": "string (ISO 8601 Timestamp)",
    "settledAt": "string (ISO 8601 Timestamp) | null",
    "status": "string"
  },
  "secret": "string | null"
}

Transaction Types

ID	Name	Description
7	Ramp Deposit	Bank Deposit
8	Ramp Withdrawal	Bank Withdrawal
9	Crypto Receive	Crypto Receive
10	Crypto Send	Crypto Send

** For a complete list of transaction types use the transaction type endpoint