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

ペイメントインテントの検索

Stripeの検索クエリ言語（Search Query Language）を使用すると、以前に作成されたペイメントインテントを検索できます。

「書き込み後読み取り」パイプラインにおいて、即時のデータ一貫性を必要とする検索クエリは避けてください。通常稼働時には、データは1分未満の間検索可能です。ただし、サービス停止時には、新規または更新されたデータの反映に最大1時間の遅れが生じる場合があります。

注記

インドの加盟店では、検索機能をご利用いただけません。

GET https://api.stripe.com/v1/payment_intents/search

例​

cURL の例：

cURL
curl -X GET "https://api.stripe.com/v1/payment_intents/search?query=amount:1000" \
  -u <YOUR_SECRET_KEY>:

レスポンス​

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

200: OK

Response
{
  "object": "search_result",
  "data": [],
  "has_more": false,
  "url": "/v1/payment_intents/search"
}

エラー応答​

400: Bad Request

Response
{
  "error": {
    "code": "parameter_invalid_string",
    "doc_url": "https://stripe.com/docs/error-codes/parameter-invalid-string",
    "message": "Provide a query parameter with a valid search query string.",
    "param": "query",
    "type": "invalid_request_error"
  }
}

401: Unauthorized

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

パラメータ​

クエリパラメータ​
パラメータタイプ説明
expand[]文字列の配列ネストされたレスポンスオブジェクトを特定し、情報を追加してインラインで返します。
limit整数レスポンスに含まれるレコード数を制限します。1 から 100 までの整数を入力してください（デフォルト：10）。
page文字列検索結果の複数ページにわたるページネーション用のカーソルです。最初の呼び出しでは、このパラメータを含めないでください。その後の検索結果をリクエストするには、前回のレスポンスで返された next_page の値を使用してください。
query文字列（必須） 検索クエリ文字列。検索クエリ言語およびペイメントインテントでサポートされているクエリフィールドの一覧を参照してください。