Skip to main content
WEBHOOK

Authorizations

API-Key
string
header
required

Your public API key. Identifies the partner making the request.

API-Sign
string
header
required

HMAC signature over the request, computed with your private key.

API-Nonce
string
header
required

Monotonically increasing nonce included in the request signature.

Body

application/json

Payload shared by all conversion transaction lifecycle events.

transaction_id
string
required

Conversion transaction id.

Stable public conversion transaction id when the source event carries enough conversion context. Falls back to the public quote_id for older ramp events without conversion transaction context.

conversion_id
string
required

Public conversion rule id.

user_id
string
required

Public id of the user whose conversion transaction changed.

status
string
required

Public conversion transaction lifecycle status.

observed_at
string
required

RFC3339 UTC time the transition was observed by the processor.

chain_references
object
required

Funding transaction references observed in the source lifecycle.

type
enum<string>
required

Event type discriminator.

Available options:
conversion.travel_rule_blocked
deposit_reference
string

User payment reference from the inbound funding deposit, when present.

error_code
enum<string>

Stable public failure category when the conversion lifecycle transition failed.

Available options:
amount_too_small,
quote_expired,
destination_rejected,
wallet_not_whitelisted,
wallet_verification_method_not_supported,
travel_rule_data_missing,
unknown
deposit_amount
string

Inbound deposit amount as a decimal string, when present.

deposit_currency
string

Inbound deposit asset symbol, when present.

source_amount
string

Quote source amount as a decimal string, when present.

source_currency
string

Quote source asset symbol, when present.

destination_currency
string

Quote destination asset symbol, when present.

withdrawal_amount
string

Outbound withdrawal amount as a decimal string, when present.

withdrawal_currency
string

Outbound withdrawal asset symbol, when present.

network
string

Crypto delivery network when the conversion target is crypto.

destination_address
string

Crypto destination address. Present only for crypto withdrawals; never a fiat destination, tag, or memo.

Response

200

Return any 2xx status to acknowledge receipt.