Welcome to the Cloud Payments platform! You can integrate services in the Cloud Payments platform into your app, website, or web server depending on your use cases.
Before you can start coding your application, you need to know about the entities and roles in the Cloud Payments platform.
The first step is to create a developer account in this portal. By registering, you will receive an APP key specific to you which is used to authenticate yourself on the Cloud Payments platform.
After registering, you should create a business profile, and with it the admin user of your business.
Creating a profile will immediately give you access to all services on the Cloud Payments platform. With the APP Key found in your profile, you can test the Cloud Payments platform and make your own application.
An APP key is a unique identifier token assigned to an account by the Cloud Payments platform. The Cloud Payments platform uses the APP key to identify accounts and their interfaces, and authenticate API requests against the services the account is subscribed to. If the APP key is not present in the request or you use an incorrect or outdated one, an error response will be returned. The APP key is used to track API requests usage and for billing, so the key should be kept confidential.
Your APP key is automatically generated when you sign up, and from then on found in your ‘Settings’ page in the ‘Dashboard’ if you sign in to the developers portal. For your security, we require you to re-authenticate yourself by entering your developer portal password again to reveal the APP Key. If the APP Key does not show up on your dashboard, please contact us and ask for an APP key to be added to your account.
Note that the APP key obtained in this developer portal is for testing and development. As a registered developer, the APP key will provide you with access to most of the Cloud Payments APIs, however with a very low usage limit. For a production account with higher usage limits, contact Sales. In production accounts, you can create multiple APP keys for your various interfaces.
A business profile is used to manage payment and loyalty services for your customers. You can create a business of any size.
To create your business profile:
After creating the profile, you can find your system-assigned unique tenant ID and Business code on the ‘Settings’ page. Your unique tenant ID is used by the system to identify your business. Some API requests may require your tenant ID and/or business code, so keep these values on hand.
Admin user is the main administrator of your business.
To create the admin user:
To confirm everything is up and running with your APP key.
To get a complete URL, concatenate the API host address (URL) and the endpoint of the API in the specification. For example, to login using the OAuth based service:
| Host | Path |
|---|---|
| https://api.cloudpayments.com | /auth/oauth/token |
Note that the host address above is for Production. There is another address for a SANDBOX environment and that can be used for only testing and development.
Headers are mandatory for all API requests. Depending on the API request, required parameters in the header will vary. For this, refer to each API specification. The one always required parameter is the “api-key”:
| Name | Description |
|---|---|
| api-key | An APP key used to identify the client and authenticate the request |
If your request is successful, you will receive the following message. If the received response differs from this, please check the specification of the API call for required parameters that might be missing.
curl -X GET " https://api.cloudpayments.com/dummyapi/status" -H "api-key:fcb6bd81970001eefda1cefd728d2b224d149b8b2ed542719eff"
Header status code
200
Body message
{
"status": "OK",
"message": "Your APP Key is valid"
}
If your APP key is compromised or lost, contact the Cloud Payments platform admin to revoke the key and generate a new one.
Your key can be expired if some technical or security issue is raised with it. If your key is expired, you will receive the following response. If you want to renew your key, please contact the Cloud Payments platform admin to generate a new one.
HTTP Status code
401 Unauthorized
Body message
{
"error": "Key has expired, please renew"
}
The Cloud Payments platform allows APP keys provided to registered developers to access most services, but if you cannot access certain API, you will get the following response. Please check if you are using the correct APP key to access the service you want. If you need access to the API with your APP Key, please contact the Cloud Payments platform admin to discuss your access.
HTTP Status code
403 Forbidden
Body message
{
"error": "Access to this API has been disallowed"
}
You may try to access the API whose access is completely blocked. This may be a blacklisted API after deprecation. If you used to be able to access this API but are no longer able to, please check if there is a new version of the API available.
HTTP Status code
403 Forbidden
Body message
{
"error": "Requested endpoint is forbidden"
}
If you forgot to add an APP Key to your header, you will get the following response. Please add the APP key as described in this section.
HTTP Status code
401 Unauthorized
Body message
{
"error": "Authorization field missing"
}
When you are ready to put a real account on the Cloud Payments platform, please contact Cloud Payments sales to discuss your use cases and needs and get pricing for your client.