Skip to main content
POST
/
cash-ins
Create a cash-in deposit code
curl --request POST \
  --url https://api.polygon.technology/v0.9/cash-ins \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "cash": {
    "locationId": "<string>",
    "locationReference": "<string>"
  },
  "customerId": "<string>",
  "destination": {
    "amountGross": "<string>",
    "amountNet": "<string>",
    "asset": "<string>",
    "network": "<string>",
    "wallet": {
      "blockchainAddress": "<string>",
      "externalAccount": "<string>",
      "id": "<string>"
    }
  },
  "source": {
    "asset": "<string>",
    "amount": "<string>",
    "amountGross": "<string>",
    "amountNet": "<string>",
    "email": "<string>",
    "indicatedAmount": "<string>",
    "network": "<string>"
  },
  "metadata": {},
  "sponsorGas": true
}
'
{
  "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": {},
  "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

Headers

​
Idempotency-Key
string
required

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

Body

application/json
​
cash
object
required
​
customerId
string
required
​
destination
object
required
​
source
object
required
​
metadata
object
​
sponsorGas
boolean

Response

201 - application/json

The request has succeeded and a new resource has been created as a result.

​
cash
object
required
​
createdAt
string<date-time>
required
​
customerId
string
required
​
destination
object
required
​
id
string
required
​
location
object
required
​
source
object
required
​
status
enum<string>
required
Available options:
pending,
processing,
completed,
failed,
expired
​
type
enum<string>
required
Available options:
cryptoToCrypto,
fiatToCrypto,
cryptoToFiat
​
updatedAt
string<date-time>
required
​
completedAt
string<date-time>
​
depositInstructions
object
​
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>
Available options:
order_reserved,
settled,
cash_deposit_expired,
cash_deposit_failed,
provider_order_failed,
provider_order_template_error
​
transactionId
string