Cancel price trigger swap
Cancels a price trigger swap that is still in active status.
Only swaps in active status can be cancelled. Swaps in completed or cancelled status are terminal and cannot be cancelled — those return 409 Conflict with code: price_trigger_swap_not_cancellable. Cancelling a swap is idempotent: replaying the request with the same Idempotency-Key returns the cached response with the Idempotent-Replayed: true header.
On success, the swap’s status becomes cancelled and cancelled_reason is populated with code: user_request. Subscribers to the price_trigger_swap.cancelled webhook receive a notification.
Authorizations
Your public API key. Identifies the partner making the request.
Monotonically increasing nonce included in the request signature.
HMAC signature over the request, computed with your private key.
Headers
Client-generated UUIDv4 for safe retries. Sent as the Idempotency-Key HTTP header. Replayed responses include the Idempotent-Replayed: true header.
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"550e8400-e29b-41d4-a716-446655440000"
Path Parameters
ID of the account the request applies to. This refers to one of the accounts held by the user the request is acting on behalf of (typically the user's main account, but any of the user's accounts is accepted). Routes the request to that specific account container. Canonical identifier for an account in the Payward public API.
14 - 42ID of the price trigger swap to cancel (prefixed with swap_).
Response
Cancelled. The response body is empty; re-fetch the swap via GET /v1/accounts/{account_id}/price-trigger-swaps/{price_trigger_swap_id} if you need the post-cancel state.