Create a cash-in deposit code

curl --request POST \
  --url https://sandbox-api.polygon.technology/v0.13/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.13/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.13/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.13/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.13/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.13/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.13/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",
  "status": "pending",
  "customer": {
    "id": "cst_vfa0nxw6zvyws9g237jrxn4y7k"
  },
  "source": {
    "type": "cash",
    "asset": "usd",
    "details": {
      "locationId": "loc_01H9Xd",
      "locationName": "CVS Pharmacy #4521",
      "locationAddress": {
        "line1": "123 Main St",
        "city": "San Francisco",
        "state": "CA",
        "zipCode": "94105",
        "country": "US"
      },
      "locationProvider": "greendot"
    }
  },
  "destination": {
    "type": "walletCrypto",
    "id": "wlt_5h4jzzpr9xre3bamd9ca7qyghn",
    "asset": "usdc",
    "network": "polygon",
    "details": {
      "address": "0x7b3a9f2c4d1ea8bf6390ce5d2b7fa104c8e3d9b1"
    }
  },
  "pricing": {
    "source": {
      "asset": "usd",
      "amount": "200.00"
    },
    "destination": {
      "asset": "usdc",
      "amount": "200.000000"
    },
    "fees": [],
    "exchangeRate": "1.0000",
    "fixedAmountSide": "source",
    "sponsorGas": true
  },
  "depositInstructions": {
    "cashInCode": "483 291"
  },
  "expiresAt": "2026-05-15T18:32:48Z",
  "createdAt": "2026-05-15T17:32:48Z",
  "updatedAt": "2026-05-15T17:32:48Z"
}

{
  "error": "InvalidAmountFormat",
  "code": 10016,
  "msg": "amount must be positive",
  "cause": "<string>"
}

{
  "error": "Unauthorized",
  "code": 1000,
  "msg": "unauthorized access",
  "cause": "<string>"
}

{
  "error": "CustomerNotFound",
  "code": 10001,
  "msg": "customer not found",
  "cause": "<string>"
}

{
  "error": "WalletNotFound",
  "code": 10015,
  "msg": "fiat wallet not found",
  "cause": "<string>"
}

{
  "error": "ConcurrentModification",
  "code": 10232,
  "msg": "pair changed since it was inspected; re-read its status and retry with the current version",
  "cause": "<string>"
}

{
  "error": "AccountHolderUnsupported",
  "code": 10022,
  "msg": "destination.details.accountHolder must be customer",
  "cause": "<string>"
}

{
  "error": "Internal",
  "code": 10124,
  "msg": "internal error",
  "cause": "<string>"
}

POST

cash-ins

Create a cash-in deposit code

curl --request POST \
  --url https://sandbox-api.polygon.technology/v0.13/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.13/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.13/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.13/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.13/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.13/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.13/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",
  "status": "pending",
  "customer": {
    "id": "cst_vfa0nxw6zvyws9g237jrxn4y7k"
  },
  "source": {
    "type": "cash",
    "asset": "usd",
    "details": {
      "locationId": "loc_01H9Xd",
      "locationName": "CVS Pharmacy #4521",
      "locationAddress": {
        "line1": "123 Main St",
        "city": "San Francisco",
        "state": "CA",
        "zipCode": "94105",
        "country": "US"
      },
      "locationProvider": "greendot"
    }
  },
  "destination": {
    "type": "walletCrypto",
    "id": "wlt_5h4jzzpr9xre3bamd9ca7qyghn",
    "asset": "usdc",
    "network": "polygon",
    "details": {
      "address": "0x7b3a9f2c4d1ea8bf6390ce5d2b7fa104c8e3d9b1"
    }
  },
  "pricing": {
    "source": {
      "asset": "usd",
      "amount": "200.00"
    },
    "destination": {
      "asset": "usdc",
      "amount": "200.000000"
    },
    "fees": [],
    "exchangeRate": "1.0000",
    "fixedAmountSide": "source",
    "sponsorGas": true
  },
  "depositInstructions": {
    "cashInCode": "483 291"
  },
  "expiresAt": "2026-05-15T18:32:48Z",
  "createdAt": "2026-05-15T17:32:48Z",
  "updatedAt": "2026-05-15T17:32:48Z"
}

{
  "error": "InvalidAmountFormat",
  "code": 10016,
  "msg": "amount must be positive",
  "cause": "<string>"
}

{
  "error": "Unauthorized",
  "code": 1000,
  "msg": "unauthorized access",
  "cause": "<string>"
}

{
  "error": "CustomerNotFound",
  "code": 10001,
  "msg": "customer not found",
  "cause": "<string>"
}

{
  "error": "WalletNotFound",
  "code": 10015,
  "msg": "fiat wallet not found",
  "cause": "<string>"
}

{
  "error": "ConcurrentModification",
  "code": 10232,
  "msg": "pair changed since it was inspected; re-read its status and retry with the current version",
  "cause": "<string>"
}

{
  "error": "AccountHolderUnsupported",
  "code": 10022,
  "msg": "destination.details.accountHolder must be customer",
  "cause": "<string>"
}

{
  "error": "Internal",
  "code": 10124,
  "msg": "internal error",
  "cause": "<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

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

The cash 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 (walletCrypto 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

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

status

enum<string>

required

Current lifecycle status of the cash-in.

Available options:

pending,

processing,

completed,

failed,

expired,

cancelled

customer

object

required

The customer that owns this record.

Hide child attributes

customer.id

string

required

The customer id (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

Cash · object

required

The retail location the customer deposits cash at.

Hide child attributes

source.type

enum<string>

required

Available options:

cash

source.asset

string

required

Lowercase asset.

source.details

object

Cash location details.

Hide child attributes

source.details.locationId

string

source.details.locationName

string

source.details.locationAddress

object

A postal address. country is an ISO 3166-1 alpha-2 country code.

Hide child attributes

source.details.locationAddress.line1

string

Street address, line 1.

source.details.locationAddress.line2

string

Street address, line 2.

source.details.locationAddress.city

string

City.

source.details.locationAddress.state

string

State / province / region.

source.details.locationAddress.country

string

ISO 3166-1 alpha-2

source.details.locationAddress.zipCode

string

ZIP / postal code.

source.details.locationProvider

string

The cash network the location belongs to, lowercase, such as greendot.

destination

OMS wallet · object

required

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

OMS wallet
External wallet

Hide child attributes

destination.type

enum<string>

required

Available options:

walletCrypto

destination.asset

string

required

Lowercase asset.

destination.network

string

required

Lowercase blockchain.

destination.id

string

The wallet (wlt_); an older wallet keeps its original wlt_<uuid> id. Left out while a deposit's receiving wallet is not resolved yet.

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.owner

object

Who owns an account that is not the resource's customer's.

Hide child attributes

destination.owner.kind

enum<string>

required

counterparty, or customer for another customer's account.

Available options:

counterparty,

customer

destination.owner.id

string

required

The counterparty (ctp_) or customer (cst_).

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.owner.name

string

The counterparty's name. A customer's name is on the customer resource.

destination.details

object

OMS crypto wallet details.

Hide child attributes

destination.details.address

string

On-chain address.

depositInstructions

object

required

The code the customer presents at the retail location.

Hide child attributes

depositInstructions.cashInCode

string

required

Machine-readable code the customer presents at the register.

pricing

object

required

The cash amount, what arrives in the wallet, the rate and the fees. pricing.source.amount is the indicated amount before the cash is paid, then the amount authorised at the register once the cash is paid.

Hide child attributes

pricing.fees

object[]

required

Every fee charged across both sides. [] when there are none — never omitted, never null.

Hide child attributes

pricing.fees.type

string

required

Fee kind. OPEN — clients must tolerate an unrecognised type. Known values today: "developer", "oms", "gas", "retailer" (a cash provider's retail fee, on CashIn.providerFee), "exchange" (the exchange fee the crypto purchase realized, on the linked transaction once it completes).

pricing.fees.side

enum<string>

required

Which side this fee was deducted from.

Available options:

source,

destination

pricing.fees.asset

string

required

Currency this fee is denominated in — that side's asset.

pricing.fees.amount

string

required

Fee amount in asset, at the asset's precision.

pricing.source

object

The source side, in the source asset.

Hide child attributes

pricing.source.asset

string

required

Lowercase asset of this side, the same as the side's instrument asset.

pricing.source.amount

string

On the source, the gross amount the customer pays; on the destination, the amount that arrives. A decimal string at the asset's precision. Always set on the source; set on the destination once priced.

pricing.destination

object

The destination side, in the destination asset.

Hide child attributes

pricing.destination.asset

string

required

Lowercase asset of this side, the same as the side's instrument asset.

pricing.destination.amount

string

pricing.exchangeRate

string

Mid-market rate from the source asset to the destination asset, set together with the destination amount. Identity: (source.amount − Σ source fees) × exchangeRate = destination.amount + Σ destination fees.

pricing.fixedAmountSide

enum<string>

The side whose amount was fixed at creation. OMS calculated the other side.

Available options:

source,

destination

Present and true when OMS absorbs the destination gas cost; omitted otherwise.

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.

Hide child attributes

failure.code

enum<string>

required

What went wrong.

Available options:

providerError,

providerRejected,

providerTimeout,

expired,

systemError,

provisioningTimeout,

insufficientFunds,

providerAmountBelowMinimum,

limitExceeded,

outsideSellBounds,

outsideSellVelocityBounds,

unusableAmount,

unsupportedCorridor,

outgoingRailNotEnabled,

ssnNotVerified,

riskRejected,

cardDeclined,

bankSellDeclined,

payoutFailed,

priceMoved,

returningToSender,

returnedToSender,

returnFailed,

depositFailed,

attributionTimeout,

assetMismatch,

chainMismatch,

misattributedArrival,

depositAddressNotActive,

virtualAccountNotActive,

counterpartyArchived,

destinationUnavailable,

walletClaimed,

walletBoundToCustodialFlow,

projectSuspended,

memoInvalid,

cashDepositFailed,

noMatchingNetwork,

blockchainAddressInUse,

bankAccountInUse,

bankAccountRejected,

deletePendingTimeout,

providerAccountMissing,

cardInUse,

cardLimitReached,

countryProhibited,

countryNotSupported,

cardVerificationDeclined,

bankVerificationDeclined,

accountClosed,

accountFrozenByBank,

routingOrAccountNumberInvalid,

accountHolderDeceased,

accountDoesNotSupportTransfers,

payeeNameMismatch,

walletUnreachableOnNetwork,

billingAddressMismatch,

cardExpired,

cardClosedOrLostStolen,

pushToCardUnsupported,

cardDeclinedByIssuer

failure.message

string

required

A fixed, vendor-neutral sentence for code.

failure.retryable

boolean

required

Whether trying the same thing again can succeed.

failure.bankCode

string

The bank's own return code, only on an external account a bank return made invalid.

providerFee

object

The cash provider's retail fee, paid at the register on top of the cash amount and not part of pricing. Absent when the provider charges none, or when its fee could not be recorded; the raw template response keeps the original value.

Hide child attributes

providerFee.type

string

required

providerFee.side

enum<string>

required

Which side this fee was deducted from.

Available options:

source,

destination

providerFee.asset

string

required

Currency this fee is denominated in — that side's asset.

providerFee.amount

string

required

Fee amount in asset, at the asset's precision.

transactionId

string

The Transaction linked to this cash-in. Set once the linked transaction exists; 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.

Hide child attributes

metadata.{key}

string

completedAt

string<date-time>

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

consumedAt

string<date-time>

Leg 1 start: when the customer scanned the cash-in code at the retail location.

fulfilledAt

string<date-time>

Leg 1 done: when the cash was loaded and the provider can no longer cancel it.

buyConfirmedAt

string<date-time>

Leg 2 done: when the crypto purchase was confirmed.

Overview

Move money

Routes

External Payment Methods

Platform

Read onchain data

Create a cash-in deposit code

Authorizations

Headers

Body

Response