Skip to main content

Using the SoleasPay API

API Environments

The base URL for the SoleasPay API is different between our sandbox and production environments: The specific operation can be called by appending the endpoint to the base URL. Example: https://sandbox.soleaspay.com

Authentication

SoleasPay’s API support two Authentication flow :
  • header token flow For this authentication, you need to provide your apikey in the request payload on headers
The authed parameter is : x-api-key : <your api key>This authentication flow is need for all endpoint prefixed like /api/agent/
  • Bearer token flow Here you need to request a bearer token and provide it for all requests on Authorization headers
Request example
Response
The authed parameters are :
  • Authorization : Bearer <received token>
  • X-SP-AUTH-TOKEN : Bearer <received token>
This authentication flow is need for all endpoint prefixed like /api/action/The Bearer token is valid for 3600 s