Webhooks

This section explains how to manage an account's webhook.

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.

Production IPs for webhooks

When you receive a webhook check the secret AND the ip address of the sender for maximum security

34.148.92.171 35.196.168.24

Webhook body

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

infoId refers to a transactions underlying information id. You will need to determine its type based on the transaction's transactionTypeId. Below is a table with current transaction type id's and their corresponding info type.

Transaction Type IdTransaction TypeInfo
7DepositDepositInfo
8WithdrawalWithdrawalDestination
9CryptoReceiveReceiveInfo
10CryptoSendSendInfo

Crypto

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

Ramp

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

Transaction Types

IDNameDescription
7Ramp DepositBank Deposit
8Ramp WithdrawalBank Withdrawal
9Crypto ReceiveCrypto Receive
10Crypto SendCrypto Send

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

Transaction Statuses

StatusValue
UNKNOWN0
PENDING1
COMPLETED2
FAILED3