سرویس انتقال وجه به حساب بانکی

با این سرویس قادر خواهید بود به مقصد حساب های بانکی کاربران احراز هویت شده در پلتفرم تون واریز وجه انجام بدید. این سرویس فقط به شرکت ها و افراد حقوقی ارائه میشه و برای استفاده و فعالسازی می بایست از طریق ثبت تیکت در بخش پشتیبانی حساب کاربری با ما در تماس باشید.

مرحله اول: دریافت توکن

اولین مرحله برای استفاده از API ایجاد توکن می‌باشد. جهت ایجاد توکن به پنل کاربری خود مراجعه و از بخش توسعه دهندگان توکن جدید ایجاد کنید. به تاریخ انقضای توکن توجه کنید. بعد از زمان منقضی شدن توکن، برای حفظ امنیت بیشتر می بایست توکن جدید ایجاد و جایگزین نمایید

هنگام ارسال درخواست، توکن دریافتی را در Header و فیلد Authorization و بعد از Bearer ارسال نمایید.

Authorization: Bearer {token}

لیست کیف پول ها

با متد زیر میتونید لیست کیف پول های حساب تون رو به همراه موجودی و شناسه کیف پول دریافت کنید

Method: GET
URL:    https://pay.ir/api/v2/wallets
Header: Authorization: Bearer {token}

HTTP/1.1 200 OK

{
  "success": true,
  "data": {
    "wallets": [
      {
        "id": 1,
        "name": "نام کیف پول",
        "balance": "موجودی کیف پول",
        "cashoutableAmount": "قابل برداشت امروز"
      },
      ...
    ]
  },
  "errors": [],
  "message": ""
}

HTTP/1.1 422 Error

{
  "success": false,
  "data": null,
  "errors": [
    {
      "field": [
        "error message"
      ]
    }
  ],
  "message": "error message"
}

اطلاعات کیف پول

با این متد زیر میتونید بر اساس شناسه کیف پول اطلاعاتی مثل موجودی و اسم کیف پول رو دریافت کنید

Method: GET
Url:    https://pay.ir/api/v2/wallets/{id}
Header: Authorization: Bearer {token}

پارامترهای مجاز

فیلد	نوع	توضیحات
id	Integer	شناسه کیف پول (جایگذاری در URL سرویس)

HTTP/1.1 200 OK

{
  "success": true,
  "data": {
    "wallet": {
      "id": 1,
      "name": "نام کیف پول",
      "balance": "موجودی کیف پول",
      "cashoutableAmount": "قابل برداشت امروز"
    }
  },
  "errors": [],
  "message": ""
}

HTTP/1.1 422 Error

{
  "success": false,
  "data": null,
  "errors": [
    {
      "field": [
        "error message"
      ]
    }
  ],
  "message": "error message"
}

ثبت حواله بانکی

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

مهم

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

Method: POST
Url:    https://pay.ir/api/v2/cashouts
Header: Authorization: Bearer {token}

پارامتر

فیلد	نوع	توضیحات
walletId	Integer	شناسه کیف پول
amount	Integer	مبلغ به ریال
name	String	نام دریافت کننده حواله
iban	String	شماره شبای بانک مقصد
uid	String	شناسه یکتا برای هر درخواست
institutionId	String	شناسه موسسه (اختیاری)
paymentId	String	شناسه پرداخت (اختیاری)

توجه

مقدار پارامتر uid رو شما تعیین میکنید و باید رشته یا عددی رو ارسال کنید که همیشه unique باشه و برای هر حواله یک مقدار متفاوت درنظر بگیرید که بتونید با این مقدار از سرویس استعلام های مورد نیازتون رو بگیرید.

HTTP/1.1 201 Created

{
  "success": true,
  "data": {
    "cashout": {
      "id": 1,
      "transactionId": 1,
      "amount": 100000,
      "name": "نام صاحب حساب مقصد",
      "bankAccountNumber": "XXX-XXX-XXXXX-X",
      "bankIbanNumber": "XXXXXXXXXXXXXXXXXXXXXXXX",
      "depositReferrerNumber": "XXXXXXXXXXXX",
      "status": "کد وضعیت",
      "statusLabel": "وضعیت",
      "rejectReason": "",
      "createdAt": "2021-03-21 00:00:00",
      "jalaliCreatedAt": "1400-01-01 00:00:00"
    }
  },
  "errors": [],
  "message": ""
}

{
  1: "در انتظار پرداخت",
  2: "درحال پرداخت",
  3: "رد شده",
  4: "پرداخت شده",
  5: "حذف شده"
}

HTTP/1.1 422 Error

{
  "success": false,
  "data": null,
  "errors": [
    {
      "field": [
        "error message"
      ]
    }
  ],
  "message": "error message"
}

حذف حواله بانکی

با این متد میتونید تا وقتی که حواله ثبت شده وضعیت درانتظار تایید داره، نسبت به حذفش اقدام کنید.طبیعتا وقتی وضعیت درحال پرداخت یا پرداخت شده بگیره قابل حذف نیست.

Method: DELETE
Url:    https://pay.ir/api/v2/cashouts/{id}
Header: Authorization: Bearer {token}

پارامتر

فیلد	نوع	توضیحات
id	Integer	شناسه تسویه حساب دریافتی هنگام ثبت درخواست

HTTP/1.1 200 OK

{
  "success": true,
  "data": null,
  "errors": [],
  "message": "درخواست تسویه حساب حذف شد"
}

HTTP/1.1 422 Error

{
  "success": false,
  "data": null,
  "errors": [
    {
      "field": [
        "error message"
      ]
    }
  ],
  "message": "error message"
}

دریافت اطلاعات حواله

با این متد میتونید اطلاعات حواله بانکی ثبت شده رو مجدد دریافت و در دیتابیس تون ذخیره کنید.

Method: GET
Url:    https://pay.ir/api/v2/cashouts/{id}
Header: Authorization: Bearer {token}

پارامتر

فیلد	نوع	توضیحات
id	Integer	شناسه تسویه حساب

HTTP/1.1 200 OK

{
  "success": true,
  "data": {
    "cashout": {
      "id": 1,
      "transactionId": 1,
      "amount": 100000,
      "name": "نام صاحب حساب مقصد",
      "bankAccountNumber": "XXX-XXX-XXXXX-X",
      "bankIbanNumber": "XXXXXXXXXXXXXXXXXXXXXXXX",
      "depositReferrerNumber": "XXXXXXXXXXXX",
      "status": "کد وضعیت",
      "statusLabel": "وضعیت",
      "rejectReason": "",
      "createdAt": "2021-03-21 00:00:00",
      "jalaliCreatedAt": "1400-01-01 00:00:00"
    }
  },
  "errors": [],
  "message": ""
}

{
  1: "در انتظار پرداخت",
  2: "درحال پرداخت",
  3: "رد شده",
  4: "پرداخت شده",
  5: "حذف شده"
}

HTTP/1.1 422 Error

{
  "success": false,
  "data": null,
  "errors": [
    {
      "field": [
        "error message"
      ]
    }
  ],
  "message": "error message"
}

دریافت لیست حواله ها

با این متد میتونید لیست حواله های بانکی ثبت شده رو دریافت کنید :

Method: GET
Url:    https://pay.ir/api/v2/cashouts
Header: Authorization: Bearer {token}

پارامتر

فیلد	نوع	توضیحات
id	Integer	شناسه تسویه حساب
transactionId	Integer	شماره تراکنش
depositReferrerNumber	String	شماره پیگیری بانک
sort	String	ترتیب - asc, desc

HTTP/1.1 200 OK

{
  "success": true,
  "data": {
    "cashouts": [
      {
        "id": 1,
        "transactionId": 1,
        "amount": 100000,
        "name": "نام صاحب حساب مقصد",
        "bankAccountNumber": "XXX-XXX-XXXXX-X",
        "bankIbanNumber": "XXXXXXXXXXXXXXXXXXXXXXXX",
        "depositReferrerNumber": "XXXXXXXXXXXX",
        "status": "کد وضعیت",
        "statusLabel": "وضعیت",
        "rejectReason": "",
        "createdAt": "2021-03-21 00:00:00",
        "jalaliCreatedAt": "1400-01-01 00:00:00"
      },
      ...
    ]
  }
}

{
  1: "در انتظار پرداخت",
  2: "درحال پرداخت",
  3: "رد شده",
  4: "پرداخت شده",
  5: "حذف شده"
}

HTTP/1.1 422 Error

{
  "success": false,
  "data": null,
  "errors": [
    {
      "field": [
        "error message"
      ]
    }
  ],
  "message": "error message"
}

پیگیری وضعیت حواله

با استفاده از این پارامتر میتونید دیتاهای مورد نیاز برای پیگیری درخواست تون رو دریافت کنید

Method: GET
Url:    https://pay.ir/api/v2/cashouts/track/{uid}
Header: Authorization: Bearer {token}

پارامتر

فیلد	نوع	توضیحات
uid	String	شناسه یکتا به ازای هر درخواست

HTTP/1.1 200 OK

{
  "success": true,
  "data": {
    "cashout": {
      "id": 1,
      "transactionId": 1,
      "amount": 100000,
      "name": "نام صاحب حساب مقصد",
      "bankAccountNumber": "XXX-XXX-XXXXX-X",
      "bankIbanNumber": "XXXXXXXXXXXXXXXXXXXXXXXX",
      "depositReferrerNumber": "XXXXXXXXXXXX",
      "status": "کد وضعیت",
      "statusLabel": "وضعیت",
      "rejectReason": "",
      "createdAt": "2021-03-21 00:00:00",
      "jalaliCreatedAt": "1400-01-01 00:00:00"
    }
  },
  "errors": [],
  "message": ""
}

{
  1: "در انتظار پرداخت",
  2: "درحال پرداخت",
  3: "رد شده",
  4: "پرداخت شده",
  5: "حذف شده"
}

HTTP/1.1 422 Error

{
  "success": false,
  "data": null,
  "errors": [
    {
      "field": [
        "error message"
      ]
    }
  ],
  "message": "error message"
}

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

با این متد میتونید لیست تراکنش های ثبت شده در پنل کاربری تون رو دریافت و در پلتفرم تون ذخیره کنید

Method: GET
Url:    https://pay.ir/api/v2/transactions
Header: Authorization: Bearer {token}

پارامتر

فیلد	نوع	توضیحات
fromDate	DateTime	2018-10-10
toDate	DateTime	2018-10-10
fromAmount	Integer	از مبلغ (ریال)
toAmount	Integer	تا مبلغ (ریال)
transactionId	Integer	شماره تراکنش
depositType	Integer	نوع واریزی: 1, -1
transactionType	Integer	نوع تراکنش
cardNumber	String	شماره کارت
factorNumber	String	شماره فاکتور
walletId	Integer	کیف پول
sort	String	ترتیب: asc, desc

HTTP/1.1 200 OK

{
  "success": true,
  "data": {
    "transactions": [
      {
        "id": 1,
        "depositType": "نوع واریزی",
        "depositAmount": 100000,
        "transactionAmount": 100000,
        "balance": 100000,
        "transactionType": "نوع تراکنش",
        "transactionTypeLabel": "نوع تراکنش",
        "ip": "-",
        "country": "-",
        "detail": {
          // جزئیات تراکنش
          "from": {
            "walletId": "",
            "name": "",
            "cardNumber": "",
            "mobile": ""
          },
          "to": {
            "walletId": "",
            "name": "",
            "mobile": "",
            "bankAccountNumber": "",
            "bankSheba": "",
            "formName": "",
            "website": "",
            "factorNumber": ""
          },
          "extra": {
            "website": "",
            "factorNumber": "",
            "mobile": "",
            "formName": "",
            "name": "",
            "email": "",
            "paymentId": ""
          }
        },
        "createdAt": "2021-03-21 00:00:00",
        "jalaliCreatedAt": "1400-01-01 00:00:00"
      },
      ...
    ]
  }
}

{
  1: "واریز",
  -1: "برداشت"
}

{
  1: "افزایش موجودی",
  2: "انتقال وجه",
  3: "تسویه حساب",
  4: "درگاه پرداخت",
  7: "بازگشت وجه",
  10: "افزایش موجودی (آفلاین)",
  13: "لینک شخصی‌"
}

HTTP/1.1 422 Error

{
  "success": false,
  "data": null,
  "errors": [
    {
      "field": [
        "error message"
      ]
    }
  ],
  "message": "error message"
}

استعلام شماره شبا

با این متد میتونید شماره شبای خاصی رو استعلام بگیرید و مطمئن بشید که شماره شبایی که مشتری شما اعلام کرده درسته یا اشتباه و وضعیت مالکیت اون شماره شبا رو بررسی کنید. برای این منظور پارامترهای زیر رو با متد پست به ادرس زیر ارسال کنید

Method: GET
Url:    https://pay.ir/api/v2/cashouts/inquiry/{iban}
Header: Authorization: Bearer {token}

پارامترهای مجاز

نام فیلد	نوع	توضیحات
iban	String	شماره شبا 24 رقمی بدون IR

HTTP/1.1 200 OK

{
  "success": true,
  "data": {
    "iban": {
      "name": "نام صاحب حساب",
      "bank": "نام بانک,",
      "acc": "111-111-1111111-1",
      "comment": "سپرده سرمايه گذاري کوتاه مدت-ريالي- اشخاص حقيقي"
    }
  },
  "errors": [],
  "message": ""
}

HTTP/1.1 422 Error

{
  "success": false,
  "data": null,
  "errors": [
    {
      "field": [
        "error message"
      ]
    }
  ],
  "message": "error message"
}

انتقال وجه به کیف پول خود

با این متد میتونید به کیف پول های خودتون انتقال وجه داشته باشید

Method: POST
Url:    https://pay.ir/api/v2/transfer/self
Header: Authorization: Bearer {token}

پارامترهای مجاز

نام فیلد	نوع	توضیحات
fromWallet	Integer	کیف پول مبدا
toWallet	Integer	کیف پول مقصد
amount	Integer	مبلغ (ریال)
description	String	توضیحات (اختیاری)
ip	String	آدرس آی پی

نکته

در پارامتر IP می بایست IP انجام دهنده تراکنش که در اینجا سرور شماست ارسال شود

HTTP/1.1 201 Created

{
  "success": true,
  "data": {
    "transfer": [
      {
        "transactionId": 1,
        "amount": 100000
      }
    ]
  },
  "errors": [],
  "message": "انتقال وجه با موفقیت انجام شد"
}

HTTP/1.1 422 Error

{
  "success": false,
  "data": null,
  "errors": [
    {
      "field": [
        "error message"
      ]
    }
  ],
  "message": "error message"
}

انتقال وجه به کیف پول دیگران

با این متد میتونید از کیف پول های خودتون به حساب های کاربری در شبکه پرداخت پی انتقال وجه داشته باشید

Method: POST
Url:    https://pay.ir/api/v2/transfer/other
Header: Authorization: Bearer {token}

پارامترهای مجاز

نام فیلد	نوع	توضیحات
fromWallet	Integer	کیف پول مبدا
mobile	String	شماره موبایل مقصد (09xxxxxxxxx)
nationalCode	String	کد ملی کابر مقصد (اختیاری)
amount	Integer	مبلغ (ریال)
description	String	توضیحات (اختیاری)
ip	String	آدرس آی پی (اختیاری)
uid	String	شناسه یکتا برای هر درخواست (اختیاری)
paymentId	String	شناسه پرداخت (اختیاری - فقط کد ملی)

نکته

• شماره موبایل مقصد در صورتی استفاده و اجباری می باشد که کد ملی کابر مقصد وارد نشده باشد
• در پارامتر IP می بایست IP انجام دهنده تراکنش که در اینجا سرور شماست ارسال شود

HTTP/1.1 201 Created

{
  "success": true,
  "data": {
    "transfer": [
      {
        "transactionId": 1,
        "amount": 100000
      }
    ]
  },
  "errors": [],
  "message": "انتقال وجه با موفقیت انجام شد"
}

HTTP/1.1 422 Error

{
  "success": false,
  "data": null,
  "errors": [
    {
      "field": [
        "error message"
      ]
    }
  ],
  "message": "error message"
}