Refresh a cash-in deposit code
Regenerates the deposit code for an existing cash-in whose code has expired or is close to expiring, returning a fresh code and expiry. Pass an Idempotency-Key header to safely retry.
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
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.
The crypto destination a cash-in is converted to and delivered to.
Lifecycle of a cash-in. pending: code issued, awaiting deposit. processing: cash deposited, conversion underway. completed: converted and delivered. failed: the deposit or conversion did not succeed. expired: the code expired before any deposit.
pending, processing, completed, failed, expired Direction of value across rails: cryptoToCrypto, fiatToCrypto, or cryptoToFiat.
cryptoToCrypto, fiatToCrypto, cryptoToFiat The deposit code and retail location a customer uses to complete a cash-in.
Developer fee entries echoed back from the request. Omitted in alpha - request side is stripped per spec § 2. The field stays on the schema so it can be reintroduced without a breaking change when developer fees ship.
source, destination cashIn Exchange and effective rates.
USD cost of gas absorbed by the developer when sponsoring gas. Always "0" in alpha - gas is sponsored. Spec § 4.1.
Granular sub-status for a cash-in. Adds detail behind the coarse status field.
order_reserved, settled, cash_deposit_expired, cash_deposit_failed, provider_order_failed, provider_order_template_error