eCommerce Platform Plugins

WooCommerce
WHMCS
Magento 2
Prestashop 1.7
OpenCart 3.0
HikaShop
Easy Digital

Underdevelopment

Drupal Ubercart

Underdevelopment

Virtual Freer

Underdevelopment

Gravity Forms

Underdevelopment

Virtuemart

Underdevelopment

E-Commerce

Underdevelopment

Gateway Api Service Documentation

Invoice

POST /invoice

 

Use this api for creating new invoice

parameters

Name Description Date type
apikey Merchant apiKey string require
description Order description string require
mobile Merchant mobile number string require
orderId Merchant order id string require
merchantCur Merchant currency string require
currency Payer currency string require
price Payer order price string require

cURL

curl -X POST \
  /invoice \
  -H 'Cache-Control: no-cache' \
  -H 'Content-Type: application/json' \
  -d '{"apikey":"","mobile":"","description":"","orderId":"","merchantCur":"","currency":"","price":""}'

Response

{
    "id": "ID29_61a5",
    "shopName": "New Shop",
    "status": "waiting",
    "remaining": 40,
    "payerAmount": 15000,
    "payerCur": "IRR",
    "merchantAmount": 15000,
    "merchantCur": "IRR",
    "date": "2018-10-13 06:45:36",
    "timestamp": 1539413136148,
    "timeout": 40,
    "description": "test payment",
    "gatewayUrl": "https://gateway.url.com/invoice/ID29_61a5",
    "callback": "http://www.your-website.com/invoice?orderid=12324320",
    "orderId": "12324320"
}
GET /invoice

 

Use this api for checking invoice status with invoice id

parameters

Name Description Date type
apikey Merchant apiKey string
mob Merchant mobile number string
id invoice id string require

cURL

curl -X GET \
  '/invoice/?id=ID29_61a5' \
  -H 'Cache-Control: no-cache' \
  -H 'Content-Type: application/json'

Response

{
    "id": "ID29_61a5",
    "shopName": "New Shop",
    "status": "success",
    "remaining": 30,
    "payerAmount": 15000,
    "payerCur": "IRR",
    "date": "2018-10-13 06:45:36",
    "timestamp": 1539413136148,
    "timeout": 40,
    "description": "test payment",
    "gatewayUrl": "https://gateway.url.com/invoice/ID29_61a5",
    "callback": "http://www.your-website.com/invoice?orderid=12324320",
    "orderId": "12324320"
}
GET /invoice/byorderid

 

Use this api for checking invoice status with order id

parameters

Name Description Date type
apikey Merchant apiKey string require
mob Merchant mobile number string require
id Merchant order id string require

cURL

curl -X GET \
  '/invoice/byorderid?byorderid?id=12324320&mob=&apikey=' \
  -H 'Cache-Control: no-cache' \
  -H 'Content-Type: application/json'

Response

{
    "id": "ID29_61a5",
    "shopName": "New Shop",
    "status": "success",
    "remaining": 30,
    "payerAmount": 15000,
    "payerCur": "IRR",
    "merchantAmount": 15000,
    "merchantCur": "IRR",
    "date": "2018-10-13 06:45:36",
    "timestamp": 1539413136148,
    "timeout": 40,
    "description": "test payment",
    "gatewayUrl": "https://gateway.url.com/invoice/ID29_61a5",
    "callback": "http://www.your-website.com/invoice?orderid=12324320",
    "orderId": "12324320"
}

Register to get api key

عضویت در خبرنامه