Guide

Account Setup

Test Accounts

  • Test API Credentials
    Merchant ID: GP0000001
    Merchant Key: 123456789

Live Accounts

  • Sign up for a live account here: https://gladepay.com You can start accepting real time payments with your live account. Create one now. Your API Credentials are in Merchant Credentials on the dashboard.

NOTE

Your Merchant Key should not be shared with a third party.

Using the Gladepay Payment Services

The Gladepay inline checkout is the simplest and easiest way to start accepting payments on your platform. This payment solution provides a secure and convenient flow for users. Payments are processed on the go without having to navigate customers to another page to complete their transactions.

The Interface

The Interface

Prerequisites / Requirements

Pass the following with the header request made to the endpoint

  1. Check our acceptable use policy if you have any questions about your business and its acceptability please send an email to support@gladepay.com. The team is available to provide feedback on any enquiry.

  2. Get familiar with our API by reading these pages in the API Overview section: Introduction, Payment Collection and Money Transfer.

NOTE

You need to provide business CAC Certificate or National Identification (International Passport, Driving Licence, or National Identity Card) and then fill all the required details for your account to be activated and ready to receive payment.

HTTPS requirements

All request to using the Checkout are made via a secure HTTPS connection. However, in order to protect yourself from certain forms of man-in-the-middle attacks, you must serve the page containing the payment form over HTTPS. e.g https://yourdomain.com/paymentpage

If you are not familiar with the setting up SSL certificates follow this guide to setup on a free SSL certificate your server to enable a secure HTTPS connection.

Gladepay Inline Checkout

The Inline Checkout solution provides quick access the API into any website, CMS, App or Platform. It requires an addon embed script.

NOTE

We recommend you don't cache the script in your project to avoid breaking changes when an update is introduced.

Live Inline Script

<script type="text/javascript" src="https://api.gladepay.com/checkout.js"></script>
1

Demo Inline Script

<script type="text/javascript" src="http://demo.api.gladepay.com/checkout.js"></script>
1

TIP

You can have a see how the Inline Checkout looks and works from our demo page Demo Page


Sample Configuration

  initPayment({
    MID:"00",
    email: "hello@example.com",
    firstname:"John",
    lastname:"Doe",
    description: "",
    title: "",
    amount: 100,
    country: "NG",
    currency: "NGN",
    onclose: function() {

    },
    callback: function(response) {

    }
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

The checkout API is called directly from code using the initPayment function. It accepts the following the properties.

Embed Parameters

Parameters Meaning Option
MID Merchant ID Required
amount Amount to charge the customer. Required
currency default is NGN. Optional
country default is NG. Optional
email email of the customer. Required
firstname First name of the customer. Optional
lastname Last name of the customer. Optional
phone Phone number of the customer. Optional
title Text to be displayed as the title of the payment modal. Optional
description Text to be displayed as a short modal description. Optional
meta_data When you need to pass extra data to the API. The value should be a string stringify the value if its a JSON value. Optional
payment_method You can select which payment method you want available on the checkout, pass array of the payment methods you want available e.g ['card', 'bank', 'ussd', 'qr', 'mobilemoney'] Optional
bearer You can use this option to determine who pay for the charges on the transaction default is set to the merchants account. customer or account Optional
logo Link to the Logo image. Optional
is_recurring The is_recurring field default value is false, setting it to true will make the transaction recurrent and will generate a token Optional
customer_txnref Unquie reference you generate such as an order number, which can be used to verify transaction at a later time Optional

Sample Response


 
 
 
 
 
 
 
 


{
    "status": 200,
    "txnStatus": "successful",
    "bank_message": "Successful",
    "fullname": "John Doe",
    "email": "demo@gmail.com",
    "txnRef": "GP82878898982497T",
    "chargedAmount": 1000,
    "fraudStatus": "ok"
}
1
2
3
4
5
6
7
8
9
10

The Inline Checkout can also be configured for advance requirements like Recurring payment, Split payment and Installment payments.

Recurring Payment

Recurring payment can be configured directly into the payment system that will be carried out automatically by the our system and send the results back to your Webhook as payment notification.

To use the recurring feature within the inline checkout simply add these configuration options to the embeded inline checkout configurations.

NOTE

Recurring feature works only with card payments.

For Recurrent

Parameters Meaning Option
frequency The frequency at which the recurring payment should occurs options available are daily or weekly or monthly Required
value The value will determine when the charge should occur based on the frequency that has been set.
Daily (Hours): 0 - 23
Weekly (Day): 1 - 7
Monthly (Day): 1 - 30
Required

Sample Configuration

NOTE

This configuration setup will charge the user every first day of the week the amount that has been set.

initPayment({
    MID:"00",
    email: "hello@example.com",
    firstname:"John",
    lastname:"Doe",
    description: "",
    title: "",
    amount: 100,
    country: "NG",
    currency: "NGN",
    recurrent: {
        frequency: "weekly",
        value: "1"
    },
    onclose: function() {

    },
    callback: function(response) {

    }
});          
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

Installment Payment

Installment payment allows you to collect payment in bit's to reach accomulate to a final amount.

For Installment

Parameters Meaning Option
payment_schedule This option will be used to determine how the system will handle the installments.
This option should be used for initial transaction.
Dependent
total The total amount to be collect over a period of time.
This option should be used for initial transaction.
Dependent
txnRef The reference of the initial transaction that you want the user or customer to complete to the total amount. Dependent

Sample configuration initial installment payment

NOTE

This will initate a payment request on the set date when its a card transaction that was used to initate the transaction.











 
 
 
 
 
 
 
 








initPayment({
    MID:"00",
    email: "hello@example.com",
    firstname:"John",
    lastname:"Doe",
    description: "",
    title: "",
    amount: 1000,
    country: "NG",
    currency: "NGN",
    installment: {
      total: 40000,
      payment_schedule : {
          "31-11-2017" : 20,
          "31-12-2017" : 30,
          "30-01-2017" : 50
      }
    },
    onclose: function() {

    },
    callback: function(response) {

    }
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

Sample configuration to complete installment payment

NOTE

This will initate a payment request on the set date when its a card transaction that was used to initate the transaction.











 
 
 








initPayment({
    MID:"00",
    email: "hello@example.com",
    firstname:"John",
    lastname:"Doe",
    description: "",
    title: "",
    amount: 100,
    country: "NG",
    currency: "NGN",
    installment: {
      txnRef: "GP000KAJA"
    },
    onclose: function() {

    },
    callback: function(response) {

    }
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

Split Payment

With split payments you can decide how you want the settlements to be handled when you provide a service to a third party.

Before you can split payment you have generate a reference code on the dashboard that will be used to divide the payment into the account that was specified at the point of generating the code.

For Split

Parameters Meaning Option
ref_code Reference code that was generated at the point of setting up the split payment accounts. Required
percentage The percentage of the transaction to be settled in the account. Required
fixed A fixed amount of the transaction to be settled in the account. Required

Sample Configuration











 
 
 
 
 
 
 
 
 








initPayment({
    MID:"00",
    email: "hello@example.com",
    firstname:"John",
    lastname:"Doe",
    description: "",
    title: "",
    amount: 100,
    country: "NG",
    currency: "NGN",
    split: JSON.stringify(
      [{
        ref_code: "99882",
    	  percentage: "45"
      },{
        ref_code: "90882",
    	  fixed: "10"
      }]
    ),
    onclose: function() {

    },
    callback: function(response) {

    }
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

Verify Transactions

It is recommended that you verify every transaction before giving value to your customers when a transaction is initaited from the Inline Checkout Page.

Send a PUT request to the endpoint as specified by the API Reference in Verifying Transactions

Endpoint: https://demo.api.gladepay.com/payment

{
  "action":"verify",
  "txnRef":"GP1507382986"
}
1
2
3
4

You can also verify transactions using customer_txnref if it was passed as parameter in the configuration for initiating the payment.

{
  "action":"verify",
  "customer_txnref":"1508261817382986"
}
1
2
3
4

YAY!

Congratulations you have just successfully embedded gladepay inline checkout into your website.

Refund Transactions

GladePay allows you to refund successful transactions, this can be achieved on the dashboard by navigating to the transactions page:

  1. Click on the transaction to refund.

  2. Click perform action

  3. Click create a refund.

  4. Enter the amount to refund and reason.

  5. Click on refund to complete the process.

Disputes

GladePay allows you to raise dispute on transactions, this can also be raise by GladePay in places where chargebacks are required. In order to start a dispute it can be achieved on the dashboard by navigating to the transactions page and following the steps below:

  1. Click on a transaction to raise dispute.

  2. Click perform action

  3. Click create a dispute.

  4. Enter the reason for the dispute and attach documents if required.

  5. Submit dispute complete the process and a GladePay agent will reply back.

Settlements

You can view details of settlements made to your bank accounts and the bank accounts for your split payment on the dashboard. It gives a a detailed report of the total number of transations, amount and amount paid to your bank account.

Questions?

If you encounter any issues while trying to implement this, please reach out on our developers platform.
Join using this Invite Link.