跳到主要内容

搜索 Payment Intent

您可以使用 Stripe 的搜索查询语言搜索已有的 Payment Intent。

需要即时数据一致性的读写后立即读取流程,请避免使用搜索查询。正常运行时,数据在一分钟内即可被搜索到。服务中断时,新增或变更的数据最多延迟一小时。

备注

印度的商家无法使用搜索功能。

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>:"

参数​

查询参数​

参数类型必需说明
limit整数可选限制响应中的记录数。输入 1 到 100 的整数,默认值为 10。
page字符串可选分页游标。首次调用时省略。传入先前响应中的 next_page 值以获取下一页。
query字符串必需搜索查询字符串。参见搜索查询语言以及 Payment Intent 支持的查询字段列表。

响应​

成功时 Stripe 返回 200,参数校验失败时返回 400,API 密钥无效时返回 401。完整列表见 Stripe 的错误代码。

200: OK

Response
{
"object": "search_result",
"data": [
{
"id": "pi_3Rsx4dDtWMrPDtgt0mUrePJ9",
"object": "payment_intent",
"amount": 1000,
"currency": "usd",
"status": "requires_payment_method"
}
],
"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"
}
}