払い戻しの更新

特定の払い戻しプロパティを更新します。Stripe は、このリクエストから省略されたパラメータをすべて保持します。これにより、払い戻しに関する追加情報を保存することができます。

POST https://api.stripe.com/v1/refunds/{id}

例

cURL の例：

cURL

curl -X POST https://api.stripe.com/v1/refunds/{id} \
  -u <YOUR_SECRET_KEY>: \
  -d "metadata[order_id]=6735"

レスポンス

レスポンスには標準コードが返されます。

200: OK

Response

{
  "id": "re_1Nispe2eZvKYlo2Cd31jOCgZ",
  "object": "refund",
  "amount": 1000,
  "balance_transaction": "txn_1Nispe2eZvKYlo2CYezqFhEx",
  "charge": "ch_1NirD82eZvKYlo2CIvbtLWuY",
  "created": 1692942318,
  "currency": "usd",
  "destination_details": {
    "card": {
      "reference": "123456789012",
      "reference_status": "available",
      "reference_type": "acquirer_reference_number",
      "type": "refund"
    },
    "type": "card"
  },
  "metadata": {
    "order_id": "6735"
  },
  "payment_intent": "pi_1GszsK2eZvKYlo2CfhZyoZLp",
  "reason": null,
  "receipt_number": null,
  "source_transfer_reversal": null,
  "status": "succeeded",
  "transfer_reversal": null
}

エラー応答

400: Bad Request

Response

{
  "error": {
    "code": "parameter_invalid_integer",
    "doc_url": "https://stripe.com/docs/error-codes/parameter-invalid-integer",
    "message": "Invalid integer: <integer>",
    "param": "amount",
    "request_log_url": "https://dashboard.stripe.com/test/logs/req_UQf6XBwBl9yk66?t=1734829676",
    "type": "invalid_request_error"
  }
}

401: Unauthorized

Response

{
  "error": {
    "type": "invalid_request_error",
    "message": "Invalid API Key provided: sk_test_********************1234"
  }
}

パラメータ

ボディパラメータ

パラメータ	タイプ	説明
metadata	オブジェクト	オブジェクトに添付できるキーと値のペアの集合です。これは、オブジェクトに関する追加情報を構造化された形式で保存するのに役立ちます。
expand[]	文字列の配列	ネストされたレスポンスオブジェクトを特定し、情報を追加してインラインで返します。

パス変数

名前	タイプ	必須	説明
id	文字列	必須	更新対象の払い戻しの ID。