# Payments API

***

<figure><img src="https://content.gitbook.com/content/wm1DIvbGMREWT1TdLPtz/blobs/CallR4LiFOh4qXvz21xp/payram-payments-api.png" alt=""><figcaption></figcaption></figure>

## 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 Pay,ments 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><strong>Create Payment</strong></td><td>Create a payment link for customers using the PayRam API.</td><td><a href="https://content.gitbook.com/content/wm1DIvbGMREWT1TdLPtz/blobs/x56GsGsbGOGBWmMJC2yw/payram-payment-apis-create-payment.png">payram-payment-apis-create-payment.png</a></td></tr><tr><td><strong>Fetch Tickers</strong></td><td>Fetch supported tickers and token options using the PayRam API.</td><td><a href="https://content.gitbook.com/content/wm1DIvbGMREWT1TdLPtz/blobs/nzh0TSnDEazDI5HOYtVU/payram-payment-apis-create-payment%20(2).png">payram-payment-apis-create-payment (2).png</a></td></tr><tr><td><strong>Get Blockchain Currencies</strong></td><td>Fetch blockchain deposit options using a payment’s reference ID.</td><td><a href="https://content.gitbook.com/content/wm1DIvbGMREWT1TdLPtz/blobs/lFo1Aof5UsSuwodjju9o/payram-payment-apis-get-blockchain-currencies.png">payram-payment-apis-get-blockchain-currencies.png</a></td></tr><tr><td><strong>Assign Deposit Address</strong></td><td>Assign a static deposit address to a user for a specific blockchain.</td><td><a href="https://content.gitbook.com/content/wm1DIvbGMREWT1TdLPtz/blobs/4wTeL86ZviiN3VkCxCod/payram-payment-apis-assign-deposit-address.png">payram-payment-apis-assign-deposit-address.png</a></td></tr><tr><td><strong>Payment Status</strong></td><td>Fetch the current payment status using a payment’s reference ID.</td><td><a href="https://content.gitbook.com/content/wm1DIvbGMREWT1TdLPtz/blobs/txWxC3Fhsyt4MylRugMg/payram-payment-payment-status.png">payram-payment-payment-status.png</a></td></tr></tbody></table>
