=YOUR\_MERCHANT\_KEY" to receive details of the event.
3. iPay responds to the query in the step above with a **JSON object**. Details of the response object are described as part of the status check end point.
## Sample payment notification Request
`GET` `https://manage.ipaygh.com/gateway/json_status_chk`
#### Query Parameters
| Name | Type | Description |
| ------------- | ------ | --------------------------------------------------------------- |
| merchant\_key | string | Your unique assigned Merchant Key |
| invoice\_id | string | Invoice id of the particular transaction whose details to check |
{% tabs %}
{% tab title="200 " %}
```
```
{% endtab %}
{% endtabs %}
| PARAMETER | VALUES | VALUE TYPE | DESCRIPTION |
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **`1. status`** | new,
paid,
cancelled,
awaiting\_payment,
failed
| String | Transaction status of payment:
new: - Payment transaction is new, initiated to the respective payment network
paid: - Payment made successfully by customer
cancelled: - Payment cancelled by customer
awaiting\_payment: payment pending. Customer does not complete or cancel payment.
failed: - Transaction failed. Reason for failure is provided in status\_reason parameter.
|
| **`2. status_reason`** | Free text | String | This parameter holds detail description for a "failed" Transaction status.
For other status values, it is empty.
|
| **`3. buyer_firstname`** | Free text | String | First name of customer.
Usually empty /null since no value is passed
|
| **`4. buyer_lastname`** | Free text | String | Last name of customer.
Usually empty / null
|
| **`5. buyer_email`** | Free text | String | Email address of customer.
Usually empty / null
|
| **`6. buyer_phone`** | Free text | String | Phone number of customer.
Usually empty / nul
|
| **`7. invoice_id`** | Free text | String | Invoice Id of transaction |
| **`8. amount`** | Free text | Float | Payment amount made |
| **`9. as_at`** | Free text | Date | Transaction timestamp on gateway |
| **`10. narration`** | Free text | String | Description of payment made |
| **`11. extra`** | Free text | Array Object | Sub array of extra parameters available:
channel- Payment channel used by customer
email - Email address of customer if provided in initial request
mobile\_no - Phone number of customer if provided in initial request
psp\_response\_code - This parameter is only available for Card Payment transactions. It holds the specific error code applied to a transaction
psp\_response\_msg - This parameter gives explanation or description of the response error code for Card payments (if available)
|
### Card Payment Response Codes (psp\_response\_code)
| **CODE** | **DESCRIPTION** |
| :------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **0** | The transaction was approved by the acquirer |
| **1** | The transaction could not be processed for an unspecified reason that is not covered by the other response codes. |
| **2** | The transaction was declined by the issuing bank – the customer should contact the bank. |
| **3** | The processing host did not reply to the transaction request.
This message is displayed after a specified time if no response is received from the issuing bank. It usually indicates that the issuing bank’s system is temporarily unavailable
|
| **4** | The customer’s card is past its expiry date |
| **5** | The customer’s card has insufficient credit to cover their purchase |
| **6** | The transaction could not be processed due to a problem with the processing host’s system |
| **7** | The transaction could not be processed due to a problem with the Payment Server. |
| **B** | Your acquirer has blocked this BIN. Please contact the support desk for further information |
| **U** | This transaction has been declined due to the CSC being unacceptable to the Issuer. Cardholder should contact their bank |
| **E** | The transaction has been declined by the issuing bank – the cardholder should contact the bank. |
### Gateway Error Codes:
| **ERROR** | **DESCRIPTION** |
| -------------- | ----------------------------------------------- |
| **1. GW-001** | merchant\_key missing or empty |
| **2. GW-002** | invoice\_id missing or empty |
| **3. GW-003** | total value missing or empty |
| **4. GW-009** | Merchant is deactivated from receiving payments |
# All Plugins
# Shopify
This page describes into details how to integrate iPay services gateway into your shopify store to collect customer payments via mobile money and credit card channels.
## Prerequisite
{% hint style="info" %}
When you register with iPay for the first time, you get a test account and test merchant key. This is to help you complete your integration and test your setup using our test mobile money numbers **0260000000** and **0240000000**.
{% endhint %}
To successfully complete the integration and send requests the following details are required as described in table:
| REQUIREMENTS | DESCRIPTION |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Shopify Account | An active shopify account.
Click here to create a shopify account if you haven't done that already.
|
| iPay Account | An iPay account to integrate into shopify.
Click here to create an iPay account if you haven't created one already.
|
| Merchant ID | Unique iPay merchant ID. |
| Merchant Key | This is a unique key created by iPay for third parties doing integration. |
{% hint style="success" %}
Your **`merchant id`** and **`merchant key`**. You can find them in your **Account profile** (under the **Account management** tab in your iPay account dashboard).
{% endhint %}
{% hint style="info" %}
**iPay for Shopify currently supports only sites that have Ghana cedis (GHS) as a default currency.**
{% endhint %}
## Integrate your Shopify store
To integrate your shopify site, follow the steps below:
### Steps
:ballot\_box\_with\_check:Visit [iPay-Shopify-payments](https://www.shopify.com/login?redirect=%2Fadmin%2Fauthorize_gateway%2F1054045) \
\
:ballot\_box\_with\_check:Click "**`Install Payment provider`**". \
\
:no\_entry: Note: Kindly ensure you have an active Shopify site and you are logged into your site's admin panel.\
\
:ballot\_box\_with\_check:Once iPay is installed, click the **`Edit Button`** next to **iPay Ghana Payment Gateway** (under Alternative Payments providers tab in your settings).\
\
:ballot\_box\_with\_check:Provide your merchant id and merchant key.\
\
:ballot\_box\_with\_check:Save your settings and test your setup on your website using our test numbers **0240000000 or 0260000000**.
### What next after setup
Once you are ready to receive LIVE payments, complete the 3 step activation process on the "`Getting Started` Tab" in your iPay account dashboard to request activation of your account to the BASIC plan.
{% hint style="info" %}
This mode activates your LIVE merchant Key which you will use in your integration to make and receive LIVE mobile money payments only into your account and enable settlements to your remittance account details configured.
:no\_entry: Please note, account activation is given based on completed and tested site integration.
{% endhint %}
{% hint style="info" %}
You may request for upgrade of your account to STANDARD plan after account activation, to enable you receive VISA and MasterCard payments in addition to mobile money payments.
{% endhint %}
# Invoicing
{% hint style="info" %}
**Send Invoices to your customers via** [**SMS and Email**](/business-tools/invoice#step-4) **and get paid in express time,** [**Online**](/business-tools/invoice#how-to-pay-an-invoice-online) **or** [**Offline**](/business-tools/invoice#how-to-pay-an-invoice-offline-sms)**.**
{% endhint %}
Our Invoicing solution allows businesses to request for payments from their customers remotely.
> This is ideal for retail, SME or SOHO businesses who have a need to take orders on the phone or on social media but require a means to accept payments from their customers before processing the orders for delivery.
{% hint style="success" %}
#### Key Features
:ballot\_box\_with\_check: Create custom invoice that includes your company logo and information. \
:ballot\_box\_with\_check: Send invoices using your customer’s email address or mobile number. \
:ballot\_box\_with\_check: Accept Mobile Money, QR and Card payments instantly. \
:ballot\_box\_with\_check: Track your invoices, payments and due dates all in ONE Account. \
:ballot\_box\_with\_check: Pay your suppliers, utility bills and send money in ONE click
{% endhint %}
## This is step by step guide to request payments from your Merchant Dashboard.
### Step 1
> :digit\_one: First, you will need to login to your merchant dashboard and click the ‘**`Invoices tab`**’.
>
> :digit\_two: Click on the ‘**`Create New Invoice`**’ button.
### Step 2
> :digit\_one: You will be prompted to enter the customer’s name, email address or Mobile Money Number, payment description, Amount you are requesting and an option to set a due date for invoice to expire.
>
> :digit\_two: Click the ‘Send’ button filling in all details correctly.
### Step 3
> :digit\_one: You’ll have a chance to review the payment request before sending. Click ‘Continue’ to send the payment request to the customer via SMS/Email depending on the customer information provided.
>
> :digit\_two: Your customer will receive an SMS/Email notification with instructions to complete payment
### Step 4
> :digit\_one: Your customer will receive an email or SMS which looks like the samples below.
{% hint style="success" %}
All they have to do is click on "Pay Invoice" button to pay online OR pay offline by dialing \*920\*50# and entering the invoice number.
{% endhint %}
## How to Pay an Invoice - Online
{% hint style="info" %}
Once customer clicks on the Pay Invoice button or URL , a secure page will open on their browser where they can follow the steps to make payment.
{% endhint %}
### Confirmation of Payment to Customer and Merchant
{% hint style="info" %}
Once payment is completed, customer receives payment receipt via Email/SMS and Merchant get instant notification of payment.
{% endhint %}
## How to Pay an Invoice - Offline / SMS
> :digit\_one: Customer dials the short code **\******920\******50#** and Chose '**1. Pay Merchant’**.
>
> :digit\_two: They will be required to enter the unique invoice number to complete payment
### Confirmation of Payment to Customer and Merchant - Offline
{% hint style="info" %}
Once payment is completed, customer receives payment receipt via SMS and Merchant get instant notification of payment.
{% endhint %}
