Create Transactions

Create Crypto or Fiat transactions

Request a crypto withdrawal

POST https://api.aquanow.io/accounts/v1/transaction

To view example requests for this endpoint, visit Aquanow's Postman documentation.

Headers

Name	Type	Description
x-api-key*	String	{{x-api-key}} API Auth Key
x-signature*	String	49c6260c194f4d7ed5cb917dc70b9821673246b2abc1cf28f05df6a75fd24181e00f8e57b321d15ae45db58b3bffe27a Signature created using your API secret
x-nonce*	Number	1618307861949 Timestamp in millisecond
Content-Type*	String	application/json

Request Body

Name	Type	Description
symbol*	String	e.g., BTC All uppercase letters, the crypto currency you are withdrawing.
address*	String	Destination address you are withdrawing to.
accountId*	String	e.g., CA1000012R Specify the accountId of the account you wish to make the transaction for
transactionType*	String	e.g., WITHDRAW Type of transaction. NOTE: Currently, we only support WITHDRAW requests
quantity	Number	The net amount of funds to be withdrawn. This is the amount that will be received after any applicable withdrawal fees have been deducted. e.g if USDC quantity of 10,000 is inputted and withdrawal fee is 5 USDC, the balance will decrease by 10,005 and 10,000 will be sent to destination address Must provide quantity OR grossQuantity NOTE: You must have sufficient funds to be able to withdraw.
grossQuantity	Number	The gross amount of funds to be withdrawn before deduction of any fees. This refers to the total amount that will be debited from the user's account. e.g if USDC quantity of 10,000 is inputted and withdrawal fee is 5 USDC, the balance will decrease by 10,000 and 9,995 will be sent to destination address Must provide quantity OR grossQuantity NOTE: You must have sufficient funds to be able to withdraw.
currencyTag	String	Additional address property (Tag/Memo) that allows identifying the transfer beneficiary or destination for a transaction.
tag	String	Additional reference id that you can send with a withdrawal request.
networkType	String	e.g., ETH Specify a networkType for symbols that support multiple networks. One of ETH, TRON,XLM, FTM, MATIC NOTE: Only applicable to USDT, USDC, MATIC, and FTM coins.
message	String	Additional field to add any messages/notes.
status	String	e.g., DONE Denotes the status of the withdrawal. Can be one of DONE or PROCESSING
txHash	String	e.g.,70a867671a6e01e91f5888d800d3978e2ec9aec6770740572a0a485b7d4b6629 Specify the txHash (transactions hash) for transactions that are DONE NOTE: This does not create a new transaction on the blockchain.

200: OK Create transaction with quantity

Returns a TransactionObject.

{
  "accountId": "CA1000051R",
  "networkType": "btc",
  "address": "bc1q8k5508tfz299v7ywxj8j4g4p9hkn6n06xndv0d",
  "quantity": 0.005,
  "bankInfo": {},
  "txId": "602e187d-8238-4c1b-80d4-89aab383c5a9",
  "symbol": "BTC",
  "username": "helloWorld",
  "networkFee": 0.0001,
  "message": "A message",
  "originUser": "helloWorldUser",
  "source": "api",
  "transactionType": "WITHDRAW",
  "ipAddress": "38.111.102.138",
  "itemDateTime": 1712614805853,
  "isAutopilotAddress": false,
  "adminApproval": "PROCESSING"
}

400: Bad Request Missing address

{
    "message": "Please provide an address"
}

400: Bad Request Insufficient funds

{
    "message": "Insufficient Funds"
}

200: OK Create transaction with tag

Returns a TransactionObject.

{
  "retroActive": true,
  "networkType": "xrp",
  "address": "rNXQc5mT7b336bFTkenFTPiF5TYuyrJ3ZH",
  "quantity": 100,
  "bankInfo": {},
  "txId": "cca72591-db39-4f06-b483-364b73eac43c",
  "symbol": "XRP",
  "tag": "some-id-1-reference",
  "username": "helloWorld",
  "goToAdmin": true
}

200: OK Create transaction with currencyTag

Returns a TransactionObject.

{
  "itemDateTime": 1667204771386,
  "networkType": "xrp",
  "address": "rNXQc5mT7b336bFTkenFTPiF5TYuyrJ3ZH",
  "quantity": 100,
  "bankInfo": {},
  "currencyTag": "2307171792",
  "txId": "730b96c4-729e-460f-93e6-96af0a045ab7",
  "symbol": "XRP",
  "username": "helloWorld",
  "freeOrNot": true,
  "transactionType": "WITHDRAW",
  "isAutopilotAddress": false,
  "adminApproval": "PROCESSING",
  "createdAt": 1667204771386,
  "updatedAt": 1667204771386
}

400: Bad Request Invalid networkType

{
    "message": "Provided network type does not exist"
}

400: Bad Request Both grossQuantity and quantity in same request body

{
    "message": "Conflicting parameters provided. Please specify either 'grossQuantity' or 'quantity', but not both."
}

200: OK Create transaction with grossQuantity

Returns a TransactionObject.

{
  "retroActive": true,
  "networkType": "xrp",
  "address": "rNXQc5mT7b336bFTkenFTPiF5TYuyrJ3ZH",
  "grossQuantity": 1000,
  "networkFee": 100,
  "quantity": 900,
  "bankInfo": {},
  "txId": "cca72591-db39-4f06-b483-364b73eac43c",
  "symbol": "XRP",
  "tag": "some-id-1-reference",
  "username": "helloWorld",
  "goToAdmin": true
}

Request a FIAT withdrawal

POST https://api.aquanow.io/accounts/v1/transaction

To view example requests for this endpoint, visit Aquanow's Postman documentation.

Headers

Name	Type	Description
x-api-key*	String	{{x-api-key}} API Auth Key
x-signature*	String	32c92460f65cbb78d0eaf9a4361fb6b0a2bb8bb4c40f531e9974a0afc12d9a328b5ff621a544d242ee9ba1dfa799c85a Signature created using your API secret
x-nonce*	Number	1657731573930 Timestamp in millisecond
Content-Type*	String	application/json

Request Body

Name	Type	Description
symbol*	String	e.g., USD All uppercase letters, the FIAT currency you are withdrawing.
transactionType*	String	WITHDRAW Type of transaction NOTE: Currently, we only support WITHDRAW.
addressId*	String	Destination banking information you are withdrawing to. NOTE: addressId is only required if you have multiple banking information stored.
accountId*	String	e.g., CA1000012R Specify the accountId of the account you wish to make the transaction for
quantity	Number	The net amount of funds to be withdrawn. This is the amount that will be received after any applicable withdrawal fees have been deducted. Must provide quantity OR grossQuantity NOTE: You must have sufficient funds to be able to withdraw.
grossQuantity	String	The gross amount of funds to be withdrawn before deduction of any fees. This refers to the total amount that will be debited from the user's account. Must provide quantity OR grossQuantity NOTE: You must have sufficient funds to be able to withdraw.

200: OK Create transaction

{
    "accountId": "CA1000051R",
    "networkType": "fiat",
    "address": "bc1q8k5508tfz299v7ywxj8j4g4p9hkn6n06xndv0d",
    "quantity": 1000,
    "bankInfo": {
        "symbol": "USD",
        "intermediaryBankAddress": "",
        "addressCreatedAt": 1706205259851,
        "transitNumber": "",
        "verified": true,
        "swiftCode": "SWIFT123",
        "bankName": "testBank",
        "label": "test1",
        "accountNumber": "123456",
        "beneficiaryAddress": "ben test address",
        "routingAbaNumber": "1234567890",
        "bankAddress": "test bank address",
        "intermediaryBank": "",
        "institutionNumber": "",
        "intermediarySwftBicCode": "",
        "beneficiaryName": "ben testName",
        "referenceCode": ""
    },
    "txId": "a2b2a320-e2eb-40e5-8372-12d162eabaad",
    "symbol": "USD",
    "username": "helloWorld",
    "networkFee": 1,
    "message": "A message",
    "originUser": "helloWorldUser",
    "source": "api",
    "transactionType": "WITHDRAW",
    "ipAddress": "38.111.102.138",
    "itemDateTime": 1712615261753,
    "isAutopilotAddress": false,
    "adminApproval": "PROCESSING"
}

200: OK Create transaction with grossQuantity

{
    "accountId": "CA1000101R",
    "networkType": "fiat",
    "address": "bc1q8k5508tfz299v7ywxj8j4g4p9hkn6n06xndv0d",
    "quantity": 999,
    "grossQuantity": 1000,
    "bankInfo": {
        "symbol": "USD",
        "intermediaryBankAddress": "",
        "addressCreatedAt": 1706205259851,
        "transitNumber": "",
        "verified": true,
        "swiftCode": "SWIFT123",
        "bankName": "testBank",
        "label": "test1",
        "accountNumber": "123456",
        "beneficiaryAddress": "ben test address",
        "routingAbaNumber": "1234567890",
        "bankAddress": "test bank address",
        "intermediaryBank": "",
        "institutionNumber": "",
        "intermediarySwftBicCode": "",
        "beneficiaryName": "ben testName",
        "referenceCode": ""
    },
    "txId": "9f6b2c44-ec5d-45b5-bfbf-f1846f5c3b5c",
    "symbol": "USD",
    "username": "helloWorld",
    "networkFee": 1,
    "message": "A message",
    "originUser": "helloWorldUser",
    "source": "api",
    "transactionType": "WITHDRAW",
    "ipAddress": "38.111.102.138",
    "itemDateTime": 1712615594968,
    "isAutopilotAddress": false,
    "adminApproval": "PROCESSING"
}

400: Bad Request Unspecified address (multiple active addresses)

{
    "message": "Multiple fiat address detected. Please provide an addressId"
}

400: Bad Request Insufficient funds

{
    "message": "Insufficient Funds"
}

400: Bad Request Missing address

{
    "message": "Please provide an address"
}

400: Bad Request Invalid transactionType

{
    "message": "must be equal to one of the allowed values"
}

400: Bad Request Both grossQuantity and quantity in same request body

{
    "message": "Conflicting parameters provided. Please specify either 'grossQuantity' or 'quantity', but not both."
}