Refresh a cash-in deposit code
Regenerates the deposit code for an existing cash-in that has not yet expired, returning a fresh cashInCode. The cash-in’s expiresAt is unchanged, so a refresh does not buy the customer more time; once it has passed, the request fails with 422 RefreshExpired. Pass an Idempotency-Key header to safely retry.
A per-cash-in refresh guard returns 429 when the total-refresh cap is hit (RefreshLimitReached) or when refreshed inside the minimum interval (RefreshTooFrequent, with a Retry-After header) — protecting the upstream provider and bounding stored refresh history.
Authorizations
Token from POST /auth/token
Headers
Required on POST and PUT requests. Use a unique value per logical mutation attempt, for example a UUID.
Path Parameters
Cash-in ID (ci_ prefix).
Response
The request has succeeded.
A code-based cash deposit. The customer takes the issued code to a retail location and deposits cash, which OMS converts to crypto and delivers to the destination. Amounts start as estimates and are finalized once the cash is deposited.
Cash-in ID (ci_ prefix).
^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$Current lifecycle status of the cash-in.
pending, processing, completed, failed, expired The customer that owns this record.
The retail location the customer deposits cash at.
The customer's wallet the converted funds are delivered to.
- OMS wallet
- External wallet
The code the customer presents at the retail location.
The cash amount, what arrives in the wallet, the rate and the fees. The source amount is the indicated amount until the cash is deposited, then the cash actually deposited.
When the cash-in was created.
When the cash-in was last updated.
Expiry of the cashInCode — the single expiry field for a cash-in. Refreshing the cash-in issues a new cashInCode but does not extend this expiry. Once it has passed, the cash-in can no longer be refreshed.
Why the cash-in failed. Present only when status is failed.
The Transaction produced once the cash-in completes. Null while pending.
^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$Free-form key-value pairs supplied at creation or update.
When the cash-in completed. Present only when status is completed.