跳转到主要内容
GET
cURL

授权

Authorization
string
header
必填

OAuth2 client_credentials 授权。access_token 到期后重新获取。

查询参数

merchant_id
string
必填

业务标识,由 BillBuddy 分配;必填,最长 20 字符,须属于 OAuth 凭据所属商户。

Maximum string length: 20
page
integer | null
默认值:1

页码,默认 1。

必填范围: x >= 1
page_size
integer | null
默认值:20

每页条数,默认 20,最大值未限定。

必填范围: x >= 1
name
string | null

模板名称模糊匹配。

Maximum string length: 255
frequency
enum<integer> | null

模板扣款频率:1 One-off、3 Weekly、4 Fortnightly、5 Monthly、6 Quarterly、7 Half Yearly、8 Yearly、12 Custom。

可用选项:
1,
3,
4,
5,
6,
7,
8,
12,
null
min_price

模板最新价格的下限。 金额以主货币单位计,例如 10.50 表示 AUD 10.50,最多两位小数。接受数值或数字字符串,最小 0,两种类型遵守相同范围限制。

必填范围: x >= 0必须是以下数值的倍数 0.01
max_price

模板最新价格的上限。 金额以主货币单位计,例如 10.50 表示 AUD 10.50,最多两位小数。接受数值或数字字符串,最小 0,两种类型遵守相同范围限制。

必填范围: x >= 0必须是以下数值的倍数 0.01
start_create
string<date> | null

创建日期起点,含当日 00:00:00。 必须使用 YYYY-MM-DD。

end_create
string<date> | null

创建日期终点,含当日 23:59:59。 必须使用 YYYY-MM-DD。

start_update
string<date> | null

更新日期起点,含当日 00:00:00。 必须使用 YYYY-MM-DD。

end_update
string<date> | null

更新日期终点,含当日 23:59:59。 必须使用 YYYY-MM-DD。

响应

HTTP 200。成功、业务失败、参数校验失败或业务鉴权失败以响应体 code 区分。

成功响应。

code
enum<integer>
必填

0 表示模板列表查询成功。

可用选项:
0
message
string
必填

响应说明。

data
object
必填

分页结构;注意模板数组位于 data.data。