سرویس های چک صیادی

لغو چک صیاد توسط صادر کننده (پیامکی)

<!--seo-open-->

سرویس «لغو چک صیاد توسط صادر کننده (پیامکی)» (Sayad / SMS/OTP) در دسته چک صیادی (Sayad) فینوتک؛ نسخه پیامکی برای فراخوانی با تایید کاربر. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. فراخوانی با تایید پیامکی کاربر (authorization_sms) انجام می‌شود. برای ساخت کلاینت و گرفتن توکن، راهنمای شروع را ببینید.

<!--/seo-open-->

این سرویس به صادرکننده اجازه می‌دهد با دریافت شناسه چک صیاد و اطلاعات لغوکننده، چک را لغو کند.

Scope: credit:sms-sayad-cancel-cheque:post<br />

Grant type: authorization_sms

post/credit/v2/clients/{clientId}/users/{user}/sms/sayadCancelCheque

Request

  • Base URL: https://api.finnotech.ir
  • URL: https://api.finnotech.ir/credit/v2/clients/{clientId}/users/{user}/sms/sayadCancelCheque
  • Auth: HTTP bearer

Path parameters

clientIdstring required
userstring required

User national ID (کد ملی کاربر)

Query parameters

trackIdstring

Request body

sayadIdstring required

شناسه صیاد چک ,

cancelDescriptionstring required

شرح لغو که این فیلد فقط میتواند شامل حروف فارسی باشد ,

Example request

{
  "sayadId": "6230008888888575",
  "cancelDescription": "رد",
  "canceller": {
    "idCode": "1111111111",
    "shahabId": "2000014000000000",
    "idType": "2"
  },
  "cancellerAgent": {
    "idCode": "0055555866",
    "shahabId": "2000014000000000",
    "idType": "1"
  }
}

Response

Successful response

trackIdstring

کد پیگیری، اگر ارسال شده باشد همان مقدار و در غیر اینصورت یک رشته تصادفی تولید و برگردانده میشود

statusstring

وضعیت فراخوانی سرویس

Example response

{
  "trackId": "7113b244-3c01-44f1-b395-e3ab464cfeaa",
  "status": "DONE",
  "result": {
    "message": "لغو چک با موفقیت انجام شد",
    "referenceId": "11111111111111"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.