Method: externaltransactions.refundexternaltransaction

تراکنش خارجی موجود را به‌طور کامل یا جزئی مسترد می‌کند.

درخواست HTTP

POST https://androidpublisher.googleapis.com/androidpublisher/v3/{name=applications/*/externalTransactions/*}:refund

این نشانی وب از نحو تراتبدیل gRPC استفاده می‌کند.

پارامترهای مسیر

پارامترها
name

string

الزامی. نام تراکنش خارجی که بازپرداخت خواهد شد. قالب: applications/{packageName}/externalTransactions/{externalTransaction}

متن درخواست

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

نمایش JSON
{
  "refundTime": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "partialRefund": {
    object (PartialRefund)
  },
  "fullRefund": {
    object (FullRefund)
  }
  // End of mutually exclusive fields.
}
فیلدها
refundTime

string (Timestamp format)

الزامی. زمانی که تراکنش مسترد شده است.

از RFC 3339 استفاده می‌کند، که در آن برونداد تولیدشده همیشه Z-نرمال‌سازی می‌شود و از ۰، ۳، ۶، یا ۹ رقم اعشاری استفاده می‌کند. انحراف‌های غیراز «Z» نیز پذیرفته می‌شود. مثال‌ها: "2014-10-02T15:01:23Z"، "2014-10-02T15:01:23.045123456Z"، یا "2014-10-02T15:01:23+05:30".

الزامی. نوع استرداد تراکنش خارجی. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
partialRefund

object (PartialRefund)

استرداد ناتمام.

fullRefund

object (FullRefund)

استرداد مبلغ کامل.

پایان فیلدهای متقابلاً انحصاری.

بدنه پاسخ

اگر موفقیت‌آمیز باشد، بدنه پاسخ حاوی نمونه‌ای از ExternalTransaction است.

نمونه

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

curl \
  -X POST \
  'https://androidpublisher.googleapis.com/androidpublisher/v3/applications/com.example.app/externalTransactions/foo:refund' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \
  -H 'Content-Type: application/json' \
  -d '{ \
    "partialRefund": { \
      "refundId": "my_refund_id", \
      "refundPreTaxAmount": { \
        "currency": "USD", \
        "priceMicros": "10120000" \
      } \
    }, \
    "refundTime": "2023-10-20T16:43:32.852Z" \
  }'

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

{
  "externalTransactionId": "1234567890123456789012345678901234567890123456789012345678901234",
  "originalPreTaxAmount": {
    "currency": "USD",
    "priceMicros": "1990000"
  },
  "originalTaxAmount": {
    "currency": "USD",
    "priceMicros": "11400000"
  },
  "packageName": "com.example.app",
  "transactionState": "TRANSACTION_CANCELED",
  "transactionTime": "2023-04-01T12:00:00Z",
  "userTaxAddress": {
    "regionCode": "US"
  },
  "createTime": "2023-04-01T11:55:00Z",
  "currentPreTaxAmount": {
    "currency": "USD",
    "priceMicros": "0"
  },
  "currentTaxAmount": {
    "currency": "USD",
    "priceMicros": "0"
  },
  "testPurchase": {},
  "recurringTransaction": {
    "initialExternalTransactionId": "9876543210987654321098765432109876543210987654321098765432109876",
    "externalSubscription": {
      "subscriptionType": "RECURRING"
    }
  }
}

دامنه‌های مجوز

به گستره OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/androidpublisher

PartialRefund

استرداد ناتمام تراکنش.

نمایش JSON
{
  "refundId": string,
  "refundPreTaxAmount": {
    object (Price)
  }
}
فیلدها
refundId

string

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

refundPreTaxAmount

object (Price)

الزامی. مبلغ استرداد ناتمام قبل‌از کسر مالیات. باید کمتر از مبلغ پیش‌از مالیات باقی‌مانده تراکنش باشد.

FullRefund

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

استرداد کامل مبلغ باقی‌مانده تراکنش.