Payment API (1.0.0)

Download OpenAPI specification:

این API برای مدیریت پرداخت‌ها از طریق پاناپاردخت طراحی شده است.

ارسال درخواست پرداخت

پذیرنده برای شروع تراکنش پرداخت باید داده‌های پرداخت را به آدرس PaymentRequest ارسال کند. پس از ارسال درخواست، پاناپاردخت یک Authority (شناسه مرجع) و وضعیت 100 را به عنوان تأیید دریافت می‌کند. سپس، کاربر باید به آدرس مخصوص پاناپاردخت هدایت شود تا عملیات پرداخت ادامه یابد.

Request Body schema: application/x-www-form-urlencoded
required
MerchantID
string

مرچنت آیدی (الزامی)

Amount
integer

مبلغ تراکنش به تومان (الزامی)

InvoiceID
integer

شناسه فاکتور (الزامی)

Description
string

توضیح درباره پرداخت

Email
string

ایمیل خریدار

Mobile
string

شماره موبایل خریدار

CallbackURL
string

URL بازگشتی که پس از تکمیل تراکنش، پاناپاردخت به آن هدایت می‌کند.

Responses

Response samples

Content type
application/json

بررسی وضعیت تراکنش (Verify)

پذیرنده پس از دریافت داده‌ها از پاناپاردخت در صفحه CallbackURL، باید در صورتی که مقدار PaymentStatus برابر با "OK" باشد، اطلاعات موجود را از طریق متد POST به آدرس https://paanapardakht.com/webservice/rest/PaymentVerification ارسال کرده و وضعیت تراکنش را بررسی کند. در صورتی که پاسخ دریافتی از API پاناپاردکحت وضعیت 100 را برگرداند، تراکنش موفقیت‌آمیز خواهد بود و پذیرنده باید پرداخت را ثبت کند. در غیر این صورت، پذیرنده باید با توجه به کد خطای دریافتی، کاربر را از خطای رخ داده مطلع کند. همچنین توجه داشته باشید که در صورتی که مقدار PaymentStatus برابر با "NOK" باشد، تراکنش ناموفق بوده و نیازی به ارسال درخواست PaymentVerification نیست.

Request Body schema: application/x-www-form-urlencoded
required
MerchantID
string

مرچنت آیدی (الزامی)

Authority
string

شناسه مرجع درخواست (الزامی)

Amount
integer

مبلغ تراکنش به تومان (الزامی)

Responses

Response samples

Content type
application/json
{
  • "Status": 100,
  • "RefID": "123456789",
  • "Amount": 1000,
  • "BuyerIP": "192.168.1.1",
  • "PaymentTime": "1615572800",
  • "MaskCardNumber": "1234-XXXX-XXXX-5678"
}