查询预约

此端点用于查询银行票据或征税发票支付预约的信息。

银行票据

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

征税发票

此类账单由服务特许经营商（水、电、电话和燃气账单）和政府机构（税务）开具。它们未在银行间支付结算所（CIP/Núclea）登记，因此返回的信息与银行票据不同。

Request

ENDPOINT

/account/ACCOUNT_KEY/payment_schedule/PAYMENT_SCHEDULE_KEY

MÉTODO

GET

请求路径参数

字段	类型	描述	字符数
account_key *	uuid4	账户唯一标识键。	36
payment_schedule_key *	uuid4	预约唯一标识键。	36

Response

成功响应

STATUS

200

Response Body 参数

字段	类型	描述
payment_key *	uuid4	支付唯一标识键。
request_control_key *	uuid4	客户请求唯一标识键。
payer_name *	string	实际付款人名称。
payer_document_number *	string	实际付款人文件号码（CPF/CNPJ）。
source_account_key *	uuid4	被扣款账户密钥。
paid_amount *	number	实际支付金额。
payment_date *	string	预约日期。
payment_type *	enum	支付类型。
bank_slip	object	银行票据。
collection_slip	object	征税发票。
payment_schedule_status *	enum	预约状态。

payment_type 枚举值

枚举值	类型	描述
bank_slip	string	银行票据
collection_slip	string	征税发票

payment_schedule_status 枚举值

枚举值	描述
pending_2fa_approval	预约待双因素身份验证（2FA）
scheduled	支付预约成功
executed	预约已成功执行并生成相应支付
rejected	预约被拒绝，未生成任何支付
canceled	预约已取消
error	预约执行错误

错误响应

STATUS

4XX

Response 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.
404	BIP000056	Not Found	Payment not found.	Pagamento não encontrado.