搜索支付意图
使用 Stripe 的搜索查询语言,您可以搜索之前创建的支付意向。
请避免在需要即时数据一致性的“写后读”管道中执行搜索查询。在正常运行情况下,数据可在不到一分钟内被检索到。但在系统故障期间,新数据或更新数据的传播可能会延迟长达一小时。
备注
印度地区的商户无法使用搜索功能。
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 | 字符串 | (必填) 搜索查询字符串。请参阅搜索查询语言以及支付意图支持的查询字段列表。 |