Sends crypto from a customer's wallet to an external wallet.

Initiating a Send Request

A REST request initiates a send, which returns the transaction ID for tracking purposes.

Sample API Request: POST

URL: https://caas-staging.coinme.com/services/send
headers:
"Authorization":"asdfghj", //authorization token, required
'User-Agent: partnerapi' //required
Request Body:
{
  "partnerTransactionId": "ABC1234",//Id of the transaction, optional
  "customerId":"123456789", //customer id of the sender, required
  "destinationWalletAddress":"abcdef1234567890", //destination wallet address, required
   "amount": "1.23", //amount to send, required
  "currency": "BTC", // currency of the amount to send, required
  "cryptoChain": null, //chain over which to send the asset, eg. there is USDC over ETH and USDC over XLM, optional
  "blockchainTag": null, //additional wallet identifier, optional
  "note": "Payment for X" //additional transaction information, optional
}

Sample API Response:

{
	"partnerTransactionId": "ABC1234"
}

Notification: Send result

A notification is sent when the send completes, indicating whether it succeeded or failed.

Example notification:

{
  "id": "682d4720-5132-4b58-afcc-dfd15a766e59",
  "type": "CAAS",
  "data": {
    "type": "SEND",
    "status": "COMPLETED | FAILED",
    "partnerTransactionId": "ABC1234",
    "metadata": {
    "destinationWalletAddress": "abcdef1234567890",
    "sendAsset": {
      "amount": "1.23",
      "currency": "BTC"
    },
    "fee": {
      "amount": "0.000001",
      "currency": "BTC"
    },
    "blockchainTransactionId": "abc123def456ghi789"
    "blockchainTag": null,
    "note": "Payment for X"
		}
  },
  "at": "2024-02-28T10:15:30Z"
}