Page cover

Get Started

Base URL

The Base URL for accessing Prune's API services is:

https://dps.prunepayments.net

Our API services are primarily divided into two main categories:

  • Account Service: This service enables you to manage both individual and organizational accounts.

  • Payout Service: This service provides access to payment functionalities, such as requesting payouts and transferring funds between accounts.

API Status Codes

The API Status Codes section outlines the standard HTTP status codes that the Prune API may return in response to your requests. These codes are crucial indicators of the outcome of an API request. Common examples include:

  • 200 OK: Indicates that the request was successful.

  • 401 Unauthorized: Signifies an authentication failure, meaning the request lacks valid authentication credentials.

  • 500 Internal Server Error: Points to a server-side issue that prevented the API from fulfilling the request.

Below is a comprehensive list of all statuses that may be returned when using the Prune API Service:

(Note: The comprehensive list of status codes would typically follow here in the actual documentation.)

🟢

Status Code

200

Description

OK

Cause

The request was successful and the server returned the requested data.

🟢

Status Code

201

Description

Created

Cause

The request was successful and a new resource was created.

🟢

Status Code

202

Description

Accepted

Cause

The request has been accepted for processing, but the processing has not been completed.

🔴

Status Code

400

Description

Bad Request

Cause

The server could not understand the request due to invalid syntax.

🔴

Status Code

401

Description

Unauthorized

Cause

Authentication is required and has failed or has not yet been provided.

🔴

Status Code

403

Description

Forbidden

Cause

The client does not have access rights to the content.

🔴

Status Code

404

Description

Not Found

Cause

The server cannot find the requested resource.

🔴

Status Code

500

Description

Internal Server Error

Cause

The server encountered an internal error and was unable to complete the request.

🟡

Status Code

503

Description

Service Unavailable

Cause

The server is not ready to handle the request, usually due to maintenance or overload.

Postman Collection

The Postman Collection offers a set of pre-configured API requests for the Prune API. This allows you to quickly and easily test and interact with its various routes and endpoints.

Click here to access the collection.

Last updated