معرفی

برای استفاده از وب سرویس ها در ابتدا با استفاد از متد "دریافت توکن" و اطلاعات مربوط به نام کاربری و رمزعبور حساب کاربری خود در سپال باید توکن دسترسی به وب سرویس را دریافت نمایید و سپس توکن دریافتی را در هدر درخواست خود با عنوان Authorization ارسال نمایید.

دریافت توکن

پارامترهای موجود در جدول زیر را به آدرس تعیین شده به صورت POST ارسال کنید، لطفا به نوع داده ها و نام فیلدها دقت نمایید.

عنوان فیلد	نوع	توضیحات
mobile	string	نام کاربری که همان شماره موبایل می باشد
password	string	کلمه عبور حساب کاربری

آدرس

Method: POST
URL: https://sepal.ir/api/users/token.json

پاسخ

{
    "status": true,
    "message": '',
    "data": [
        "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjEsImV4cCI6MTY3OTIyNzkwMH0.0nOb127pvQAX05pP-poQkYbQVZWhNnr3RbQ27ZG8_sd"
    ]
}

---

دریافت وضعیت تراکنش پرداخت آنلاین

پارامترهای هدر

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjEsImV4cCI6MTY3OTIyODM5Nn0.eky8mfX9L5QDL8Sxm2rNS3PJ6OoiwcID80Ofe_F-JLE

پارامترهای ورودی

عنوان فیلد	نوع	توضیحات
paymentNumber	integer	شماره پرداخت که در هنگام ارسال درخواست انجام تراکنش داده می شود

آدرس

Method: POST
URL: https://sepal.ir/api/onlinePayments/getState.json

پاسخ

{
    "status": true,
    "message": '',
    "item": {
        "payment_number": "412843002512",
        "state": "1",
        "state_label": "موفق"
    }
}

دریافت موجودی درگاه پرداخت

پارامترهای هدر

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjEsImV4cCI6MTY3OTIyODM5Nn0.eky8mfX9L5QDL8Sxm2rNS3PJ6OoiwcID80Ofe_F-JLE

پارامترهای ورودی

عنوان فیلد	نوع	توضیحات
apiKey	string	کلید وب سرویس، که پس از ثبت درخواست درگاه و تایید برای شما صادر می شود

آدرس

Method: POST
URL: https://sepal.ir/api/gates/balance.json

پاسخ

{
    "status": true,
    "message": '',
    "terminals": [
        {
          "code": "239400",
          "pspTitle": "پرداخت نوین آرین",
          "balance": "3232000"
        }
    ]
}

دریافت لیست تراکنش ها

پارامترهای هدر

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjEsImV4cCI6MTY3OTIyODM5Nn0.eky8mfX9L5QDL8Sxm2rNS3PJ6OoiwcID80Ofe_F-JLE

پارامترهای ورودی

عنوان فیلد	نوع	توضیحات
dateFrom	string	تاریخ شروع گزارش، مثلا: 1401/01/10
dateTo	string	تاریخ پایان گزارش، مثلا: 1401/06/20
payerCardNumber	string	شماره کارت پرداخت کننده
page	integer	شماره صفحه - اختیاری
limit	integer	تعداد رکوردهای هر صفحه - اختیاری

• برای دریافت لیست تراکنش ها ارسال مقدار بازه زمانی تراکنش ها و یا شماره کارت پرداخت کننده الزامی می باشد.(یکی از این دو فیلتر باید تعیین گردد)

آدرس

Method: POST
URL: https://sepal.ir/api/onlinePayments/inquiry.json

پاسخ

{
    "status": true,
    "message": '',
    "items": [
        {
          "payment_number": "1755366969864145",
          "amount": 3000000,
          "wage_amount": 30000,
          "payer_wage_amount": 0,
          "acceptor_wage_amount": 30000,
          "token": "iY49I2jCnunYcxhHZq8DNz0bKX8-sdkljskncbd47RE0c",
          "tracking_number": "144010",
          "invoice_number": null,
          "description": null,
          "payer_email": "",
          "payer_mobile": "",
          "payer_card_number": "603769********9641",
          "type": "3",
          "state": "1",
          "created": "1401/10/28 16:56:35",
          "type_label": "فرم پرداخت",
          "state_label": "موفق",

        },
        {
          "payment_number": "17554393664312547",
          "amount": 2500000,
          "wage_amount": 25000,
          "payer_wage_amount": 0,
          "acceptor_wage_amount": 25000,
          "token": "qBhtOiS9X9zcarNqEGYGTyKC1lKQIzuX8fP714545",
          "tracking_number": "243121",
          "invoice_number": null,
          "description": null,
          "payer_email": "",
          "payer_mobile": "",
          "payer_card_number": "603769********9641",
          "type": "3",
          "state": "1",
          "created": "1401/10/29 12:07:17",
          "type_label": "فرم پرداخت",
          "state_label": "موفق"
        },
    ],
    "page": 1,
    "limit": 20,
    "totalPages": 2,
}