Method: getDisputeInquiryReport

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

اگر این روش یک HTTP 200 را برنگرداند، ممکن است پاسخ به این پرس و جو خالی باشد.

اگر نقطه پایانی هنگام پردازش درخواست با خطا مواجه شود، پاسخ این نقطه پایانی از نوع ErrorResponse خواهد بود.

اگر این روش یک HTTP 200 را برنگرداند، ممکن است پاسخ‌های این عبارت خالی باشد. بدنه پاسخ در شرایطی که می‌توان از یک ErrorResponse با توضیح واضح برای کمک به مهاجم برای درک شناسه حساب یکپارچه‌ساز پرداخت سایر ادغام‌کننده‌ها استفاده کرد، خالی است. در این شرایط، که یا کلید امضا مطابقت ندارد، شناسه یکپارچه پرداخت پیدا نشد، یا کلید رمزگذاری ناشناخته بود، این روش یک HTTP 404 را با بدنه خالی برمی گرداند. اگر امضای درخواست تأیید شود، اطلاعات اضافی در مورد خطا در بدنه پاسخ بازگردانده می شود.

یک نمونه درخواست به نظر می رسد:


{
  "requestHeader": {
    "protocolVersion": {
      "major": 3
    },
    "requestId": "HsKv5pvtQKTtz7rdcw1YqE",
    "requestTimestamp": {
      "epochMillis": "1519996751331"
    },
    "paymentIntegratorAccountId": "InvisiCashUSA_USD"
  },
  "paymentLookupCriteria": {
    "googleTransactionReferenceNumberCriteria": {
      "googleTransactionReferenceNumber": "714545417102363157911822",
      "authorizationCode": "111111"
    }
  },
  "existingGoogleClaimId": "138431383281",
  "requestOriginator": {
    "organizationId": "ISSUER_256",
    "organizationDescription": "Community Bank of Some City",
    "agentId": "982749"
  }
}

یک نمونه پاسخ به نظر می رسد:


{
  "responseHeader": {
    "responseTimestamp": {
      "epochMillis": "1519996752221"
    }
  },
  "result": {
    "success": {
      "googleClaimId": "138431383281",
      "report": {
        "customerAccount": {
          "customerEmail": "example@gmail.com",
          "customerName" : "Example Customer"
        },
        "order": {
          "timestamp": {
            "epochMillis": "1517992525972"
          },
          "orderId": "SOP.8976-1234-1234-123456..99",
          "subTotalAmount": {
            "amountMicros": "206990000",
            "currencyCode": "USD"
          },
          "totalAmount": {
            "amountMicros": "212990000",
            "currencyCode": "USD"
          },
          "shippingAddress": {
            "addressLine": ["123 Main St"],
            "localityName": "Springfield",
            "administrativeAreaName": "CO",
            "postalCodeNumber": "80309",
            "countryCode": "US"
          },
          "taxes": [
            {
              "description": "Colorado Sales Tax",
              "amount": {
                "amountMicros": "6000000",
                "currencyCode": "USD"
              }
            }
          ],
          "items": [
            {
              "description": "Super cool gizmo",
              "merchant": "HTC",
              "googleProductName": "Google Store",
              "quantity": "2",
              "totalPrice": {
                "amountMicros": "198000000",
                "currencyCode": "USD"
              }
            },
            {
              "description": "Gizmo charger",
              "merchant": "HTC",
              "googleProductName": "Google Store",
              "quantity": "1",
              "totalPrice": {
                "amountMicros": "8990000",
                "currencyCode": "USD"
              }
            }
          ]
        },
        "payment": {
          "billingAddress" : {
            "addressLine": ["123 Main St"],
            "localityName": "Springfield",
            "administrativeAreaName": "CO",
            "postalCodeNumber": "80309",
            "countryCode": "US"
          },
          "amount": {
            "amountMicros": "100000000",
            "currencyCode": "USD"
          },
          "refunds": [
            {
              "amount": {
                "amountMicros": "9250000",
                "currencyCode": "USD"
              },
              "initiatedTimestamp": {
                "epochMillis": "1518811245384"
              }
            }
          ],
          "cardDetails": {
            "authResult": "APPROVED"
          }
        }
      }
    }
  }
}

درخواست HTTP

POST https://vgw.googleapis.com/secure-serving/gsp/v3/getDisputeInquiryReport/ :PIAID

درخواست بدن

بدنه درخواست حاوی داده هایی با ساختار زیر است:

نمایندگی JSON
{
  "requestHeader": {
    object (RequestHeader)
  },
  "paymentLookupCriteria": {
    object (PaymentLookupCriteria)
  },
  "existingGoogleClaimId": string,
  "requestOriginator": {
    object (RequestOriginator)
  }
}
زمینه های
requestHeader

object ( RequestHeader )

مورد نیاز : هدر مشترک برای همه درخواست ها.

paymentLookupCriteria

object ( PaymentLookupCriteria )

الزامی : معیارهایی که پرداختی را نشان می دهد که باید برای این استعلام جستجو شود.

existingGoogleClaimId

string

اختیاری : یک رشته ایجاد شده توسط Google که با تماس قبلی به getDisputeInquiryReport برگردانده می‌شود که به‌طور منحصربه‌فرد این ادعای اختلاف مشتری را شناسایی می‌کند.

اگر این وجود نداشته باشد، یک شناسه ادعای جدید ایجاد خواهد شد. اگر تماس گیرنده ادامه همان اختلاف مشتری باشد، ممکن است یک googleClaimId که با تماس قبلی به getDisputeInquiryReport برگردانده شده است ارائه دهد.

شناسه ادعایی که در اینجا پر شده یا ایجاد شده است در قسمت googleClaimId پاسخ برگردانده می شود.

ارائه googleClaimId که با تماس قبلی به getDisputeInquiryReport برگردانده نشده است معتبر نیست. اگر این اتفاق بیفتد، HTTP 400 Bad Request برگردانده خواهد شد.

requestOriginator

object ( RequestOriginator )

مورد نیاز : اطلاعات مربوط به سازمان یا زیر گروه سازمانی که این درخواست را ایجاد کرده است.

بدن پاسخگو

این روش از چندین نوع بازگشت پشتیبانی می کند. برای اطلاعات بیشتر در مورد کد وضعیت 4XX یا 5XX HTTP که باید با ErrorResponse بازگردانده شود، به شی ErrorResponse و مستندات کدهای وضعیت HTTP مراجعه کنید.

این روش از چندین نوع بازگشت پشتیبانی می کند. برای اطلاعات بیشتر در مورد کد وضعیت 4XX یا 5XX HTTP که باید با ErrorResponse بازگردانده شود، به شی ErrorResponse و مستندات کدهای وضعیت HTTP مراجعه کنید.

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

پیام های پاسخ احتمالی
وضعیت HTTP 200

object ( GetDisputeInquiryReportResponse )

وضعیت HTTP 4XX / 5XX

object ( ErrorResponse )

RequestHeader

شی هدر که روی تمام درخواست های ارسال شده به سرور تعریف می شود.

نمایندگی JSON
{
  "requestId": string,
  "requestTimestamp": {
    object (Timestamp)
  },
  "protocolVersion": {
    object (Version)
  },
  "paymentIntegratorAccountId": string
}
زمینه های
requestId

string

مورد نیاز : شناسه منحصر به فرد این درخواست.

این رشته ای است که حداکثر طول آن 100 کاراکتر است و فقط شامل کاراکترهای "az"، "AZ"، "0-9"، ":"، "-"، و "_" است.

requestTimestamp

object ( Timestamp )

الزامی : مهر زمانی این درخواست. گیرنده باید تأیید کند که این مُهر زمانی ± 60 ثانیه «اکنون» است و اگر اینطور نیست درخواست را رد کند. این مهر زمانی درخواست پس از تلاش مجدد بی تاثیر نیست.

protocolVersion

object ( Version )

مورد نیاز : نسخه این درخواست.

paymentIntegratorAccountId

string

مورد نیاز : یک حساب منحصر به فرد با محدودیت های قراردادی را شناسایی می کند.

مهر زمان

یک شیء مهر زمانی که نشان دهنده یک نقطه در جدول زمانی ISO در میلی ثانیه از زمان یونیکس است.

نمایندگی JSON
{
  "epochMillis": string
}
زمینه های
epochMillis

string ( Int64Value format)

مورد نیاز : میلی ثانیه از دوران یونیکس

نسخه

شی نسخه شامل نسخه اصلی API است. نسخه‌های همان نسخه اصلی تضمین می‌شوند که سازگار باشند. یکپارچه کننده باید از همه درخواست ها برای یک نسخه اصلی پشتیبانی کند.

نمایندگی JSON
{
  "major": integer
}
زمینه های
major

integer

مورد نیاز : نسخه اصلی. این برای درخواست‌های سازگاری با نسخه‌های مختلف علامت‌گذاری شده است و تضمین نمی‌شود که سازگار باشند.

معیارهای PaymentLookup

کانتینری برای معیارهایی که می تواند به طور منحصر به فرد پرداخت را جستجو کند. یک قسمت (و تنها یک) عضو باید پر شود.

نمایندگی JSON
{

  // Union field criteria can be only one of the following:
  "arnCriteria": {
    object (ArnCriteria)
  },
  "googleTransactionReferenceNumberCriteria": {
    object (GoogleTransactionReferenceNumberCriteria)
  },
  "captureRequestCriteria": {
    object (CaptureRequestCriteria)
  }
  // End of list of possible types for union field criteria.
}
زمینه های

criteria میدان اتحادیه

criteria فقط می توانند یکی از موارد زیر باشند:

arnCriteria

object ( ArnCriteria )

اختیاری : جستجو بر اساس شماره مرجع گیرنده (ARN).

googleTransactionReferenceNumberCriteria

object ( GoogleTransactionReferenceNumberCriteria )

اختیاری : جستجو بر اساس شماره مرجع تراکنش Google.

captureRequestCriteria

object ( CaptureRequestCriteria )

اختیاری : جستجو بر اساس درخواست ضبط اصلی.

معیارهای Arn

معیارهای جستجوی پرداخت بر اساس شماره مرجع گیرنده (ARN).

نمایندگی JSON
{
  "acquirerReferenceNumber": string,
  "authorizationCode": string
}
زمینه های
acquirerReferenceNumber

string

الزامی : شماره مرجع دریافت کننده (ARN) که به طور منحصر به فرد پرداخت را مشخص می کند. باید 23 رقم باشد.

authorizationCode

string

مورد نیاز : کد مجوز برای معامله.

معیارهای Google TransactionReferenceNumber

معیارهای جستجوی پرداخت براساس شماره مرجع تراکنش ایجاد شده توسط Google.

نمایندگی JSON
{
  "googleTransactionReferenceNumber": string,
  "authorizationCode": string
}
زمینه های
googleTransactionReferenceNumber

string

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

authorizationCode

string

مورد نیاز : کد مجوز برای معامله.

CaptureRequestCriteria

معیارهای جستجوی پرداخت بر اساس درخواست ضبط اصلی.

نمایندگی JSON
{
  "captureRequestId": string
}
زمینه های
captureRequestId

string

مورد نیاز : یک شناسه منحصر به فرد برای این تراکنش. این requestId است که توسط Google در طول تماس capture ایجاد شده و در حال جستجو است.

RequestOriginator

اطلاعات مربوط به سازمان یا گروه فرعی سازمانی و به صورت اختیاری کارمندی که این درخواست از آن منشا گرفته است. این به Google امکان می‌دهد مشکلات یا سوء استفاده را شناسایی کرده و کنترل‌ها را در سطح دقیق‌تری نسبت به paymentIntegratorAccountId اجرا کند. به ویژه زمانی ارزشمند است که فراخوان یک ارائه دهنده خدمات واسطه باشد که منابع از چندین مشتری خارجی درخواست می کنند.

نمایندگی JSON
{
  "organizationId": string,
  "organizationDescription": string,
  "agentId": string
}
زمینه های
organizationId

string

الزامی : شناسه شرکت، سازمان یا گروه سازمانی که این درخواست از آن منشا گرفته است. باید در این paymentIntegratorAccountId منحصر به فرد باشد.

organizationDescription

string

الزامی : نام یا توصیفی از سازمان که برای انسان قابل خواندن است که می تواند برای تسهیل ارتباط بین کارمندان Google و ادغام کننده در مورد آن سازمان استفاده شود.

agentId

string

اختیاری : یک شناسه منحصر به فرد برای عامل خاص (کارمند) سازمان که توسط organizationId شناسایی شده است که این درخواست از او سرچشمه گرفته است. باید در این organizationId شناسه منحصر به فرد باشد.

GetDisputeInquiryReportResponse

بار پاسخ برای روش getDisputeInquiryReport .

نمایندگی JSON
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "result": {
    object (GetDisputeInquiryReportResult)
  }
}
زمینه های
responseHeader

object ( ResponseHeader )

مورد نیاز : هدر مشترک برای همه پاسخ ها.

result

object ( GetDisputeInquiryReportResult )

الزامی : نتیجه این تماس.

ResponseHeader

شی هدر که روی تمام پاسخ های ارسال شده از سرور تعریف می شود.

نمایندگی JSON
{
  "responseTimestamp": {
    object (Timestamp)
  }
}
زمینه های
responseTimestamp

object ( Timestamp )

الزامی : مهر زمانی این پاسخ. گیرنده باید تأیید کند که این مُهر زمانی ± 60 ثانیه از «اکنون» است، و در صورت عدم پاسخ، پاسخ را رد کند.

GetDisputeInquiryReportResult

نمایندگی JSON
{

  // Union field result can be only one of the following:
  "success": {
    object (SuccessDetails)
  },
  "paymentNotFound": {
    object (Empty)
  },
  "paymentTooOld": {
    object (Empty)
  },
  "orderCannotBeReturned": {
    object (Empty)
  },
  "noAdditionalDetails": {
    object (Empty)
  }
  // End of list of possible types for union field result.
}
زمینه های

result میدان اتحادیه

result می تواند تنها یکی از موارد زیر باشد:

success

object ( SuccessDetails )

پرداخت پیدا شد و گزارش ارائه شد.

paymentNotFound

object ( Empty )

پرداخت درخواستی یافت نشد.

paymentTooOld

object ( Empty )

پرداخت درخواستی پیدا شد، اما گزارشی به دلیل قدیمی بودن پرداخت ارائه نشد.

orderCannotBeReturned

object ( Empty )

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

noAdditionalDetails

object ( Empty )

پرداخت درخواستی پیدا شد، اما گزارشی در دسترس نیست.

جزئیات موفقیت

نمایندگی JSON
{
  "googleClaimId": string,
  "report": {
    object (PurchaseReport)
  }
}
زمینه های
googleClaimId

string

الزامی : یک رشته ایجاد شده توسط Google که به طور منحصر به فرد این اختلاف مشتری را شناسایی می کند.

اگر existingGoogleClaimId در درخواست پر شده باشد، این مقدار یکسان خواهد بود. در غیر این صورت، یک مقدار جدید تولید شده خواهد بود. این مقدار می‌تواند در درخواست‌های getDisputeInquiryReport در آینده ارائه شود، اگر آنها بخشی از اختلاف مشتری مشابه باشند.

report

object ( PurchaseReport )

الزامی : جزئیات مربوط به اختلاف پرداخت مشخص شده در درخواست.

گزارش خرید

گزارشی حاوی جزئیات مربوط به خرید مرتبط با پرداخت درخواستی.

نمایندگی JSON
{
  "customerAccount": {
    object (CustomerAccount)
  },
  "order": {
    object (Order)
  },
  "payment": {
    object (Payment)
  }
}
زمینه های
customerAccount

object ( CustomerAccount )

مورد نیاز : اطلاعات مربوط به مشتری و حساب او.

order

object ( Order )

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

payment

object ( Payment )

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

حساب مشتری

اطلاعات مربوط به حساب مشتری

نمایندگی JSON
{
  "customerEmail": string,
  "customerName": string
}
زمینه های
customerEmail

string

اختیاری : آدرس ایمیل مرتبط با حساب Google مشتری.

customerName

string

الزامی : نام مشتری.

سفارش

اطلاعات در مورد سفارش.

نمایندگی JSON
{
  "timestamp": {
    object (Timestamp)
  },
  "orderId": string,
  "subTotalAmount": {
    object (Amount)
  },
  "totalAmount": {
    object (Amount)
  },
  "shippingAddress": {
    object (Address)
  },
  "items": [
    {
      object (Item)
    }
  ],
  "taxes": [
    {
      object (Tax)
    }
  ]
}
زمینه های
timestamp

object ( Timestamp )

مورد نیاز : مهر زمانی از زمان انجام سفارش.

orderId

string

مورد نیاز : رشته ای که به طور منحصر به فرد این ترتیب را مشخص می کند.

subTotalAmount

object ( Amount )

مورد نیاز : کل مبلغ این سفارش قبل از مالیات.

totalAmount

object ( Amount )

مورد نیاز : کل مبلغ این سفارش شامل مالیات.

shippingAddress

object ( Address )

اختیاری : آدرس حمل و نقل برای اقلام فیزیکی در این سفارش.

items[]

object ( Item )

مورد نیاز : فهرست مواردی که بخشی از این سفارش بودند.

taxes[]

object ( Tax )

الزامی : فهرست مالیات هایی که بخشی از این سفارش بودند. این لیست ممکن است خالی باشد.

میزان

مقداری در میکرو را با کد ارز مرتبط می کند.

نمایندگی JSON
{
  "amountMicros": string,
  "currencyCode": string
}
زمینه های
amountMicros

string ( Int64Value format)

مورد نیاز : مقدار در میکرو .

currencyCode

string

مورد نیاز : کد ارز 3 حرفی ISO 4217

نشانی

ساختاری که اطلاعات مربوط به یک آدرس فیزیکی را در خود دارد.

نمایندگی JSON
{
  "addressLine": [
    string
  ],
  "localityName": string,
  "administrativeAreaName": string,
  "postalCodeNumber": string,
  "countryCode": string
}
زمینه های
addressLine[]

string

اختیاری : این متن آدرس بدون ساختار را نگه می دارد.

localityName

string

اختیاری : این یک اصطلاح مبهم است، اما به طور کلی به بخش شهر/شهر یک آدرس اشاره دارد. در مناطقی از جهان که محلات به خوبی تعریف نشده اند یا به خوبی با این ساختار مطابقت ندارند (مثلاً ژاپن و چین)، localityName را خالی بگذارید و از addressLine استفاده کنید.

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

administrativeAreaName

string

اختیاری : زیرمجموعه اداری سطح بالای این کشور" مثال‌ها: ایالت ایالات متحده، منطقه فناوری اطلاعات، استان CN، استان JP."

postalCodeNumber

string

اختیاری : با وجود نام، مقادیر postalCodeNumber اغلب حروف عددی هستند. مثال‌ها: "94043"، "SW1W"، "SW1W 9TQ".

countryCode

string

اختیاری : کد کشور آدرس مشتری، انتظار می رود ISO-3166-1 Alpha-2 باشد.

مورد

اطلاعات در مورد یک مورد در سفارش.

نمایندگی JSON
{
  "description": string,
  "merchant": string,
  "quantity": string,
  "totalPrice": {
    object (Amount)
  },
  "googleProductName": string
}
زمینه های
description

string

مورد نیاز : شرح کالایی که خریداری شده است.

merchant

string

مورد نیاز : فروشنده، هنرمند یا سازنده کالا.

quantity

string ( Int64Value format)

اختیاری : مقداری که از این کالا سفارش داده شده است.

اگر مقادیر صحیح برای محصول قابل اعمال نباشد، این قسمت حذف می شود (مثلاً محصولات اندازه گیری شده ممکن است مقادیر کسری داشته باشند).

totalPrice

object ( Amount )

مورد نیاز : قیمت کل این کالا.

googleProductName

string

الزامی : نام سرویس محصول Google برای مورد.

مالیات

اطلاعاتی درباره مالیاتی که برای این سفارش اعمال می شود.

نمایندگی JSON
{
  "description": string,
  "amount": {
    object (Amount)
  }
}
زمینه های
description

string

مورد نیاز : شرح مالیات.

amount

object ( Amount )

مورد نیاز : مقدار مالیات.

پرداخت

اطلاعات در مورد پرداخت.

نمایندگی JSON
{
  "billingAddress": {
    object (Address)
  },
  "amount": {
    object (Amount)
  },
  "refunds": [
    {
      object (Refund)
    }
  ],

  // Union field fopDetails can be only one of the following:
  "cardDetails": {
    object (PaymentCardDetails)
  }
  // End of list of possible types for union field fopDetails.
}
زمینه های
billingAddress

object ( Address )

مورد نیاز : آدرس صورتحساب برای این پرداخت.

amount

object ( Amount )

مورد نیاز : مبلغ این پرداخت.

refunds[]

object ( Refund )

مورد نیاز : لیست بازپرداخت های انجام شده به این پرداخت. این لیست ممکن است خالی باشد.

فیلد اتحادیه fopDetails .

fopDetails فقط می تواند یکی از موارد زیر باشد:

cardDetails

object ( PaymentCardDetails )

اختیاری : جزئیات پرداخت ویژه کارت های اعتباری و کارت نقدی FoP.

بازپرداخت

اطلاعات مربوط به بازپرداخت انجام شده در پرداخت.

نمایندگی JSON
{
  "amount": {
    object (Amount)
  },
  "initiatedTimestamp": {
    object (Timestamp)
  }
}
زمینه های
amount

object ( Amount )

الزامی : مبلغ بازپرداخت شده.

initiatedTimestamp

object ( Timestamp )

الزامی : مهر زمانی از زمان شروع بازپرداخت.

جزئیات کارت پرداخت

جزئیات پرداخت ویژه کارت های اعتباری و نقدی.

نمایندگی JSON
{
  "authResult": enum (AuthResult)
}
زمینه های
authResult

enum ( AuthResult )

مورد نیاز : نتیجه اعتبار پرداخت.

AuthResult

نتایج احراز هویت پرداخت

Enums
UNKNOWN_RESULT هرگز این مقدار پیش فرض را تنظیم نکنید.
APPROVED تایید شده است.
DENIED احراز هویت رد شد.
NOT_ATTEMPTED احراز هویت انجام نشده است.

خالی

این نوع هیچ فیلدی ندارد.

این شی برای توسعه پذیری استفاده می شود زیرا بولی ها و شمارش ها اغلب باید با داده های اضافی گسترش داده شوند. پیاده کننده از آن برای تعیین حضور استفاده می کند. شمارشی که این نشان‌دهنده آن است، ممکن است بسط داده شود تا در نسخه‌های بعدی حاوی داده‌ها باشد.

نمایش JSON برای Empty یک شی JSON خالی است {} .

ErrorResponse

شیء پاسخ خطا برای همه متدها.

نمایندگی JSON
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "errorDescription": string,
  "paymentIntegratorErrorIdentifier": string,
  "errorResponseResult": {
    object (ErrorResponseResult)
  }
}
زمینه های
responseHeader

object ( ResponseHeader )

مورد نیاز : هدر مشترک برای همه پاسخ ها.

errorDescription

string

اختیاری : شرحی از این وضعیت برای تکرارهای پشتیبانی برای رفع اشکال ارائه دهید. توجه داشته باشید که این هرگز به کاربران نشان داده نمی شود. می تواند حاوی متن توصیفی و غیر حساسی باشد که برای اشکال زدایی استفاده می شود. توجه داشته باشید که برخی از مقادیر errorResponseCode باید با جزئیات بیشتری در این قسمت همراه شوند. هشدار: هیچ نشانه ای را در این پیام وارد نکنید مگر اینکه به عنوان عمومی تعریف شده باشد.

paymentIntegratorErrorIdentifier

string

اختیاری : این شناسه مخصوص یکپارچه ساز است و توسط یکپارچه ساز تولید می شود. فقط برای اهداف اشکال زدایی به منظور شناسایی این تماس استفاده می شود. این شناسه ای است که ادغام کننده این تماس را با آن می شناسد.

errorResponseResult

object ( ErrorResponseResult )

اختیاری : کدی که نوع خطای رخ داده را نشان می دهد.

ErrorResponseResult

کدهای خطا

نمایندگی JSON
{

  // Union field result can be only one of the following:
  "invalidApiVersion": {
    object (InvalidApiVersion)
  },
  "invalidPayloadSignature": {
    object (InvalidPayloadSignature)
  },
  "invalidPayloadEncryption": {
    object (InvalidPayloadEncryption)
  },
  "requestTimestampOutOfRange": {
    object (RequestTimestampOutOfRange)
  },
  "invalidIdentifier": {
    object (InvalidIdentifier)
  },
  "idempotencyViolation": {
    object (IdempotencyViolation)
  },
  "invalidFieldValue": {
    object (InvalidFieldValue)
  },
  "missingRequiredField": {
    object (MissingRequiredField)
  },
  "preconditionViolation": {
    object (PreconditionViolation)
  },
  "userActionInProgress": {
    object (UserActionInProgress)
  },
  "invalidDecryptedRequest": {
    object (InvalidDecryptedRequest)
  },
  "forbidden": {
    object (Forbidden)
  }
  // End of list of possible types for union field result.
}
زمینه های

result میدان اتحادیه

result می تواند تنها یکی از موارد زیر باشد:

invalidApiVersion

object ( InvalidApiVersion )

اگر نسخه API درخواست پشتیبانی نشود استفاده می شود. کد HTTP توصیه شده: 400

invalidPayloadSignature

object ( InvalidPayloadSignature )

اگر امضای محموله به یک کلید ناشناخته یا غیرفعال باشد استفاده می شود. کد HTTP توصیه شده: 401

invalidPayloadEncryption

object ( InvalidPayloadEncryption )

اگر رمزگذاری محموله به یک کلید ناشناخته یا غیرفعال باشد استفاده می شود. کد HTTP توصیه شده: 400

requestTimestampOutOfRange

object ( RequestTimestampOutOfRange )

اگر مهر درخواست زمانی ± 60 ثانیه نباشد استفاده می شود. کد HTTP توصیه شده: 400

invalidIdentifier

object ( InvalidIdentifier )

اگر شناسه ارسال شده در درخواست نامعتبر یا ناشناخته باشد استفاده می شود. این ممکن است شامل PIAID، captureRequestId، Google Payment Token، و غیره باشد. کد HTTP توصیه شده: 404

idempotencyViolation

object ( IdempotencyViolation )

در صورتی استفاده می شود که درخواست الزامات ناتوانی در درخواست را نقض کند. کد HTTP توصیه شده: 412

invalidFieldValue

object ( InvalidFieldValue )

اگر درخواست حاوی مقداری برای فیلدی باشد که در مجموعه مقادیر پشتیبانی شده نیست استفاده می شود. کد HTTP توصیه شده: 400

missingRequiredField

object ( MissingRequiredField )

اگر فیلد مورد نیاز در درخواست تنظیم نشده باشد استفاده می شود. کد HTTP توصیه شده: 400

preconditionViolation

object ( PreconditionViolation )

اگر محدودیتی در عملیات نقض شود (مثلاً زمانی که درخواست برای بازپرداخت بیش از مقدار باقی مانده در تراکنش باشد) استفاده می شود. کد HTTP توصیه شده: 400

userActionInProgress

object ( UserActionInProgress )

در صورتی استفاده می‌شود که درخواست در حال حاضر قابل پردازش نباشد، زیرا باعث وقفه در عملکرد کاربر در حین پردازش می‌شود که به طور موثر به عنوان قفل سیستم عمل می‌کند. این کد نباید برای نشان دادن خرابی های ناشی از خطاهای همزمان داخلی خاص پیاده سازی استفاده شود. کد HTTP توصیه شده: 423

invalidDecryptedRequest

object ( InvalidDecryptedRequest )

اگر بار درخواست قابل رمزگشایی باشد استفاده می شود، اما پیام به دست آمده قابل تجزیه نیست. کد HTTP توصیه شده: 400

forbidden

object ( Forbidden )

دسترسی به منبع درخواستی ممنوع است. کد Http توصیه شده: 403

InvalidApiVersion

نمایندگی JSON
{
  "requestVersion": {
    object (Version)
  },
  "expectedVersion": {
    object (Version)
  }
}
زمینه های
requestVersion

object ( Version )

مورد نیاز : نسخه نامعتبر است که در درخواست مشخص شده است.

expectedVersion

object ( Version )

مورد نیاز : نسخه مورد انتظار.

InvalidPayloadSignature

این نوع هیچ فیلدی ندارد.

این پیام در حال حاضر عمداً خالی است. فیلدهای جدید می تواند در آینده اضافه شود.

InvalidPayloadEncryption

این نوع هیچ فیلدی ندارد.

این پیام در حال حاضر عمداً خالی است. فیلدهای جدید می تواند در آینده اضافه شود.

RequestTimestampOutOfRange

نمایندگی JSON
{
  "requestTimestamp": {
    object (Timestamp)
  },
  "serverTimestampAtReceipt": {
    object (Timestamp)
  }
}
زمینه های
requestTimestamp

object ( Timestamp )

مورد نیاز : مهر زمانی ارائه شده در درخواست

serverTimestampAtReceipt

object ( Timestamp )

مورد نیاز : زمان سرور هنگام دریافت، برای مقایسه استفاده می شود

InvalidIdentifier

نمایندگی JSON
{
  "invalidIdentifierType": string
}
زمینه های
invalidIdentifierType

string

مورد نیاز : نوع شناسه ای که نامعتبر بود، به عنوان مثال PIAID، captureRequestId، و غیره.

نقض قوه قضاییه

این نوع هیچ فیلدی ندارد.

این پیام در حال حاضر عمداً خالی است. فیلدهای جدید می تواند در آینده اضافه شود.

InvalidFieldValue

نمایندگی JSON
{
  "invalidFieldName": string
}
زمینه های
invalidFieldName

string

الزامی : نام فیلدی که نامعتبر است.

MissingRequiredField

نمایندگی JSON
{
  "missingFieldNames": [
    string
  ]
}
زمینه های
missingFieldNames[]

string

الزامی : نام فیلدهای از دست رفته.

نقض پیش شرط

این نوع هیچ فیلدی ندارد.

این پیام در حال حاضر عمداً خالی است. فیلدهای جدید می تواند در آینده اضافه شود.

UserActionInProgress

این نوع هیچ فیلدی ندارد.

این پیام در حال حاضر عمداً خالی است. فیلدهای جدید می تواند در آینده اضافه شود.

InvalidDecryptedRequest

این نوع هیچ فیلدی ندارد.

این پیام در حال حاضر عمداً خالی است. فیلدهای جدید می تواند در آینده اضافه شود.

ممنوع

این نوع هیچ فیلدی ندارد.

این پیام در حال حاضر عمداً خالی است. فیلدهای جدید می تواند در آینده اضافه شود.