راهنمای وبسرویس - اتصال به api درگاه پرداخت

REST API
SOAP API

مقدمه

درگاه‌ پرداخت به عنوان یکی از ابزارهای حیاتی در فرآیند پرداخت‌های اینترنتی و اتصال کسب‌وکارها به سیستم بانکی اهمیت زیادی دارند. وب‌سرویس‌های درگاه پرداخت، امکان ارتباط مستقیم بین سایت‌ها یا برنامه‌های نرم‌افزاری و سیستم پرداخت بانکی را فراهم می‌کنند.

استفاده از وب‌سرویس درگاه پرداخت از مزایای بسیاری برخوردار است. این روش به کسب‌وکارها اجازه می‌دهد تا به راحتی و با امنیت بالا پرداخت‌های آنلاین را از مشتریان خود دریافت کرده و فرآیند پرداخت را بهبود بخشند. همچنین، این وب‌سرویس‌ قابلیت انعطاف‌پذیری بالایی را برای پذیرندگان محترم سپرده فراهم کرده است و تا قادر باشند با انواع مختلفی از برنامه‌ها و وبسایت‌ها ارتباط برقرار کنند.

ایجاد فاکتور

Response
CURL
PHP
GO
NODE

{
    "status": 200, // وضعیت 200 به معنای موفقیت آمیز بودن ایجاد فاکتور می باشد
    "message": "add completed",
    "information": {
		"invoice_id": 4 // این عدد شماره فاکتور ایجاد شده می باشد که باید ذخیره نمایید
    }
}

curl --location --request POST 'https://sepordeh.com/merchant/invoices/add/' \
--form 'merchant="KnIT45OvAnd1584271146:8zN9iO1Y11tg6LVl"' \
--form 'amount="150000"' \
--form 'callback="http://website.com/callback"' \
--form 'description="خريد گوشي موبايل"' \
--form 'orderId="14886"' \
--form 'phone="09121234567"'

$parameters = array(
	"merchant"=>$merchant,
	"amount"=>$amount,
	"callback"=>$callback,
	"description"=>$description,
	"orderId"=>$orderId
);
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://sepordeh.com/merchant/invoices/add/");
curl_setopt($ch, CURLOPT_POSTFIELDS, $parameters);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($ch);
if(!!curl_errno($ch)){
	die("CURL ERROR:".curl_error($ch));
}else{
	$result = json_decode($result);
	if($result->status==200){
		//ارجاع به صفحه پرداخت
	}
}
curl_close($ch);

package main

import (
  "fmt"
  "bytes"
  "mime/multipart"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://sepordeh.com/merchant/invoices/add/"
  method := "POST"

  payload := &bytes.Buffer{}
  writer := multipart.NewWriter(payload)
  _ = writer.WriteField("merchant", "KnIT45OvAnd1584271146:8zN9iO1Y11tg6LVl")
  _ = writer.WriteField("amount", "150000")
  _ = writer.WriteField("callback", "http://website.com/callback")
  _ = writer.WriteField("description", "خريد گوشي موبايل")
  _ = writer.WriteField("orderId", "14886")
  _ = writer.WriteField("phone", "09121234567")
  err := writer.Close()
  if err != nil {
    fmt.Println(err)
    return
  }


  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Cookie", "PHPSESSID=61c55f5401361d630f008d25b0c89848")

  req.Header.Set("Content-Type", writer.FormDataContentType())
  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

آدرس : https://sepordeh.com/merchant/invoices/add/

نام پارامتر	وضعيت	نوع داده	نمونه	شرح
merchant	اجباري	string	KnIT45OvAnd1584271146:8zN9iO1Y11tg6LVl	مرچنت را بايد در بخش کسب و کار ها از داخل پنل برداريد
amount	اجباري	number	150000	مبلغ فاکتور به تومان
callback	اجباري	string	http://website.com/callback	آدرس بازگشت بعد از اتمام عمليات پرداخت
description	اختياري	string	خريد گوشي موبايل	توضيحات در مورد فاکتور
orderId	اختياري	number	14886	شماره سفارش در سیستم شما (حداکثر 20 رقمی)
phone	اختياري	number	09121234567	شماره موبایل پرداخت کننده

ارجاع به صفحه پرداخت

PHP
GO
NODE

header('Location: https://sepordeh.com/merchant/invoices/pay/automatic:true/id:'.$result->information->invoice_id, true, 302);

آدرس : https://sepordeh.com/merchant/invoices/pay/id:{invoice_id}

مقدار {{invoice_id}} را با شماره فاکتور دریافتی در مرحله قبل جایگزین کنید.

بازگشت از صفحه پرداخت

آدرس : http://website.com/callback?authority={{authority}}&&orderId={{orderId}}

هنگام بازگشت به آدرس callback دو پارامتر authority و orderId ارسال میگردد (توسط متد GET)

تایید فاکتور

Response
CURL
PHP
GO
NODE

{
    "status": 200, // وضعیت 200 به معنای موفقیت آمیز بودن پرداخت می باشد
    "message": "paid",
    "information": {
            "invoice_id": 4 ,
            "card": "6104********4510" // شماره کارت پرداخت کننده می باشد
    }
}

curl --location --request POST 'https://sepordeh.com/merchant/invoices/verify/' \
--form 'merchant="KnIT45OvAnd1584271146:8zN9iO1Y11tg6LVl"' \
--form 'authority="35684"'

$orderId = $_GET["orderId"];
if(isset($_GET["authority"])){
	$parameters = array(
		"merchant"=>$merchant,
		"authority"=>$_GET["authority"],
	);
	$ch = curl_init();
	curl_setopt($ch, CURLOPT_URL, "https://sepordeh.com/merchant/invoices/verify/");
	curl_setopt($ch, CURLOPT_POSTFIELDS, $parameters);
	curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
	curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
	curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
	$result = curl_exec($ch);
	if(!!curl_errno($ch)){
		die("CURL ERROR:".curl_error($ch));
	}else{
		$result = json_decode($result);
		if($result->status==200){
			//پرداخت موفق
		}else{
			die("خطا:".$result->message);
		}
	}
	curl_close($ch);
}

آدرس : https://sepordeh.com/merchant/invoices/verify/

نام پارامتر	وضعيت	نوع داده	نمونه	شرح
merchant	اجباري	string	KnIT45OvAnd1584271146:8zN9iO1Y11tg6LVl	مرچنت را بايد در بخش کسب و کار ها از داخل پنل برداريد
authority	اجباري	number	35684	این مقدار در هنگام بازگشت از صفحه پرداخت به صورت GET ارسال میگردد

آدرس فراخوانی soap

آدرس : https://sepordeh.com/merchant/invoices/wsdl/

بازگشت از صفحه پرداخت

ایجاد فاکتور

Response
CURL
PHP
GO
NODE

{
    "status": 200, // وضعیت 200 به معنای موفقیت آمیز بودن ایجاد فاکتور می باشد
    "message": "add completed",
    "information": {
		"invoice_id": 4 // این عدد شماره فاکتور ایجاد شده می باشد که باید ذخیره نمایید
    }
}

curl --location --request POST 'https://sepordeh.com/merchant/invoices/add/' \
--form 'merchant="KnIT45OvAnd1584271146:8zN9iO1Y11tg6LVl"' \
--form 'amount="150000"' \
--form 'callback="http://website.com/callback"' \
--form 'description="خريد گوشي موبايل"' \
--form 'orderId="14886"' \
--form 'phone="09121234567"'

$parameters = array(
	"merchant"=>$merchant,
	"amount"=>$amount,
	"callback"=>$callback,
	"description"=>$description,
	"orderId"=>$orderId
);
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://sepordeh.com/merchant/invoices/add/");
curl_setopt($ch, CURLOPT_POSTFIELDS, $parameters);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($ch);
if(!!curl_errno($ch)){
	die("CURL ERROR:".curl_error($ch));
}else{
	$result = json_decode($result);
	if($result->status==200){
		//ارجاع به صفحه پرداخت
	}
}
curl_close($ch);

تابع : add(merchant,amount,currency_id,callback,phone,orderId,description)

نام پارامتر	وضعيت	نوع داده	نمونه	شرح
merchant	اجباري	string	KnIT45OvAnd1584271146:8zN9iO1Y11tg6LVl	مرچنت را بايد در بخش کسب و کار ها از داخل پنل برداريد
amount	اجباري	number	150000	مبلغ فاکتور به تومان
currency_id	اجباري	number	1	برای تومان 1 وارد شود
callback	اجباري	string	http://website.com/callback	آدرس بازگشت بعد از اتمام عمليات پرداخت
phone	اختياري	number	09121234567	شماره موبایل پرداخت کننده
orderId	اختياري	number	14886	شماره سفارش در سیستم شما (حداکثر 20 رقمی)
description	اختياري	string	خريد گوشي موبايل	توضيحات در مورد فاکتور

ارجاع به صفحه پرداخت

PHP
GO
NODE

header('Location: https://sepordeh.com/merchant/invoices/pay/automatic:true/id:'.$result->information->invoice_id, true, 302);

آدرس : https://sepordeh.com/merchant/invoices/pay/id:{invoice_id}

مقدار {{invoice_id}} را با شماره فاکتور دریافتی در مرحله قبل جایگزین کنید.

بازگشت از صفحه پرداخت

آدرس : http://website.com/callback?authority={{authority}}&&orderId={{orderId}}

هنگام بازگشت به آدرس callback دو پارامتر authority و orderId ارسال میگردد (توسط متد GET)

تایید فاکتور

Response
CURL
PHP
GO
NODE

{
    "status": 200, // وضعیت 200 به معنای موفقیت آمیز بودن پرداخت می باشد
    "message": "paid",
    "information": {
            "invoice_id": 4 ,
            "card": "6104********4510" // شماره کارت پرداخت کننده می باشد
    }
}

curl --location --request POST 'https://sepordeh.com/merchant/invoices/verify/' \
--form 'merchant="KnIT45OvAnd1584271146:8zN9iO1Y11tg6LVl"' \
--form 'authority="35684"'

$orderId = $_GET["orderId"];
if(isset($_GET["authority"])){
	$parameters = array(
		"merchant"=>$merchant,
		"authority"=>$_GET["authority"],
	);
	$ch = curl_init();
	curl_setopt($ch, CURLOPT_URL, "https://sepordeh.com/merchant/invoices/verify/");
	curl_setopt($ch, CURLOPT_POSTFIELDS, $parameters);
	curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
	curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
	curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
	$result = curl_exec($ch);
	if(!!curl_errno($ch)){
		die("CURL ERROR:".curl_error($ch));
	}else{
		$result = json_decode($result);
		if($result->status==200){
			//پرداخت موفق
		}else{
			die("خطا:".$result->message);
		}
	}
	curl_close($ch);
}

تابع : verify(merchant,authority)

نام پارامتر	وضعيت	نوع داده	نمونه	شرح
merchant	اجباري	string	KnIT45OvAnd1584271146:8zN9iO1Y11tg6LVl	مرچنت را بايد در بخش کسب و کار ها از داخل پنل برداريد
authority	اجباري	number	35684	این مقدار در هنگام بازگشت از صفحه پرداخت به صورت GET ارسال میگردد