Overview

You may call OpenAPI to access relevant information, whether you are using web access or OpenAPI access.

Basic

OpenAPI request path：

• Production environment：https://openapi.osl-pay.com
• Sandbox environment：https://sandbox-openapi.osl-pay.com

Frequency limit

The access frequency is limited to 10 times per second. Contact us if you need a higher frequency.

IP allowlist

Provide the public IP address(es) you wish to allow. Only IP addresses in the allowlist are able to call OpenAPI.

Public parameters

The following public parameters are required in the header for any access request.

Request input parameters (header)

Parameter	Type	Mandatory	Description
appId	String	Y	appId, provided by OSL Pay
timestamp	Long	Y	Timestamp of access request
signature	String	Y	Signature. For details on the generation rules, refer to the Signature algorithm section below.

All parameters returned by OSL Pay are in the following formats:

Output parameters

Parameter	Type	Mandatory	Description
code	String	Y	Status code.
data	Object	Y	Business parameters
msg	String	Y	Note
requestTime	String	Y	Interface response timestamp

Error code

Code	Note	Description
00000	Call successful
00001	Authorization failed	IP is not in the allowlist, incorrect signature, etc.
00002	Parameter verification failed	See the corresponding error report for details.
99999	System error	System error. Contact OSL Pay.