Method: externaltransactions.refundexternaltransaction

既存の外部取引の払い戻し、または一部払い戻しを行います。

HTTP リクエスト

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

この URL では gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
name

string

必須。払い戻しを行う外部取引の名前。形式: applications/{packageName}/externalTransactions/{externalTransaction}

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "refundTime": string,

  // Union field refund_type can be only one of the following:
  "partialRefund": {
    object (PartialRefund)
  },
  "fullRefund": {
    object (FullRefund)
  }
  // End of list of possible types for union field refund_type.
}
フィールド
refundTime

string (Timestamp format)

必須。取引の払い戻しが行われた時間。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
共用体フィールド refund_type。必須。外部取引の払い戻しのタイプ。refund_type は次のいずれかになります。
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

必須。この一部払い戻しを区別する一意の ID。払い戻しが成功した場合、同じ ID による後続の払い戻しは失敗します。1 つの個別の取引に対して、払い戻し全体で一意でなければなりません。
refundPreTaxAmount

object (Price)

必須。一部払い戻しの課税前の金額。取引の課税前の残額より少ない額である必要があります。

FullRefund

この型にはフィールドがありません。

取引の残額分の全額払い戻し。