خانه درگاه پرداخت مستندات API راهنمای استفاده افزونه‌ها

# تسویه پیش از موعد

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

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

لطفا در نظر داشته باشید: حداقل مبلغ برای تسویه پیش از موعد، ۱ میلیون ریال است.

تسویه پیش از موعد به حساب‌های بانک آینده به صورت آنی و سایر حساب‌های بانکی از طریق سرویس پایا/ساتنا انجام می‌شود.

تسویه پیش از موعد از ساعت ۰۵:۰۰ الی ۲۳:۰۰ قابل استفاده است.

کارمزد تسویه به مبلغ خالص درخواستی اضافه خواهد شد.

# شناسه حساب بانکی

برای استفاده از این سرویس، در مرحله اول نیاز به دریافت اطلاعات شماره حساب بانکی پنل کاربری خود دارید. برای مشاهده این اطلاعات می‌توانید از کوئری زیر استفاده کنید:

query{
  BankAccounts(limit: 200) {
    id
    iban
    holder_name
  }
}

در پاسخ به این درخواست، پاسخی به این شکل دریافت می‌شود:

{
  "data": {
    "BankAccounts": [
      {
        "id": "367527",
        "iban": "IR470620000000303091989009",
        "holder_name": "خلیل یوسفی"
      },
      {
        "id": "297008",
        "iban": "IR500170000000353309608005",
        "holder_name": "امین  محمد رنجبر"
      },
      {
        "id": "290406",
        "iban": "IR760570028080010489217101",
        "holder_name": "وحيد داوري"
      },
      {
        "id": "284481",
        "iban": "IR490130100000000278238518",
        "holder_name": "آرمین زاهدی"
      }
    ]
  }
}

# شناسه درگاه پرداخت (ترمینال ایدی)

در مرحله دوم نیاز به دریافت شناسه درگاه پرداخت خود دارید که برای مشاهده آن می‌توانید از کوئری زیر استفاده کنید:

query terminals {
  Terminals {
    id
    domain
  }
}

در پاسخ به این درخواست، پاسخی به این شکل دریافت می‌شود:

{
  "data": {
    "Terminals": [
      {
        "id": "221217",
        "domain": "doosoo.ir"
      },
      {
        "id": "1185",
        "domain": "u-b.ir"
      },
      {
        "id": "238",
        "domain": "golroz.com"
      }
    ]
  }
}

# ساخت تسویه پیش از موعد

پس از به دست آوردن شناسه حساب بانکی، می‌توانید با استفاده از پارامترهای زیر یک درخواست برای ساخت تسویه پیش از موعد ایجاد کنید:

  • terminal_id شناسه درگاه پرداختی که این قابلیت برای آن فعال است. (اجباری)

  • amount مبلغ به ریال(اجباری)

  • bank_account_id شماره حساب بانکی که در پنل کاربری زرین‌پال خود ثبت کرده اید. (اجباری)

mutation InstantPayoutAdd($terminal_id: ID!, $bank_account_id: ID!, $amount: BigInteger!) {
  resource: InstantPayoutAdd(terminal_id: $terminal_id, bank_account_id: $bank_account_id, amount: $amount) {
    id
    url_code
    status
    amount
    fee
    created_at
  }
}

Query Variables

{
  "terminal_id": "238",
  "bank_account_id": "353",
  "amount": "5000000"
}

در پاسخ به این درخواست، پاسخی به این شکل دریافت می‌شود:

{
  "data": {
    "resource": {
      "id": "22571",
      "url_code": "9bRqG",
      "status": "PENDING",
      "amount": 5000000,
      "fee": 35000,
      "created_at": "2022-11-21T11:32:32+03:30"
    }
  }
}

# وضعیت تسویه ها

برای بررسی وضعیت تسویه‌های پیش از موعد ساخته شده از کوئری زیر استفاده کنید:

  • terminal_id شناسه درگاه پرداختی که این قابلیت برای آن فعال است. (اجباری)

  • id در صورت نیاز به بررسی وضعیت یک شناسه تسویه خاص، شناسه آن را وارد نمایید.



موارد بازگشتی نتیجه کوئری فوق به شرح زیر است:

  • id شناسه تسویه

  • url_code رسید تسویه پیش از موعد

  • status وضعیت تسویه

    • PAID تسویه شده

    • PENDING در حال پردازش

    • IN_PROGRESS ارسال شده به شاپرک

    • REVERSED بازگردانی شده

    • REJECTED رد شده

  • description توضیحات

  • amount مبلغ

  • fee کارمزد تسویه

  • reference_id شماره پیگیری

  • reconciled_at تاریخ و ساعت ثبت درخواست

  • updated_at تاریخ و ساعت تسویه

query getInstantPayout($id: ID, $terminal_id: ID) {
  resource: InstantPayout(id: $id, terminal_id: $terminal_id) {
    id
    url_code
    status
    description
    amount
    fee
    reference_id
    reconciled_at
    created_at
    updated_at
  }
}

Query Variables

{
  "terminal_id": "238",
  "id": "22571"
}

در پاسخ به این درخواست، اگر یک ایدی خاص را وارد کرده باشیم پاسخی به این شکل دریافت می‌شود:

{
  "data": {
    "resource": [
      {
        "id": "22571",
        "url_code": "9bRqG",
        "status": "PAID",
        "description": null,
        "amount": 5000000,
        "fee": 35000,
        "reference_id": "140108300622833423",
        "reconciled_at": "2022-11-21T11:32:49+03:30",
        "created_at": "2022-11-21T11:32:32+03:30",
        "updated_at": "2022-11-21T11:32:51+03:30"
      }
    ]
  }
}