列出支付
此端点用于提供客户所有已支付账单的详细信息，包括银行票据和征税发票。
银行票据
这是常规银行票据（数字行不以数字8开头）。在银行间支付结算所（CIP/Núclea）注册，可在巴西中央银行授权的金融和支付机构付款。
征税发票
此类账单由服务特许经营商（水、电、电话和燃气账单）和政府机构（税务）开具。它们未在银行间支付结算所（CIP/Núclea）登记，因此返回的信息与银行票据不同。
Request
请求端点
ENDPOINT
/account/ACCOUNT_KEY/paymentsMÉTODO
GET请求路径参数
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
account_key * | uuid4 | 账户唯一标识键。 | 36 |
查询字符串参数
| 字段 | 类型 | 描述 |
|---|---|---|
request_control_key | uuid4 | 客户请求唯一标识键。 |
payment_key | uuid4 | 支付唯一标识键。 |
payment_schedule_key | uuid4 | 支付预约唯一标识键。 |
payment_type | enum | 支付类型。 |
payment_status | enum | 支付状态。 |
date_from | string | 开始日期，格式 "YYYY-MM-DD"。 |
date_to | string | 结束日期，格式 "YYYY-MM-DD"。 |
page | string | 请求的页码，默认为 1。 |
page_size | string | 查询中每页大小，默认最大值为 30。 |
payment_type 枚举值
| 枚举值 | 类型 | 描述 |
|---|---|---|
bank_slip | string | 银行票据 |
collection_slip | string | 征税发票 |
payment_status 枚举值
| 枚举值 | 描述 |
|---|---|
pending_execution | 待执行 |
executed | 已执行 |
reverted | 已冲销 |
rejected | 已拒绝 |
error | 错误 |
Response
成功响应
STATUS
200错误响应
STATUS
4XXResponse Body
{
"title": "Título",
"description": "Description in english",
"translation": "Descrição em português",
"code": "Código"
}
| HTTP 代码 | QI 代码 | 标题 | 描述（英文） | 描述（葡文） |
|---|---|---|---|---|
| 403 | BIP000010 | Forbidden | User is not allowed to do this action | Usuário não tem autorização para fazer essa ação |
| 404 | BIP000011 | Not Found | The source account key was not found. | A chave da conta de origem não foi encontrada. |