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

# Payouts APIs

## Prerequisites

Before using the Payouts 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> <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 Payouts 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><th data-hidden data-card-target data-type="content-ref"></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="https://content.gitbook.com/content/wm1DIvbGMREWT1TdLPtz/blobs/O2IPnGNAlwUzG7PQqKNQ/payram-create-payouts.png">payram-create-payouts.png</a></td><td><a href="https://docs.payram.com/api-integration/payouts-apis/create-payouts">https://docs.payram.com/api-integration/payouts-apis/create-payouts</a></td></tr><tr><td>GET Single Payout</td><td>Retrieve a single payout record with their details and statuses from your PayRam server.</td><td><a href="https://3861722996-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fwm1DIvbGMREWT1TdLPtz%2Fuploads%2FVB9XHt1vRKLLTG29OIOS%2Fpayram-get-single-payouts.png?alt=media&amp;token=0bab443a-ad4f-4932-95a5-5c006f4aa11c">payram-get-single-payouts.png</a></td><td><a href="https://docs.payram.com/api-integration/payouts-apis/get-single-payout">https://docs.payram.com/api-integration/payouts-apis/get-single-payout</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="https://content.gitbook.com/content/wm1DIvbGMREWT1TdLPtz/blobs/Fq1maV6gVj5kWHP3S2lH/payram-get-all-payouts.png">payram-get-all-payouts.png</a></td><td><a href="https://docs.payram.com/api-integration/payouts-apis/get-all-payouts">https://docs.payram.com/api-integration/payouts-apis/get-all-payouts</a></td></tr><tr><td>Overview</td><td>Base URL, authentication, supported networks and the payout status lifecycle.</td><td><a href="https://3861722996-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fwm1DIvbGMREWT1TdLPtz%2Fuploads%2FTh2uijiaNvL6SpgUdQPj%2Fpayram-payout-overview.png?alt=media&amp;token=e0af03f8-84a6-42a2-990d-86379c5047f8">payram-payout-overview.png</a></td><td><a href="https://docs.payram.com/api-integration/payouts-apis/overview">https://docs.payram.com/api-integration/payouts-apis/overview</a></td></tr><tr><td>Payout Webhooks</td><td>Receive payout status changes on your server instead of polling.</td><td><a href="https://3861722996-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fwm1DIvbGMREWT1TdLPtz%2Fuploads%2FfMzCdIIas8FjEOQAnO7q%2Fpayram-payout-webhooks.png?alt=media&amp;token=517d83f2-671f-47a4-bc20-da3de7cead6b">payram-payout-webhooks.png</a></td><td><a href="https://docs.payram.com/api-integration/payouts-apis/payout-webhooks">https://docs.payram.com/api-integration/payouts-apis/payout-webhooks</a></td></tr><tr><td>Approving Held Payouts</td><td>Approve or reject a payout that exceeded your limits.</td><td><a href="https://3861722996-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fwm1DIvbGMREWT1TdLPtz%2Fuploads%2Fuxr7rUZySL3kig3L72mU%2Fpayram-payout-approving.png?alt=media&amp;token=1dba0c21-4b3c-4687-a6ac-95504a548d6f">payram-payout-approving.png</a></td><td><a href="https://docs.payram.com/api-integration/payouts-apis/approving-held-payouts">https://docs.payram.com/api-integration/payouts-apis/approving-held-payouts</a></td></tr><tr><td>Editing Payout Limits</td><td>Set auto-approve, hourly, daily and minimum amounts per project.</td><td><a href="https://3861722996-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fwm1DIvbGMREWT1TdLPtz%2Fuploads%2FOWai7VNaCT4UnssyLPYE%2Fpayram-payout-editing.png?alt=media&amp;token=c3c6119d-99af-4f77-a15b-0763e79715c4">payram-payout-editing.png</a></td><td><a href="https://docs.payram.com/api-integration/payouts-apis/editing-payout-limits">https://docs.payram.com/api-integration/payouts-apis/editing-payout-limits</a></td></tr></tbody></table>