Skip to main content
GET
/
cash-ins
/
{cashInId}
Get a cash-in by ID
curl --request GET \
  --url https://sandbox-api.polygon.technology/v0.9/cash-ins/{cashInId} \
  --header 'Authorization: Bearer <token>'
{
  "cash": {
    "locationId": "<string>",
    "locationReference": "<string>"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "customerId": "<string>",
  "destination": {
    "amountGross": "<string>",
    "amountNet": "<string>",
    "asset": "<string>",
    "feesDeducted": {
      "developer": "<string>",
      "gas": "<string>",
      "oms": "<string>",
      "total": "<string>"
    },
    "network": "<string>",
    "wallet": {
      "blockchainAddress": "<string>",
      "externalAccount": "<string>",
      "id": "<string>"
    }
  },
  "id": "<string>",
  "location": {
    "address": "<string>",
    "name": "<string>"
  },
  "source": {
    "asset": "<string>",
    "amount": "<string>",
    "amountGross": "<string>",
    "amountNet": "<string>",
    "email": "<string>",
    "feesDeducted": {
      "developer": "<string>",
      "gas": "<string>",
      "oms": "<string>",
      "total": "<string>"
    },
    "indicatedAmount": "<string>",
    "network": "<string>"
  },
  "updatedAt": "2023-11-07T05:31:56Z",
  "completedAt": "2023-11-07T05:31:56Z",
  "depositInstructions": {
    "code": "<string>",
    "expiresAt": "2023-11-07T05:31:56Z",
    "locationAddress": "<string>",
    "locationName": "<string>"
  },
  "developerFees": [
    {
      "amount": "<string>",
      "flatFee": "<string>",
      "id": "<string>",
      "percentage": "<string>",
      "wallet": "<string>"
    }
  ],
  "metadata": {},
  "object": "cashIn",
  "omsFeeSchedule": {
    "entries": [
      {
        "type": "<string>",
        "amount": "<string>",
        "rate": "<string>"
      }
    ],
    "feeCurrency": "<string>"
  },
  "rates": {
    "effectiveRate": "<string>",
    "exchangeRate": "<string>",
    "pair": "<string>"
  },
  "sponsorGas": true,
  "sponsorGasCost": "<string>",
  "transactionId": "<string>"
}

Authorizations

Authorization
string
header
required

Token from POST /auth/token

Path Parameters

cashInId
string
required

Response

200 - application/json

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
object
required
createdAt
string<date-time>
required
customerId
string
required
destination
object
required

The crypto destination a cash-in is converted to and delivered to.

id
string
required
location
object
required
source
object
required
status
enum<string>
required

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.

Available options:
pending,
processing,
completed,
failed,
expired
type
enum<string>
required

Direction of value across rails: cryptoToCrypto, fiatToCrypto, or cryptoToFiat.

Available options:
cryptoToCrypto,
fiatToCrypto,
cryptoToFiat
updatedAt
string<date-time>
required
completedAt
string<date-time>
depositInstructions
object

The deposit code and retail location a customer uses to complete a cash-in.

developerFees
object[]

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.

fixedAmountSide
enum<string>
Available options:
source,
destination
metadata
object
object
enum<string>
Available options:
cashIn
omsFeeSchedule
object
rates
object

Exchange and effective rates.

sponsorGas
boolean
sponsorGasCost
string

USD cost of gas absorbed by the developer when sponsoring gas. Always "0" in alpha - gas is sponsored. Spec § 4.1.

subStatus
enum<string>

Granular sub-status for a cash-in. Adds detail behind the coarse status field.

Available options:
order_reserved,
settled,
cash_deposit_expired,
cash_deposit_failed,
provider_order_failed,
provider_order_template_error
transactionId
string