Cancel a cash-in
Cancels a cash-in that is still pending: the deposit code stops working and the cash-in becomes cancelled, announced by cashIn.statusChanged. The cancel takes effect only when the provider confirms it deleted the code. When the customer scans the code while the cancel is in flight, the cash-in becomes processing and the request fails with 409 CashInAlreadyScanned; when the code had already expired the cash-in becomes expired and the request fails with 409 CashInExpired. A cash-in that is processing or already final fails with 409 CashInNotCancellable and nothing changes. When the provider cannot be reached the cash-in stays pending and the request can be retried. 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
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, cancelled 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. pricing.source.amount is the indicated amount before the cash is paid, then the amount authorised at the register once the cash is paid.
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 linked to this cash-in. Set once the linked transaction exists; 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.
Leg 1 start: when the customer scanned the cash-in code at the retail location.
Leg 1 done: when the cash was loaded and the provider can no longer cancel it.
Leg 2 done: when the crypto purchase was confirmed.