Skip to main content
The Payout API allows you to manage and automate payouts to your users or vendors. With this API, you can create, retrieve, update, and delete payout transactions, as well as manage payout methods and schedules. The Payout API is designed to streamline the payout process, ensuring timely and accurate payments while providing flexibility to accommodate various business needs.

​
Key Features

  • Create Payouts: Initiate payouts to users or vendors with specified amounts and currencies.
  • Retrieve Payouts: Fetch details of individual payouts or a list of all payouts.
  • Update Payouts: Modify payout details such as status or amount.
  • Delete Payouts: Remove payouts that are no longer needed.
  • Search Payouts: Search for payouts based on criteria like status and date range.

​
Common Endpoints

  • POST /v1/payouts: Create a new payout.
  • GET /v1/payout/{payoutId}: Retrieve details of a specific payout.
  • GET /v1/payouts: Retrieve a list of all payouts.
  • GET /v1/payouts/search: Search for payouts based on various criteria.
  • PUT /v1/payout/{payoutId}: Update details of a specific payout.
  • DELETE /v1/payout/{payoutId}: Delete a specific payout.

​
Authentication

All endpoints require authentication using an API key. Include the API key in the request headers as follows: 
Authorization: Bearer YOUR_API_KEY

​
Error Handling

The Payout API uses standard HTTP status codes to indicate the success or failure of an API request. Common status codes include:
  • 200 OK: The request was successful.
  • 400 Bad Request: The request was invalid or malformed.
  • 401 Unauthorized: Authentication failed or was not provided.
  • 404 Not Found: The requested resource was not found.
  • 500 Internal Server Error: An error occurred on the server.

​
Rate Limiting

To ensure fair usage, the Payout API enforces rate limits on the number of requests that can be made within a specific time frame. If you exceed the rate limit, you will receive a 429 Too Many Requests response.

​
Support

For assistance with the Payout API, please refer to the support documentation or contact our support team at support@example.com.

​
Changelog

For a detailed history of changes to the Payout API, please refer to the changelog.

​
Getting Started

To get started with the Payout API, sign up for an account, obtain your API key, and refer to the individual endpoint documentation for implementation details. Happy coding!