申请银行票据支付预约（双因素身份验证）

此端点用于申请银行票据支付预约。请求应在查询之后进行，使用返回的信息以确保流程正确运行。

银行票据

这是常规银行票据（数字行不以数字8开头）。在银行间支付结算所（CIP/Núclea）注册，可在巴西中央银行授权的金融和支付机构付款。

Request

ENDPOINT

/account/ACCOUNT_KEY/payment_schedule/bank_slip

MÉ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",
  "tfa_info": {
    "approver_document_number": "98765432100",
    "contact_type": "email"
  }
}

Request Body: 使用条形码申请预约

{
  "request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
  "barcode": "00190000090361557400500000024174396700000991000",
  "payment_amount": 1156.8,
  "payment_date": "2024-03-30",
  "tfa_info": {
    "approver_document_number": "98765432100",
    "contact_type": "email"
  }
}

Body 参数

字段	类型	描述
`request_control_key` *	uuid4	客户请求的唯一标识键。
`barcode`	string	条形码。
`digitable_line`	string	数字行。
`payment_amount` *	number	待支付金额。
`payment_date` *	string	预约支付日期（格式 YYYY-MM-DD）。
`tfa_info` *	object	包含账户审批人文件和联系方式的对象。

tfa_info 对象

字段	类型	描述
`approver_document_number`*	string	账户审批人的文件号码（CPF/CNPJ）。
`contact_type`*	enumerator	身份验证令牌验证方式

枚举值	描述
sms	通过短信发送至手机
email	通过电子邮件发送

Response

成功响应

STATUS

201

Response Body 参数

字段	类型	描述
`payment_schedule_key` *	uuid4	预约唯一标识键。
`request_control_key` *	uuid4	客户请求唯一标识键。
`payer_name` *	string	实际付款人名称。
`payment_schedule_status` *	enum	预约状态。

payment_schedule_status 枚举值

枚举值	描述
`pending_2fa_approval`	预约待双因素身份验证（2FA）
`scheduled`	支付预约成功

错误响应

STATUS

4XX

Response Body

{
    "title": "Título",
    "description": "Description in english",
    "translation": "Descrição em português",
    "code": "Código"
}

HTTP 代码	QI 代码	标题	描述（英文）	描述（葡文）
400	BIP000001	Bad Request	The barcode or digitable line must have 44 or 47 characters.	O código de barras ou linha digitável deve ter 44 ou 47 caracteres.
400	BIP000002	Bad Request	The bill sent does not correspond to a bank slip.	A conta enviado não corresponde a um boleto bancário.
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.
403	BIP000052	Forbidden	Given document number does not belong to an approver for this account	Número de documento enviado não pertence a um aprovador da conta
400	BIP000054	Bad Request	TFA info required	Informações de TFA necessárias
400	BIP000055	Bad Request	Error sending verification token	Erro ao enviar token de verificação

Request​

请求路径参数​

Body 参数​

tfa_info 对象​

Response​

成功响应​

Response Body 参数​

payment_schedule_status 枚举值​

错误响应​