Create a cash-in deposit code

curl --request POST \
  --url https://sandbox-api.polygon.technology/v0.11/cash-ins \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "customerId": "cst_vfa0nxw6zvyws9g237jrxn4y7k",
  "source": {
    "asset": "usd",
    "indicatedAmount": "200.00"
  },
  "destination": {
    "asset": "usdc",
    "network": "polygon",
    "wallet": {
      "id": "wlt_5h4jzzpr9xre3bamd9ca7qyghn"
    }
  },
  "cash": {
    "locationId": "loc_01H9Xd",
    "locationReference": "R1JFRU5ET1QtMjQzNA=="
  },
  "sponsorGas": true,
  "metadata": {
    "orderId": "order_12345"
  }
}
'

import requests

url = "https://sandbox-api.polygon.technology/v0.11/cash-ins"

payload = {
    "customerId": "cst_vfa0nxw6zvyws9g237jrxn4y7k",
    "source": {
        "asset": "usd",
        "indicatedAmount": "200.00"
    },
    "destination": {
        "asset": "usdc",
        "network": "polygon",
        "wallet": { "id": "wlt_5h4jzzpr9xre3bamd9ca7qyghn" }
    },
    "cash": {
        "locationId": "loc_01H9Xd",
        "locationReference": "R1JFRU5ET1QtMjQzNA=="
    },
    "sponsorGas": True,
    "metadata": { "orderId": "order_12345" }
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    customerId: 'cst_vfa0nxw6zvyws9g237jrxn4y7k',
    source: {asset: 'usd', indicatedAmount: '200.00'},
    destination: {
      asset: 'usdc',
      network: 'polygon',
      wallet: {id: 'wlt_5h4jzzpr9xre3bamd9ca7qyghn'}
    },
    cash: {locationId: 'loc_01H9Xd', locationReference: 'R1JFRU5ET1QtMjQzNA=='},
    sponsorGas: true,
    metadata: {orderId: 'order_12345'}
  })
};

fetch('https://sandbox-api.polygon.technology/v0.11/cash-ins', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox-api.polygon.technology/v0.11/cash-ins",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'customerId' => 'cst_vfa0nxw6zvyws9g237jrxn4y7k',
    'source' => [
        'asset' => 'usd',
        'indicatedAmount' => '200.00'
    ],
    'destination' => [
        'asset' => 'usdc',
        'network' => 'polygon',
        'wallet' => [
                'id' => 'wlt_5h4jzzpr9xre3bamd9ca7qyghn'
        ]
    ],
    'cash' => [
        'locationId' => 'loc_01H9Xd',
        'locationReference' => 'R1JFRU5ET1QtMjQzNA=='
    ],
    'sponsorGas' => true,
    'metadata' => [
        'orderId' => 'order_12345'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox-api.polygon.technology/v0.11/cash-ins"

	payload := strings.NewReader("{\n  \"customerId\": \"cst_vfa0nxw6zvyws9g237jrxn4y7k\",\n  \"source\": {\n    \"asset\": \"usd\",\n    \"indicatedAmount\": \"200.00\"\n  },\n  \"destination\": {\n    \"asset\": \"usdc\",\n    \"network\": \"polygon\",\n    \"wallet\": {\n      \"id\": \"wlt_5h4jzzpr9xre3bamd9ca7qyghn\"\n    }\n  },\n  \"cash\": {\n    \"locationId\": \"loc_01H9Xd\",\n    \"locationReference\": \"R1JFRU5ET1QtMjQzNA==\"\n  },\n  \"sponsorGas\": true,\n  \"metadata\": {\n    \"orderId\": \"order_12345\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sandbox-api.polygon.technology/v0.11/cash-ins")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customerId\": \"cst_vfa0nxw6zvyws9g237jrxn4y7k\",\n  \"source\": {\n    \"asset\": \"usd\",\n    \"indicatedAmount\": \"200.00\"\n  },\n  \"destination\": {\n    \"asset\": \"usdc\",\n    \"network\": \"polygon\",\n    \"wallet\": {\n      \"id\": \"wlt_5h4jzzpr9xre3bamd9ca7qyghn\"\n    }\n  },\n  \"cash\": {\n    \"locationId\": \"loc_01H9Xd\",\n    \"locationReference\": \"R1JFRU5ET1QtMjQzNA==\"\n  },\n  \"sponsorGas\": true,\n  \"metadata\": {\n    \"orderId\": \"order_12345\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox-api.polygon.technology/v0.11/cash-ins")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"customerId\": \"cst_vfa0nxw6zvyws9g237jrxn4y7k\",\n  \"source\": {\n    \"asset\": \"usd\",\n    \"indicatedAmount\": \"200.00\"\n  },\n  \"destination\": {\n    \"asset\": \"usdc\",\n    \"network\": \"polygon\",\n    \"wallet\": {\n      \"id\": \"wlt_5h4jzzpr9xre3bamd9ca7qyghn\"\n    }\n  },\n  \"cash\": {\n    \"locationId\": \"loc_01H9Xd\",\n    \"locationReference\": \"R1JFRU5ET1QtMjQzNA==\"\n  },\n  \"sponsorGas\": true,\n  \"metadata\": {\n    \"orderId\": \"order_12345\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "ci_44vxe2xk8gfsjehfcw3npt5bg8",
  "object": "cashIn",
  "type": "fiatToCrypto",
  "status": "pending",
  "subStatus": "order_reserved",
  "customerId": "cst_vfa0nxw6zvyws9g237jrxn4y7k",
  "source": {
    "asset": "usd",
    "indicatedAmount": "200.00",
    "amountGross": "200.00",
    "amountNet": "200.00",
    "feesDeducted": {
      "total": "0.00",
      "developer": "0.00",
      "oms": "0.00",
      "gas": "0.00"
    }
  },
  "destination": {
    "asset": "usdc",
    "network": "polygon",
    "amountGross": "200.00",
    "amountNet": "200.00",
    "feesDeducted": {
      "total": "0.00",
      "developer": "0.00",
      "oms": "0.00",
      "gas": "0.00"
    },
    "wallet": {
      "id": "wlt_5h4jzzpr9xre3bamd9ca7qyghn",
      "blockchainAddress": "0x7B3A9F2C4D1eA8bf6390cE5D2b7fA104c8e3D9B1"
    }
  },
  "cash": {
    "locationId": "loc_01H9Xd",
    "locationReference": "R1JFRU5ET1QtMjQzNA=="
  },
  "location": {
    "name": "CVS Pharmacy #4521",
    "address": "123 Main St, San Francisco, CA 94105"
  },
  "rates": {
    "pair": "usd/usdc",
    "exchangeRate": "1.0000",
    "effectiveRate": "1.0000"
  },
  "depositInstructions": {
    "cashInCode": "483 291",
    "locationName": "CVS Pharmacy #4521",
    "locationAddress": "123 Main St, San Francisco, CA 94105"
  },
  "fixedAmountSide": "source",
  "sponsorGas": true,
  "sponsorGasCost": "0",
  "expiresAt": "2026-05-15T18:32:48Z",
  "createdAt": "2026-05-15T17:32:48Z",
  "updatedAt": "2026-05-15T17:32:48Z"
}

POST

cash-ins

Create a cash-in deposit code

curl --request POST \
  --url https://sandbox-api.polygon.technology/v0.11/cash-ins \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "customerId": "cst_vfa0nxw6zvyws9g237jrxn4y7k",
  "source": {
    "asset": "usd",
    "indicatedAmount": "200.00"
  },
  "destination": {
    "asset": "usdc",
    "network": "polygon",
    "wallet": {
      "id": "wlt_5h4jzzpr9xre3bamd9ca7qyghn"
    }
  },
  "cash": {
    "locationId": "loc_01H9Xd",
    "locationReference": "R1JFRU5ET1QtMjQzNA=="
  },
  "sponsorGas": true,
  "metadata": {
    "orderId": "order_12345"
  }
}
'

import requests

url = "https://sandbox-api.polygon.technology/v0.11/cash-ins"

payload = {
    "customerId": "cst_vfa0nxw6zvyws9g237jrxn4y7k",
    "source": {
        "asset": "usd",
        "indicatedAmount": "200.00"
    },
    "destination": {
        "asset": "usdc",
        "network": "polygon",
        "wallet": { "id": "wlt_5h4jzzpr9xre3bamd9ca7qyghn" }
    },
    "cash": {
        "locationId": "loc_01H9Xd",
        "locationReference": "R1JFRU5ET1QtMjQzNA=="
    },
    "sponsorGas": True,
    "metadata": { "orderId": "order_12345" }
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    customerId: 'cst_vfa0nxw6zvyws9g237jrxn4y7k',
    source: {asset: 'usd', indicatedAmount: '200.00'},
    destination: {
      asset: 'usdc',
      network: 'polygon',
      wallet: {id: 'wlt_5h4jzzpr9xre3bamd9ca7qyghn'}
    },
    cash: {locationId: 'loc_01H9Xd', locationReference: 'R1JFRU5ET1QtMjQzNA=='},
    sponsorGas: true,
    metadata: {orderId: 'order_12345'}
  })
};

fetch('https://sandbox-api.polygon.technology/v0.11/cash-ins', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox-api.polygon.technology/v0.11/cash-ins",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'customerId' => 'cst_vfa0nxw6zvyws9g237jrxn4y7k',
    'source' => [
        'asset' => 'usd',
        'indicatedAmount' => '200.00'
    ],
    'destination' => [
        'asset' => 'usdc',
        'network' => 'polygon',
        'wallet' => [
                'id' => 'wlt_5h4jzzpr9xre3bamd9ca7qyghn'
        ]
    ],
    'cash' => [
        'locationId' => 'loc_01H9Xd',
        'locationReference' => 'R1JFRU5ET1QtMjQzNA=='
    ],
    'sponsorGas' => true,
    'metadata' => [
        'orderId' => 'order_12345'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox-api.polygon.technology/v0.11/cash-ins"

	payload := strings.NewReader("{\n  \"customerId\": \"cst_vfa0nxw6zvyws9g237jrxn4y7k\",\n  \"source\": {\n    \"asset\": \"usd\",\n    \"indicatedAmount\": \"200.00\"\n  },\n  \"destination\": {\n    \"asset\": \"usdc\",\n    \"network\": \"polygon\",\n    \"wallet\": {\n      \"id\": \"wlt_5h4jzzpr9xre3bamd9ca7qyghn\"\n    }\n  },\n  \"cash\": {\n    \"locationId\": \"loc_01H9Xd\",\n    \"locationReference\": \"R1JFRU5ET1QtMjQzNA==\"\n  },\n  \"sponsorGas\": true,\n  \"metadata\": {\n    \"orderId\": \"order_12345\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sandbox-api.polygon.technology/v0.11/cash-ins")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customerId\": \"cst_vfa0nxw6zvyws9g237jrxn4y7k\",\n  \"source\": {\n    \"asset\": \"usd\",\n    \"indicatedAmount\": \"200.00\"\n  },\n  \"destination\": {\n    \"asset\": \"usdc\",\n    \"network\": \"polygon\",\n    \"wallet\": {\n      \"id\": \"wlt_5h4jzzpr9xre3bamd9ca7qyghn\"\n    }\n  },\n  \"cash\": {\n    \"locationId\": \"loc_01H9Xd\",\n    \"locationReference\": \"R1JFRU5ET1QtMjQzNA==\"\n  },\n  \"sponsorGas\": true,\n  \"metadata\": {\n    \"orderId\": \"order_12345\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox-api.polygon.technology/v0.11/cash-ins")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"customerId\": \"cst_vfa0nxw6zvyws9g237jrxn4y7k\",\n  \"source\": {\n    \"asset\": \"usd\",\n    \"indicatedAmount\": \"200.00\"\n  },\n  \"destination\": {\n    \"asset\": \"usdc\",\n    \"network\": \"polygon\",\n    \"wallet\": {\n      \"id\": \"wlt_5h4jzzpr9xre3bamd9ca7qyghn\"\n    }\n  },\n  \"cash\": {\n    \"locationId\": \"loc_01H9Xd\",\n    \"locationReference\": \"R1JFRU5ET1QtMjQzNA==\"\n  },\n  \"sponsorGas\": true,\n  \"metadata\": {\n    \"orderId\": \"order_12345\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "ci_44vxe2xk8gfsjehfcw3npt5bg8",
  "object": "cashIn",
  "type": "fiatToCrypto",
  "status": "pending",
  "subStatus": "order_reserved",
  "customerId": "cst_vfa0nxw6zvyws9g237jrxn4y7k",
  "source": {
    "asset": "usd",
    "indicatedAmount": "200.00",
    "amountGross": "200.00",
    "amountNet": "200.00",
    "feesDeducted": {
      "total": "0.00",
      "developer": "0.00",
      "oms": "0.00",
      "gas": "0.00"
    }
  },
  "destination": {
    "asset": "usdc",
    "network": "polygon",
    "amountGross": "200.00",
    "amountNet": "200.00",
    "feesDeducted": {
      "total": "0.00",
      "developer": "0.00",
      "oms": "0.00",
      "gas": "0.00"
    },
    "wallet": {
      "id": "wlt_5h4jzzpr9xre3bamd9ca7qyghn",
      "blockchainAddress": "0x7B3A9F2C4D1eA8bf6390cE5D2b7fA104c8e3D9B1"
    }
  },
  "cash": {
    "locationId": "loc_01H9Xd",
    "locationReference": "R1JFRU5ET1QtMjQzNA=="
  },
  "location": {
    "name": "CVS Pharmacy #4521",
    "address": "123 Main St, San Francisco, CA 94105"
  },
  "rates": {
    "pair": "usd/usdc",
    "exchangeRate": "1.0000",
    "effectiveRate": "1.0000"
  },
  "depositInstructions": {
    "cashInCode": "483 291",
    "locationName": "CVS Pharmacy #4521",
    "locationAddress": "123 Main St, San Francisco, CA 94105"
  },
  "fixedAmountSide": "source",
  "sponsorGas": true,
  "sponsorGasCost": "0",
  "expiresAt": "2026-05-15T18:32:48Z",
  "createdAt": "2026-05-15T17:32:48Z",
  "updatedAt": "2026-05-15T17:32:48Z"
}

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

Request body for creating a cash-in. Names the customer, the cash source location, and the crypto destination.

customerId

string

required

The customer depositing cash (cst_ prefix).

source

object

required

Where the customer will deposit cash.

Hide child attributes

source.asset

string

required

Canonical asset identifier.

source.network

string

Network identifier.

source.email

string

Email address.

source.indicatedAmount

string

The cash amount the customer indicated they will deposit.

source.amount

string

Amount as a decimal string.

source.amountGross

string

Amount on this side before fees are applied.

source.amountNet

string

Amount after fees - what is actually pulled from a source, or delivered to a destination.

source.feesDeducted

object

Per-side breakdown of fees deducted in-line from the transaction. End-of-month billable fees will be reported separately in the future (planned feesInvoice sibling). Denominated in that side's asset.

Hide child attributes

source.feesDeducted.total

string

required

source.feesDeducted.developer

string

required

Per-side aggregated developer fee total in this side's asset. Always "0" in alpha - alpha invariant, mirrors the gas line.

source.feesDeducted.oms

string

required

source.feesDeducted.gas

string

required

destination

object

required

Crypto instrument to deliver to (walletOms or walletExternal).

Hide child attributes

destination.wallet

object

The wallet receiving the converted funds.

Hide child attributes

destination.wallet.id

string

Unique identifier.

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})$

destination.wallet.externalAccount

string

Registered External Account receiving the funds, when applicable.

destination.wallet.blockchainAddress

string

On-chain address. For an EVM network the address must be all-lowercase, all-uppercase, or a valid EIP-55 checksummed form; an inconsistent mixed-case address is rejected as a likely casing typo, and the zero address is rejected. Solana/SUI are validated per their own network rules.

destination.asset

string

Canonical asset identifier.

destination.network

string

Network identifier.

destination.amountGross

string

Amount on this side before fees are applied.

destination.amountNet

string

Amount after fees - what is actually pulled from a source, or delivered to a destination.

destination.feesDeducted

object

Hide child attributes

destination.feesDeducted.total

string

required

destination.feesDeducted.developer

string

required

Per-side aggregated developer fee total in this side's asset. Always "0" in alpha - alpha invariant, mirrors the gas line.

destination.feesDeducted.oms

string

required

destination.feesDeducted.gas

string

required

cash

object

required

The cash amount to deposit.

Hide child attributes

cash.locationId

string

required

Cash location ID from GET /cash-locations.

cash.locationReference

string

required

Provider reference for the location, from GET /cash-locations.

When true, OMS absorbs the on-chain gas cost for the destination delivery. Only true is currently supported.

metadata

object

Free-form key-value pairs stored on the resource and echoed back on reads.

Hide child attributes

metadata.{key}

string

Response

201 - application/json

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

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.

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})$

type

enum<string>

required

Cash-in flavor.

Available options:

cryptoToCrypto,

fiatToCrypto,

cryptoToFiat

status

enum<string>

required

Current lifecycle status of the cash-in.

Available options:

pending,

processing,

completed,

failed,

expired

customerId

string

required

The OMS customer that owns this record (cst_ 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})$

source

object

required

Where the customer deposits cash: the provider and location.

Hide child attributes

source.asset

string

required

Canonical asset identifier.

source.network

string

Network identifier.

source.email

string

Email address.

source.indicatedAmount

string

The cash amount the customer indicated they will deposit.

source.amount

string

Amount as a decimal string.

source.amountGross

string

Amount on this side before fees are applied.

source.amountNet

string

Amount after fees - what is actually pulled from a source, or delivered to a destination.

source.feesDeducted

object

Hide child attributes

source.feesDeducted.total

string

required

source.feesDeducted.developer

string

required

Per-side aggregated developer fee total in this side's asset. Always "0" in alpha - alpha invariant, mirrors the gas line.

source.feesDeducted.oms

string

required

source.feesDeducted.gas

string

required

destination

object

required

Crypto instrument the converted funds are delivered to.

Hide child attributes

destination.wallet

object

The wallet receiving the converted funds.

Hide child attributes

destination.wallet.id

string

Unique identifier.

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})$

destination.wallet.externalAccount

string

Registered External Account receiving the funds, when applicable.

destination.wallet.blockchainAddress

string

destination.asset

string

Canonical asset identifier.

destination.network

string

Network identifier.

destination.amountGross

string

Amount on this side before fees are applied.

destination.amountNet

string

Amount after fees - what is actually pulled from a source, or delivered to a destination.

destination.feesDeducted

object

Hide child attributes

destination.feesDeducted.total

string

required

destination.feesDeducted.developer

string

required

Per-side aggregated developer fee total in this side's asset. Always "0" in alpha - alpha invariant, mirrors the gas line.

destination.feesDeducted.oms

string

required

destination.feesDeducted.gas

string

required

cash

object

required

The cash amount to be deposited.

Hide child attributes

cash.locationId

string

required

Cash location ID from GET /cash-locations.

cash.locationReference

string

required

Provider reference for the location, from GET /cash-locations.

location

object

required

Resolved detail of the chosen cash location.

Hide child attributes

location.name

string

Display name.

location.address

string

Postal address.

createdAt

string<date-time>

required

When the cash-in was created.

updatedAt

string<date-time>

required

When the cash-in was last updated.

object

enum<string>

Resource type discriminator. Always "cashIn".

Available options:

cashIn

subStatus

enum<string>

Granular sub-status adding detail behind status.

Available options:

order_reserved,

settled,

cash_deposit_expired,

cash_deposit_failed,

provider_order_failed,

provider_order_template_error

fixedAmountSide

enum<string>

The side the amount was fixed on when creating the cash-in. OMS calculated the other side.

Available options:

source,

destination

depositInstructions

object

The deposit code and instructions the customer presents at the retail location.

Hide child attributes

depositInstructions.cashInCode

string

required

Machine-readable code the customer presents at the register.

depositInstructions.locationName

string

Display name of the retail location.

depositInstructions.locationAddress

string

Street address of the retail location.

rates

object

Exchange and effective rates applied to this cash-in.

Hide child attributes

rates.pair

string

required

Asset pair string, e.g. "usdc/usd".

rates.exchangeRate

string

required

Units of destination asset per 1 unit of source asset.

rates.effectiveRate

string

required

All-in rate inclusive of all fees on both sides.

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

omsFeeSchedule

object

OMS fee schedule applied to this cash-in.

Hide child attributes

omsFeeSchedule.feeCurrency

string

required

Currency the fee lines are denominated in.

omsFeeSchedule.entries

object[]

required

Individual fee lines.

Hide child attributes

omsFeeSchedule.entries.type

string

required

Type discriminator.

omsFeeSchedule.entries.rate

string

Fee rate as a decimal.

omsFeeSchedule.entries.amount

string

Amount as a decimal string.

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})$

When true, OMS absorbs the on-chain gas cost for the destination delivery. Only true is currently supported.

metadata

object

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

Hide child attributes

metadata.{key}

string

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.

Hide child attributes

developerFees.id

string

Unique identifier assigned by OMS. Present on responses only.

developerFees.percentage

string

Percentage fee as a decimal rate. "0.02" = 2%.

developerFees.flatFee

string

Fixed fee in USD. Converted to fee-side asset at the exchange rate.

developerFees.amount

string

Computed fee amount for this entry. Present on responses only.

developerFees.payoutAsset

enum<string>

Crypto asset for fee payout. Defaults to "usdc".

Available options:

usdc,

usdt

developerFees.wallet

string

OMS wallet to receive this fee.

completedAt

string<date-time>

When the cash-in reached a terminal state. Null while in progress.

expiresAt

string<date-time>

When the issued deposit code expires. Single source of truth for cash-in expiry (#2144); the per-instruction expiresAt was removed in favor of this.

Get transaction by ID

List cash-ins

⌘I

Overview

Move money

Routes

External Payment Methods

Platform

Create a cash-in deposit code

Authorizations

Headers

Body

Response