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

# Payment API

This section of the Carouseller Payment API documentation includes key information on how to integrate payment functionalities. It covers the processes for obtaining keys, handling deposits, and managing payouts. Each subsection provides technical details and guidelines essential for developers to implement payment features in their applications using Carouseller's API.

## **Key Obtaining**

This section details how to obtain a session key necessary for further API interactions. It requires sending a request with parameters such as `site_id`, `site_login`, `customer_ip`, `currency`, and a SHA-1 `signature`. The response provides a session key if the request is successful.

{% content-ref url="/pages/YWJeZTXCwodBJZFA1TFd" %}
[Obtaining API Keys](/carouseller/cashier-integration/obtaining-api-keys.md)
{% endcontent-ref %}

## Deposit

This part describes the process for making a deposit through the API. Key parameters include `session_key`, `external_id`, `group`, `amount`, `card_number`, `valid_thru_month`, `valid_thru_year`, `cvv`, and `card_holder`. The section provides examples of requests and possible responses, including success and error messages​.

{% content-ref url="/pages/hmYlDFXkmZwGlbCs9s98" %}
[Deposit](/carouseller/payment-api/deposit.md)
{% endcontent-ref %}

## Payout

Similar to deposits, this subsection explains how to process payouts. Required parameters include `session_key`, `order_ref`, `group`, `amount`, `card_number`, `valid_thru_month`, `valid_thru_year`, `card_holder`, `site_login`, `site_id`, and `signature`. Examples of requests and responses are provided to illustrate different scenarios​.

{% content-ref url="/pages/vl47K4TMKXuMysK3Vz5T" %}
[Payout](/carouseller/payment-api/payout.md)
{% endcontent-ref %}