orchestration.status_details.travel_rule_info_required

Webhook triggered when an orchestration enters the travel_rule_info_required sub-state

WEBHOOK orchestration.status_details.travel_rule_info_required

Example

{
  "id": "bd019f1c-89a7-4372-9d21-eaad9280dc41",
  "type": "orchestration.status_details.travel_rule_info_required",
  "source": "com.paxos",
  "time": "2025-01-07T14:30:02Z",
  "object": "event",
  "is_test": false
}

Triggered when an orchestration moves into the travel_rule_info_required sub-state. This occurs when the orchestration’s crypto withdrawal is rejected because the destination address has no Travel Rule information.

awaiting_action_from will be AWAITING_ACTION_FROM_CLIENT. The orchestration stays in PROCESSING and retries the withdrawal automatically.

To resolve, call Put Crypto Destination Address with travelrule_metadata populated for the destination address. See Collecting Travel Rule Information for the fields to collect. The next retry creates the withdrawal, and status_details moves to destination_transfer_in_progress.

This event can fire more than once for the same orchestration. If a retry fails for a different reason, status_details returns to destination_transfer_in_progress, and a later Travel Rule rejection sets travel_rule_info_required again. Make handlers idempotent.

Webhook payloads contain only event metadata. Use the Get Event API with the event ID to retrieve full details.

Event Object Structure

The Get Event API returns an orchestration_status_details_change object, which includes status_details.travel_rule_info_required.

See the Webhook Integration Guide to understand when to use granular status_details events versus the high-level orchestration.processing webhook.

Body

application/json

Webhook payload containing event metadata. Use the event ID with the Get Event API to retrieve full details.

The webhook payload structure sent to your endpoint

id · string<uuid> · required

The event identifier used to query the Events API for full details

type · enum<string> · required

The type of event that occurred

Available options: identity.documents_required, identity.documents_accepted, identity.documents_denied, identity.approved, identity.denied, identity.disabled, identity.kyc_refresh.started, identity.kyc_refresh.completed, identity.kyc_refresh.expired, identity.tax_documentation.status_changed, identity.control.created, identity.control.deleted, orchestration.pending, orchestration.processing, orchestration.completed, orchestration.failed, orchestration.rejected, orchestration.status_details.pending_customer_approval, orchestration.status_details.conversion_in_progress, orchestration.status_details.destination_transfer_in_progress, orchestration.status_details.travel_rule_info_required, orchestration.status_details.conversion_failed, orchestration.status_details.destination_transfer_failed, orchestration.status_details.policy_rejected, transfer.crypto_deposit.pending, transfer.crypto_deposit.completed, transfer.crypto_deposit.failed, transfer.crypto_withdrawal.pending, transfer.crypto_withdrawal.completed, transfer.crypto_withdrawal.failed, transfer.act_deposit.pending, transfer.act_deposit.completed, transfer.act_deposit.failed, transfer.act_withdrawal.pending, transfer.act_withdrawal.completed, transfer.act_withdrawal.failed, transfer.wire_deposit.pending, transfer.wire_deposit.completed, transfer.wire_deposit.failed, transfer.wire_withdrawal.pending, transfer.wire_withdrawal.completed, transfer.wire_withdrawal.failed, transfer.cubix_deposit.pending, transfer.cubix_deposit.completed, transfer.cubix_deposit.failed, transfer.cubix_withdrawal.pending, transfer.cubix_withdrawal.completed, transfer.cubix_withdrawal.failed, transfer.scb_intrabank_deposit.pending, transfer.scb_intrabank_deposit.completed, transfer.scb_intrabank_deposit.failed, transfer.scb_intrabank_withdrawal.pending, transfer.scb_intrabank_withdrawal.completed, transfer.scb_intrabank_withdrawal.failed, transfer.banking_circle_intrabank_deposit.pending, transfer.banking_circle_intrabank_deposit.completed, transfer.banking_circle_intrabank_deposit.failed, transfer.banking_circle_intrabank_withdrawal.pending, transfer.banking_circle_intrabank_withdrawal.completed, transfer.banking_circle_intrabank_withdrawal.failed, transfer.bny_intrabank_deposit.pending, transfer.bny_intrabank_deposit.completed, transfer.bny_intrabank_deposit.failed, transfer.bny_intrabank_withdrawal.pending, transfer.bny_intrabank_withdrawal.completed, transfer.bny_intrabank_withdrawal.failed, transfer.rtp_deposit.pending, transfer.rtp_deposit.completed, transfer.rtp_deposit.failed, transfer.internal_transfer_debit.completed, transfer.internal_transfer_credit.completed

source · enum<string> · required

Always 'com.paxos'

Available options: com.paxos

time · string<date-time> · required

When the event occurred, RFC3339 format

object · enum<string> · required

Always 'event'

Available options: event

is_test · boolean

Whether the event was a test event. Test events are only sent via the Test feature in Dashboard.

Response

200

Webhook successfully received