Introduction

About AGAMiPay

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla vitae elit libero, a pharetra augue. Nullam id dolor id nibh ultricies vehicula ut id elit.

User Journey

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla vitae elit libero, a pharetra augue. Nullam id dolor id nibh ultricies vehicula ut id elit.

Use-cases

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla vitae elit libero, a pharetra augue. Nullam id dolor id nibh ultricies vehicula ut id elit.

App Versions

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla vitae elit libero, a pharetra augue. Nullam id dolor id nibh ultricies vehicula ut id elit.

Change Logs

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla vitae elit libero, a pharetra augue. Nullam id dolor id nibh ultricies vehicula ut id elit.

Getting Started

Create Merchant Account

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla vitae elit libero, a pharetra augue. Nullam id dolor id nibh ultricies vehicula ut id elit.

Merchant Dashboard

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla vitae elit libero, a pharetra augue. Nullam id dolor id nibh ultricies vehicula ut id elit.

Setup Payment Gateways

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla vitae elit libero, a pharetra augue. Nullam id dolor id nibh ultricies vehicula ut id elit.

Enable API Integration

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla vitae elit libero, a pharetra augue. Nullam id dolor id nibh ultricies vehicula ut id elit.

Setup Webhook Listener

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla vitae elit libero, a pharetra augue. Nullam id dolor id nibh ultricies vehicula ut id elit.

API Integration

Create Invoice API

Used to create an authentication channel for new invoices.

URL

/merchant/api/invoice/create_invoice.php

Method

POST

Auth required

YES

authorization: TOKEN

Accepted Fields

Field Name	DataType (Length)	Required	Description
billno	AlphaNumeric (25)	Yes	Merchant Unique Bill No
amount	Numeric (10,2)	Yes	Total Amount in English
invoicedescription	AlphaNumeric (140)	No	Short description of the invoice.
customername	AlphaNumeric (140)	No	Name of customer
customernumber	AlphaNumeric (140)	Yes	Mobile number of customer
sendsms	Numeric (1)	No	1 = Send text to phone, 0 = No text sms
successURL	AlphaNumeric (511)	Yes	Merchant success handler callback URL
failureURL	AlphaNumeric (511)	Yes	Merchant fail handler callback URL

Data Constraints

                    
{
    "billno": "[Merchant Unique Bill No]",
    "amount": "[Total Amount in English]",
    "invoicedescription": "[Short description of the invoice.]",
    "successURL": "[]",
    "failureURL": "[]"
}
                    
                

Data Example

                    
{
    "billno": "AGAMi001MGT000001",
    "amount": 149.5,
    "invoicedescription": "Bill for Book",
    "successURL": "https://agamievent.com/payment/success.php",
    "failureURL": "https://agamievent.com/payment/failure.php"
}
                    
                

Success Response

Code

200 OK

Content Example

{
    "pay_url": "https://agamipay.com/93144b288eb1fdccbe46d6fc0f241a51766ecd3d",
    "createdat": "2024-07-04 13:51:00"
}
                    
                

Error Response

Condition

If fails.

Code

400 BAD REQUEST

Content

                    
{
    "errorcode": "[Representing error codes]",
    "message": "[Representing error message]"
}
                    
                

Possible Error Codes

Error Code	Message	Description
000	API Ready
200	Success
400	Token Expired
401	Invalid Token
403	Session Error