预约征税发票支付(协议/税务)
此端点用于预约征税发票支付。预约应在查询征税发票后进行,使用返回的信息以确保流程正确运行。
征税发票
此类账单由服务特许经营商(水、电、电话和燃气账单)和政府机构(税务)开具。它们未在银行间支付结算所(CIP/Núclea)登记,因此返回的信息与银行票据不同。
Request
ENDPOINT
/account/ACCOUNT_KEY/payment_schedule/collection_slipMÉTODO
POST请求路径参数
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
account_key * | uuid4 | 账户唯一标识键。 | 36 |
Request Body: 使用数字行预约征税发票支付
{
"request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
"digitable_line": "00190000090361557400500000024174396700000991000",
"payment_amount": 1156.8,
"payment_date": "2024-03-30"
}
Request Body: 使用条形码预约征税发票支付
{
"request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
"barcode": "00190000090361557400500000024174396700000991000",
"payment_amount": 1156.8,
"payment_date": "2024-03-30"
}
Body 参数
| 字段 | 类型 | 描述 |
|---|---|---|
request_control_key * | uuid4 | 客户请求唯一标识键。 |
barcode | string | 条形码。 |
digitable_line | string | 数字行。 |
payment_amount * | number | 待支付金额。 |
payment_date * | string | 预约日期(格式 YYYY-MM-DD)。 |
Response
成功响应
STATUS
201错误响应
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. |
| 400 | BIP000013 | Bad Request | The source account is closed. | A conta de origem está fechada. |
| 400 | BIP000014 | Bad Request | The source account is blocked. | A conta de origem está bloqueada. |
| 400 | BIP000024 | Bad Request | Request control key already exists. | Chave de controle da requisição já existe. |