Introduction

Monay GPS Payment Engine API Specification

Environment

This document is intended to describe the Monay GPS APIs through which users can make payments using Monay GPS as a payment facilitator. To test APIs, Click here.

API Parameters

To consume Monay GPS APIs for payments, the sub-merchant must generate a Merchant ID, API key, and secret key from the portal. To generate production API keys the sub-merchant must register to Monay and submit the complete KYC Information. Upon successful verification of KYC Information, production parameters will be assigned to the sub-merchant. The path parameters and headers required for authentication are discussed below.

1. Merchant ID 

Merchant ID is a unique identifier provided by Monay GPS for the card and ACH payment.

Example of Merchant ID: 526971115880

2. API Key

Once sub-merchants KYC Information has been verified a key is provided to access GPS APIs. A separate API key for Card and ICA is generated from the Monay portal.

Example of API Key: b08f849d-7a0e-4b77-b979-db6be7b417dc

3. Secret Key

Once sub-merchants KYC Information has been verified a Secret key is provided to access GPS APIs. A separate Secret key for Card and ICA is generated from the Monay portal.

Example of Secret Key: b238a66c-ce75-4770-9014-6622a7c4fd77

Getting Started

To consume Monay GPS APIs, generate Merchant ID, API key, and secret key from the portal. To generate API parameters, follow the following steps.

1. Go to https://gps.monay.com/portal/sign-up.
2. Click on the “CREATE ACCOUNT” button.
3. Enter following information       
   1. Work Email
   2. First Name 
   3. Last Name
   4. Password
   5. Select Country
4. Click on the “SIGN UP” button. 
5. Verify the account from the verification email received by clicking on the “Complete your Enrolment” button.
6. Sign in to the portal with a verified email and password. 

Steps for Generating test parameters

1. Submit Business Information from Submit KYC section.
2. Test Merchant ID, API key, and secret key will be assigned to the user.
3. Test mode will be activated. You can generate test payment links. 

Steps for Generating production parameters

1. Complete all three steps of KYC.
   • KYC Information
   • Processing Agreement
   • Financial Information 
2. Within 14 working days, KYC information will be verified, and you will be notified at provided email address.
3. Upon successful verification, you can generate production API keys for Main, ICA, and Card by clicking on the “Generate” button in For Developers section.

4.  To view API keys. Click on “Show all API keys”.

5.  You can view the Merchant ID, API key, and secret key for Main, ICA, and Card.

6. You can receive payments in production mode.

Merchant Authentication 

This API is used to originate card and ACH payments. API and Secret key will be generated from the Monay GPS portal.  

Path Parameter

Headers

Response

{    
    "gpsApiToken": "ca08c1c4-1033-4625-894a-ecc634da0b1a",
    "statusCode": "200",
    "statusDesc": "success"
}

Response Code