Skip to navigation
CollectAdaptive Currency ConversionRate Locks

Cancel a rate lock

Cancels an active lock before its expiry so it can no longer be used for new checkouts. The lock moves to cancelled with cancellationReason: requested and stays readable via Get a rate lock. Cancellation is permanent and does not affect any transaction already in progress, which keeps its locked rate. Idempotent: cancelling a lock that is already cancelled or expired returns its current state unchanged.

Authentication

AuthorizationBearer
Token obtained via the login flow.

Path parameters

rateLockIdstringRequired

Response

The cancelled lock, or its current terminal state if it had already ended.
rateLockIdstring
statusenum
  • active — usable.
  • expired — past expiresAt. Terminal.
  • cancelled — invalidated before expiry; see cancellationReason. Terminal.

expired and cancelled are permanent — a lock never returns to active. A lock at or past expiresAt is invalid even if status still reads active.

Allowed values:
basestring

Base currency (ISO 4217).

quotestring

Quote currency (ISO 4217).

midRatestring

Reference mid-market rate the lock was priced from. 1 base = <midRate> quote.

markupBpsinteger

The markup applied over the mid, in basis points (100 bps = 1%).

allInRatestring

The rate you transact at: mid plus markup. This is the rate carried onto every transaction that uses the lock. 1 base = <allInRate> quote.

createdAtdatetime
expiresAtdatetime

End of the lock's validity window. The lock is invalid from this time even if status still reads active.

cancellationReasonenumOptional

Why the lock was cancelled. Present only when status is cancelled. market_drift — the rate moved beyond the allowed tolerance. requested — you cancelled the lock yourself via the cancel endpoint.

Allowed values:

Errors

401
Unauthorized Error
404
Not Found Error