メインコンテンツまでスキップ

払い戻しの作成

キャプチャされた請求に対して払い戻しを行います。払い戻し金額を独自に指定することも、省略して残高全額を返金することも可能です。Stripe は元の通貨で払い戻しを行い、顧客の当初の支払い方法に直接返金します。

請求額の当初の残高を超える返金はできません。 すでに決済済みの請求に対して返金を試みたり、当初の合計額を超えて返金を試みたりすると、Stripe からエラーが返されます。

POST https://api.stripe.com/v1/refunds

例​

cURL の例：

cURL
curl -X POST https://api.stripe.com/v1/refunds \
  -u <YOUR_SECRET_KEY>: \
  -d "charge=ch_1NirD82eZvKYlo2CIvbtLWuY"

レスポンス​

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

200: OK

Response
{
  "id": "re_1Nispe2eZvKYlo2Cd31jOCgZ",
  "object": "refund",
  "amount": 212,
  "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": {},
  "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"
  }
}

パラメータ​

ボディパラメータ​
パラメータタイプ説明
amount整数払い戻し金額（セント単位）。指定しない場合、Stripeは請求額全額を払い戻します。
charge文字列（必須） 払い戻し対象となる請求のID。
currency文字列3文字のISO通貨コード（小文字）。サポートされている通貨である必要があります。省略された場合、Stripeは元の請求の通貨を採用します。
expand[]文字列の配列ネストされたレスポンスオブジェクトを特定し、情報を追加してインラインで返します。
customer文字列請求の対象となる顧客の ID。
reason文字列払い戻しの理由。設定する場合、可能な値は duplicate、fraudulent、または requested_by_customer です。fraudulent に設定すると、Stripe は関連するカードとメールアドレスをブロックリストに追加します。これにより、不正利用の検知精度が向上します。
payment_intent文字列払い戻し対象の PaymentIntent の ID。
refund_application_feeブール値Stripe がプラットフォーム手数料をアカウントに返金するかどうかを決定します。全額返金の場合、Stripe は手数料全額を返金します。一部返金の場合、Stripe は再計算を行い、比例配分された金額を返金します。プラットフォーム手数料は、その請求を作成したプラットフォームにのみ適用されます。
origin文字列払い戻しの元となる取引。
reverse_transferブール値Stripe が接続された口座から送金された資金を回収するかどうかを指定します。Stripe は、払い戻し額（全額または一部払い戻し）に応じて、接続された送金を取り消します。
instructions_email文字列顧客の決済手段にネイティブな払い戻し機能が備わっていない場合、このメールアドレスに手動での払い戻し手順が送信されます。