> For the complete documentation index, see [llms.txt](https://docs.oxapay.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.oxapay.com/api-reference/payout/generate-payout.md).

# Generate Payout

This endpoint enables you to generate a cryptocurrency payout request, allowing you to transfer funds to a specified address. It is designed to facilitate seamless and secure transactions by generating a payout request within your account.

## POST /payout

>

```json
{"openapi":"3.0.0","info":{"title":"Payouts","version":"1.0.0"},"servers":[{"url":"https://api.oxapay.com/v1"}],"security":[],"paths":{"/payout":{"post":{"operationId":"generatePayout","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["address","currency","amount"],"properties":{"address":{"type":"string","description":"The recipient's cryptocurrency address where the payout will be sent."},"currency":{"type":"string","description":"The symbol of the cryptocurrency to be sent (e.g., BTC, ETH, LTC, etc.)."},"amount":{"type":"number","format":"decimal","description":"The exact amount of cryptocurrency to be sent as the payout."},"network":{"type":"string","description":"The blockchain network to be used for the payout. Required for currencies with multiple supported networks."},"callback_url":{"type":"string","format":"uri","description":"The URL for sending payment status updates."},"memo":{"type":"string","description":"A memo or tag for transactions on supported networks (e.g., for GRAM)."},"description":{"type":"string","description":"A description or additional information for the payout, useful for reports."}}}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"track_id":{"type":"string","description":"The unique identifier for the pay in the OxaPay payment gateway. You can use this track ID to query the payment status and generate reports."},"status":{"type":"string","description":"The status of payout transaction."}}},"message":{"type":"string","description":"A message containing additional information about the result of the request."},"error":{"type":"object","description":"An object that provides details about any errors that occurred.","nullable":true,"properties":{"type":{"type":"string","description":"Type of the error"},"key":{"type":"string","description":"Key related to the error"},"message":{"type":"string","description":"Error message"}}},"status":{"type":"integer","description":"The status of the request response. Typically provided as a numeric code (e.g., 200 for success or other codes for errors)."},"version":{"type":"string","description":"The version of the API being used."}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"message":{"type":"string","description":"A message containing additional information about the result of the request."},"error":{"type":"object","description":"An object that provides details about any errors that occurred.","nullable":true,"properties":{"type":{"type":"string","description":"Type of the error"},"key":{"type":"string","description":"Key related to the error"},"message":{"type":"string","description":"Error message"}}},"status":{"type":"integer","description":"The status of the request response. Typically provided as a numeric code (e.g., 200 for success or other codes for errors)."},"version":{"type":"string","description":"The version of the API being used."}}}}}}},"tags":["Generate-payout"],"parameters":[{"in":"header","name":"payout_api_key","required":true,"schema":{"type":"string"},"description":"Your Payout API Key for authentication and authorization."},{"in":"header","name":"Content-Type","required":true,"schema":{"type":"string","default":"application/json"}}]}}}}
```


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.oxapay.com/api-reference/payout/generate-payout.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.