Prerequisites

​IP Whitelisting

Before using the API in the development environment, partners must submit a list of public IP addresses to be whitelisted. Once the whitelist is approved, we will provide a development API key, password, client ID, and client secret.

The API key must be included in the X-PARTNER-ID header for every request, while the password must be supplied as a required parameter for payment endpoints or any other endpoints that require it. To obtain an access token, use Basic Authentication with the client ID as the username and the client secret as the password. Once the access token is obtained, it must be included in the Authorization header of subsequent API requests using the format: Bearer <access_token>.

For the production environment, partners will be asked again to submit their server’s public IP addresses for whitelisting. After approval, we will issue a new API key, password, client ID, and client secret specific to the partner’s production server.

​Response Code

Below is a list of response codes from the Singapay team. The term response code refers to the value of the response_code key in our API. The description shown corresponds to the default value of response_text. However, this description may vary depending on the API context or implementation and should not be relied upon as a fixed reference. When handling API responses, you should focus primarily on the response_code, as it remains consistent and serves as the main indicator for processing the response correctly.