> For the complete documentation index, see [llms.txt](https://docs.aquanow.io/pay/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.aquanow.io/pay/api-endpoints/payouts-api.md).
# Payouts API
### General Information
## Create Payout
`POST` `https://api.aquanow.io/accounts/v1/transaction`
Generate a payout transaction.
#### Request Body
| Name | Type | Description |
| ------------------------------------------------- | ------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| address\* | string | Address you wish to withdraw to |
| accountId\* | string | e.g., `CA1000012R` Specify the `accountId` of the account you wish to make the transaction for |
| deliverCurrency\* | string | Currency delivered by user to be traded. |
| deliverQuantity\* | string | NOTE: Specify either deliverQuantity or receiveQuantity.
Quantity of currency delivered by user.
|
| receiveCurrency\* | string | Currency you wish to withdraw |
| transactionType\* | "PAYOUT" | must be payout |
| 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.
|
| referenceId\* | string | Reference Id for a saved counterparty.
You must either:
Create a counterparty beforehand and use the referenceId
OR
Provide a referenceId (unique) that you can attach your PII information to.
|
| walletType\* | "SELF\_HOSTED" \| "VASP" \| "OTHER" | Required if using an address not part of the addressbook and the deliverCurrency is a cryptocurrency. The type of wallet being provided. |
| vaspId | uuid | Required IF walletType is "VASP".
ID of the VASPs hosting the recipient’s wallet. You can either fetch the list of ids from our vasps endpoint, or specify "SELF\_HOSTED" or UNKNOWN if not in the list.
List of VASPs can be found in the /pages/JoT5VG9JqN4B0al0EhST section.
|
| kycInfo\* | [object](/pay/data-objects-and-statuses/kyc.md#kycinfoobject) | PII Data required for KYC. This is required ONLY if you have provided a referenceId that is not already in the system. |
{% tabs %}
{% tab title="200 : Success" %}
```javascript
{
"orderId": "e324ca67-5eb1-47bd-aa11-6c3ba7e5afb8",
"txId": "9d5955ff-6142-4ace-80da-3c860c1c4821",
"transactionType": "PAYOUT",
"status": "PROCESSING",
"username": "woojpay",
"accountId": "CA1001112C",
"symbol": "USDT",
"address": "0x279FEC0A6Dd30be27D88E837a1f8cC59bD2Bfc07",
"deliverQuantity": 10,
"receiveQuantity": 10.00171,
"deliverCurrency": "USD",
"receiveCurrency": "USDT",
"networkFee": 0,
"itemDateTime": 1740625055711,
"referenceId": "clientid231",
"networkType": "ETH",
"quoteTime": 1740625055691,
"expireTime": 1740625083691
}
```
{% endtab %}
{% tab title="400 Provide Wallet Host" %}
{% endtab %}
{% tab title="Provide Reference" %}
{% endtab %}
{% endtabs %}
## Execute Request
`POST` `https://api.aquanow.io/trades/v1/executeQuote`
Generate a bill under an invoice to get address
#### Request Body
| Name | Type | Description |
| ----------------------------------------- | ------ | --------------------------------------------------------- |
| quoteId\* | String | the orderId generated by the create payout endpoint above |
{% tabs %}
{% tab title="200 Success" %}
```
{
"type": "rfqExecuteQuoteAck",
"payload": {
"accountId": "CA1001112C",
"quoteId": "5ae24810-5f97-4a81-b15b-7ddf7b678f7a",
"tradeDate": "2025-02-27",
"valueDate": "2025-02-28"
}
}
```
{% endtab %}
{% tab title="400 Quote Expired" %}
```
{
"message":"The quote has already expired"
}
```
{% endtab %}
{% endtabs %}
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://docs.aquanow.io/pay/api-endpoints/payouts-api.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.