Platform APIs

​

Overview

Hitpay Platform APIs are an extension of the above Payment Request APIs are used by e-commerce platforms or aggregators who host other merchants. Platforms will have the ability to create payment requests on behalf of the merchants that are on their platform.

Platforms will also have the ability to set a commission for the transactions that happen through their platform.

​

Integrations Flow

1. Contact to Hitpay to signup for a Platform Account
2. Individual merchant creates a Hitpay account (Sandbox Account or Live Account)
3. Individual merchant will setup PayNow (Singapore Only) in the HitPay Dashboard under Settings > Payment Methods > PayNow
4. Individual merchant will generate API keys under Settings > Payment Gateway > API Keys. (Merchant API keys)
5. These keys will give you access to create payment requests.

​

Platform Authentication

Hitpay uses API keys to allow access to the API. Once your account is converted to “Platform Account” you can you can access your “Platform API Key” (Settings > Payment Gateway > Platform). This Platform API Key along with Merchant API key is expected to be included in all API requests to the server in a header that looks like the following:

X-BUSINESS-API-KEY: meowmeowmeow X-PLATFORM-KEY: bowbowbow

# With shell, you can just pass the correct header with each request
curl "api_endpoint_here"
  -H "X-BUSINESS-API-KEY: meowmeowmeow"
  -H "X-PLATFORM-KEY: bowbowbow"
  -H "X-Requested-With: XMLHttpRequest"