Skip to main content
WEBHOOK

Preparation canceled

Upcoming TPP payouts. This Sandbox contract is for integration planning. TPP payouts are not yet available.
This event identifies the on-demand operation with conversion_id. It has no transaction_id or chain_references. The optional from and to contain only side types. Amounts, rate, fees, and payee bank details are omitted. expired means the preparation passed expires_at before execution. Other cancellation reasons include market_moved and price_unavailable; accept unknown reasons. Retrieve the resource with GET and prepare a new conversion if you want to try again.

Body

application/json

Payload delivered for the conversion.canceled webhook event. It identifies the canceled on-demand conversion and tells why it was canceled. To read the amounts, the rate, the fees, and the times, use Get on-demand conversion.

type
string
required

Webhook event identifier.

Allowed value: "conversion.canceled"
conversion_id
string<uuid>
required

On-demand conversion identifier.

user_id
string
required

Globally unique public identifier for a user.

Required string length: 14 - 42
account_id
string
required

Globally unique public identifier for an account.

Required string length: 14 - 42
status
enum<string>
required

Status of the on-demand conversion when the event occurred. New statuses can be added, so accept an unknown status.

Available options:
canceled
cancellation_reason
enum<string>
required

Why the on-demand conversion was canceled. New reasons can be added, so accept an unknown reason.

  • expired: expires_at passed before execution.
  • market_moved: the market moved too far from the locked price.
  • price_unavailable: the locked price could no longer be honored.
Available options:
expired,
market_moved,
price_unavailable
observed_at
string<date-time>
required

Time at which the change was observed. It is not the time at which the change occurred.

conversion_type
enum<string>

Identifies whether the event belongs to a conversion rule or an on-demand conversion. When omitted, the conversion type is not known.

Available options:
conversion_rule,
on_demand_conversion
from
OnDemandConversionWebhookSide · object

Source side. It is not sent when the source type is not known.

to
OnDemandConversionWebhookSide · object

Destination side. It is not sent when the destination type is not known.

Response

2XX

Delivery endpoint accepted the webhook.