Skip to main content
POST
Refresh a cash-in deposit code

Authorizations

Authorization
string
header
required

Token from POST /auth/token

Headers

Idempotency-Key
string
required

Required on POST and PUT requests. Use a unique value per logical mutation attempt, for example a UUID.

Path Parameters

cashInId
string
required

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.

id
string
required

Cash-in ID (ci_ prefix).

Pattern: ^[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})$
status
enum<string>
required

Current lifecycle status of the cash-in.

Available options:
pending,
processing,
completed,
failed,
expired
customer
object
required

The customer that owns this record.

source
Cash · object
required

The retail location the customer deposits cash at.

destination
OMS wallet · object
required

The customer's wallet the converted funds are delivered to.

depositInstructions
object
required

The code the customer presents at the retail location.

pricing
object
required

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.

createdAt
string<date-time>
required

When the cash-in was created.

updatedAt
string<date-time>
required

When the cash-in was last updated.

expiresAt
string<date-time>
required

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.

failure
object

Why the cash-in failed. Present only when status is failed.

transactionId
string

The Transaction produced once the cash-in completes. Null while pending.

Pattern: ^[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})$
metadata
object

Free-form key-value pairs supplied at creation or update.

completedAt
string<date-time>

When the cash-in completed. Present only when status is completed.