Skip to main content
POST
Simulate cash-in present 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

Body

application/json
cashInCode
string
required

The cash-in's depositInstructions.code - what the customer presents at the register.

amount
string
required

Wire-safe decimal string for financial float values (USD amounts, percentages).

Response

200 - application/json

The request has succeeded.

responseCode
string
required
responseText
string
required
responseId
string
required
confirmationId
string
required

Authorization confirmation - pass as originalConfirmationId to deposit-cash or cancel.

authorizedAmount
string
required

Amount the provider authorized.

balance
string
required

Provider-reported running balance for this cash-in code after the authorization.