Skip to main content
If you’re not looking to build API documentation, you can contact our team for more details.

​
API Base

The SoleasPay Link API endpoints support both GET and POST requests:

SoleasPay

View the website for specification details

​
Authentication

All requests to the Link API must include an API key in the request headers:
  • x-api-key: Required for all /api/agent endpoints.
  • You can obtain your API key from the SoleasPay dashboard.

​
Rate Limits

The number of requests is limited to 600 requests per hour per IP address.
If you require a higher limit, please contact us.
Exceeding the limit may result in temporary blocking of the IP address. To link a user from your application to their SoleasPay wallet, initiate the following request: Endpoint
GET /api/agent/link/new Headers
  • Content-Type: application/json
  • x-api-key: {Your API key}
Query Parameters
  • email (string): User’s email address
  • phone (integer): User’s phone number (digits only)
  • phoneCountry (string): Country code (e.g., +237)

​
Example Request (JavaScript)

var myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");
myHeaders.append("x-api-key", "YOUR_API_KEY");

var requestOptions = {
  method: 'GET',
  headers: myHeaders,
  redirect: 'follow'
};

fetch("https://soleaspay.com/api/agent/link/[email protected]&phone=693000000&phoneCountry=+237", requestOptions)
  .then(response => response.json())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

For more details visite  [Link api-reference](https://doc.soleaspay.com/link/endpoint/initWallet).