# Payouts APIs

## Prerequisites

Before using the User Payout APIs, make sure you have the following:

* A PayRam server that is properly hosted and running.
* A valid API Key generated from the PayRam dashboard for authentication.

{% hint style="info" %} <mark style="color:$warning;">**Note**</mark>**&#x20;**<mark style="color:$success;">**: You can generate a unique API key for each project directly from the PayRam dashboard. This helps you manage and track payouts separately for every project.**</mark>
{% endhint %}

***

## API Endpoints

These are the current endpoints required for the User Payout API integration, listed below.

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-cover data-type="image">Cover image</th></tr></thead><tbody><tr><td>Create Payouts</td><td>Create a payout to send funds to a recipient’s wallet on the chosen blockchain.</td><td><a href="/files/MQq54uAjmsMwG3Ym96fc">/files/MQq54uAjmsMwG3Ym96fc</a></td></tr><tr><td>Payouts Status</td><td>Check the current payout status using a withdrawal ID.</td><td><a href="/files/nMmDP4ik9gczjFNiIYdc">/files/nMmDP4ik9gczjFNiIYdc</a></td></tr><tr><td>GET All Payouts</td><td>Retrieve all payout records with their details and statuses from your PayRam server.</td><td><a href="/files/BZHmM6IlHqlBUYGHxviw">/files/BZHmM6IlHqlBUYGHxviw</a></td></tr></tbody></table>


---

# Agent Instructions: 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:

```
GET https://docs.payram.com/api-integration/payouts-apis.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
