すべての払い戻しを一覧表示する

既存の払い戻しのリストを返します。Stripe では、払い戻しは新しい順に表示され、最新のエントリが最初に表示されます。レスポンスには、デフォルトで最新の 10 件の払い戻しが含まれます。

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

例

cURL の例：

cURL

curl -X GET https://api.stripe.com/v1/refunds \
  -u <YOUR_SECRET_KEY>:

レスポンス

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

200: OK

Response

{
  "object": "list",
  "url": "/v1/refunds",
  "has_more": false,
  "data": [
    {
      "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": "resource_missing",
        "doc_url": "https://stripe.com/docs/error-codes/resource-missing",
        "message": "No such charge: 'ch_1NirD82eZvKYlo2CIvbtLWuY'",
        "param": "charge",
        "request_log_url": "https://dashboard.stripe.com/test/logs/req_HIH2jWkJGecwCk?t=1754504399",
        "type": "invalid_request_error"
    }
}

401: Unauthorized

Response

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

パラメータ

クエリパラメータ

パラメータ	タイプ	説明
charge	文字列	払い戻しの対象となる請求のID。省略された場合、Stripeはアカウントのすべての払い戻しを返します。
created	辞書	指定された日付範囲内に作成された払い戻しのみを返します。これは、以下のキーを持つ辞書として指定できます：gt、gte、lt、lte。
ending_before	文字列	ページネーションで使用するカーソルです。オブジェクト ID ending_before を使用して、リスト内の位置を指定します。リストの取得リクエストを行い、obj_bar から始まる 100 件の結果を受け取った場合、次の呼び出しで ending_before=obj_bar を指定することで、リストの前のページを取得できます。
limit	整数	レスポンスに含まれるレコード数を制限します。1 から 100 までの整数を入力してください（デフォルト：10）。
payment_intent	文字列	払い戻し情報を取得する PaymentIntent の ID。省略された場合、Stripe はアカウントのすべての払い戻し情報を返します。
starting_after	文字列	ページネーションで使用するカーソルです。オブジェクト ID starting_after を使用して、リスト内の位置を指定します。 リストの取得リクエストを行い、obj_foo で終わる 100 件の結果を受け取った場合、次の呼び出しで starting_after=obj_foo を指定することで、リストの次のページを取得できます。
expand[]	文字列の配列	ネストされたレスポンスオブジェクトを特定し、情報を追加してインラインで返します。