Page cover

Get Started

Base URL

The Base URL for accessing the services is;

https://dps.prunepayments.net

There are 2 main services in the Prune API Service,

  1. Account Service: This allows you to manage individual and organisational accounts

  2. Payout Service: This gives access to payment services such as requesting for payouts and transferring of funds between accounts.

API Status Codes

The status section lists the HTTP status codes that the Prune API may return, along with their descriptions. These codes indicate the result of an API request. Common codes include '200 OK' for successful requests, '401 Unauthorized' for authentication failures, and '500 Internal Server Error' for server-side issues.

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

🟢

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 provides a set of pre-configured API requests for the Prune API, allowing users to quickly and easily test and interact with the various routes and endpoints. Click here to access the collection.

Last updated