CollectAdaptive Currency ConversionRate Locks

Get a rate lock

Retrieves a lock’s current state and frozen rate (mid, markup, all-in) and validity expiry. Validity is evaluated at read time: a lock at or past its expiresAt reads as expired, and a drift-invalidated lock reads as cancelled.

Authentication

AuthorizationBearer
Token obtained via the login flow.

Path parameters

rateLockIdstringRequired

Response

Rate lock details.
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.

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.

Errors

401
Unauthorized Error
404
Not Found Error