Skip to main content
POST
/
v1
/
asset-deposits
Create a new Asset Deposit transaction
curl --request POST \
  --url https://sandbox-api.borderless.xyz/v1/asset-deposits \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "asset": "BTC",
  "amount": "1.500",
  "accountId": "cm9db4g2s2r7ro224ra6u1qvd",
  "counterPartyIdentityId": "cm6db4g2s2r7ro224ra6u1gvl"
}
'
{
  "id": "<string>",
  "type": "AssetDeposit",
  "status": "Submitted",
  "source": {
    "asset": "POL",
    "amount": "<string>",
    "fiatCurrency": "<string>",
    "accountId": "<string>"
  },
  "destination": {
    "asset": "POL",
    "amount": "<string>",
    "fiatCurrency": "<string>",
    "imad": "<string>",
    "omad": "<string>",
    "traceNumber": "<string>",
    "externalAddress": "<string>",
    "accountId": "<string>",
    "paymentInstructionId": "<string>"
  },
  "instructions": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "txHash": [
    "<string>"
  ],
  "feeAmount": {},
  "failureReason": {},
  "depositInstruction": {
    "paymentMethod": "ACH",
    "details": {
      "depositMessage": "<string>",
      "bankAccountNumber": "<string>",
      "bankRoutingNumber": "<string>",
      "bankBeneficiaryName": "<string>",
      "bankBeneficiaryAddress": "<string>",
      "bankName": "<string>",
      "bankAddress": "<string>"
    }
  },
  "counterPartyIdentityId": "<string>",
  "developerFeeAmount": {}
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
asset
enum<string>
required

The token tied to a specific blockchain to be deposited. See the list of supported Assets.

Available options:
BTC,
ETH,
CELO,
POL,
SOL,
TRX,
ETH_BASE,
ETH_OPTIMISM,
USDC_POLYGON,
USDT_POLYGON,
USDT_TRON
Example:

"BTC"

​
amount
string
required

The amount to deposit, provided as a decimal number

Example:

"1.500"

​
accountId
string
required

The id of the account where the deposit will be made.

Example:

"cm9db4g2s2r7ro224ra6u1qvd"

​
counterPartyIdentityId
string

The ID of the counterparty identity on whose behalf the deposit is made. This field is required if the deposit amount exceeds the equivalent of $50,000. Learn more at Compliance Requirements.

Example:

"cm6db4g2s2r7ro224ra6u1gvl"

Response

Successfully created Asset Deposit transaction data.

​
id
string
required
​
type
enum<string>
required
Available options:
AssetDeposit,
Deposit,
Withdrawal,
Transfer,
TransferToExternalWallet,
Swap,
Approval
​
status
enum<string>
required
Available options:
Submitted,
Verifying,
Orchestrating,
Pending,
Processing,
Completed,
Failed,
Cancelled
​
source
object
required
​
destination
object
required
​
instructions
object
required
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
txHash
string[]
required
​
feeAmount
object
required
​
failureReason
object
required
​
depositInstruction
object
required
​
counterPartyIdentityId
string | null
required
​
developerFeeAmount
object
required