跳到主要内容

支付银行票据

此端点用于支付银行票据。支付必须在查询之后进行，使用查询返回的信息以确保流程正常运行，避免支付过程中出现失败。

银行票据

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

Request​

请求端点​

ENDPOINT
/account/ACCOUNT_KEY/payment/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
}
Request Body: 使用条形码支付银行票据
{
  "request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
  "barcode": "00190000090361557400500000024174396700000991000",
  "payment_amount": 1156.8
}

Body 参数​

字段类型描述
request_control_key *uuid4客户请求唯一标识键。
barcodestring条形码。
digitable_linestring数字行。
payment_amount *number待支付金额。
警告

若银行票据不允许部分支付，payment_amount 必须始终等于银行票据查询返回的 total_amount。对于允许部分支付的票据，客户可以任意选择 payment_amount，甚至可以超过票据面值（total_amount）。

Response​

成功响应​

STATUS
201
Response Body: 支付已执行
{
   "payment_key":"c4325104-d60b-44f3-aae4-49155564a2ea",
   "request_control_key":"b713b2f6-2f48-4d18-b0c9-7186e4edf189",
   "payer_name":"COOPERATIVA INDUSTRIAL MURILO",
   "payer_document_number":"00037025000160",
   "source_account_key":"6dc89d57-fac7-4643-b151-cd2ca0a7f68f",
   "transaction_key":"4e80070a-a0bb-4be2-8178-55fbd73a3704",
   "transaction_revert_key":null,
   "paid_amount":1050.1,
   "payment_date":"2024-04-03",
   "payment_type":"bank_slip",
   "bank_slip": {
        "bank_slip_key":"95080ffd-3ac5-48d7-b3fe-659e4aaba81a",
        "barcode":"00193967000009910000000003615574000000002417",
        "digitable_line":"00190000090361557400500000024174396700000991000",
        "payer_name":"COOPERATIVA TESTE",
        "payer_document_number":"00037025000160",
        "beneficiary_name":"TESTE EQUIPAMENTOS E SERVICOS LTDA",
        "beneficiary_trading_name":"TESTE EQUIPAMENTOS E SERVICOS LTDA",
        "beneficiary_document_number":"52069937000117",
        "beneficiary_bank_ispb":"00000000",
        "guarantor_name":null,
        "guarantor_document_number":null,
        "expiration_date":"2024-03-29",
        "max_payment_data": "2026-03-29",
        "partial_payment_indicator":"allowed",
        "registered_payment_amount":9029.0,
        "nominal_amount":9910.0,
        "total_amount":10129.1,
        "rebate_amount":0.0,
        "discount_amount":0.0,
        "fine_amount":0.0,
        "interest_amount":219.1
    },
   "collection_slip":null,
   "payment_status":"executed"
}
STATUS
202
Response Body: 支付待执行
{
   "payment_key":"c4325104-d60b-44f3-aae4-49155564a2ea",
   "request_control_key":"b713b2f6-2f48-4d18-b0c9-7186e4edf189",
   "payer_name":"COOPERATIVA INDUSTRIAL MURILO",
   "payer_document_number":"00037025000160",
   "source_account_key":"6dc89d57-fac7-4643-b151-cd2ca0a7f68f",
   "transaction_key":"4e80070a-a0bb-4be2-8178-55fbd73a3704",
   "transaction_revert_key":null,
   "paid_amount":1050.1,
   "payment_date":"2024-04-03",
   "payment_type":"bank_slip",
   "bank_slip": {
        "bank_slip_key":"95080ffd-3ac5-48d7-b3fe-659e4aaba81a",
        "barcode":"00193967000009910000000003615574000000002417",
        "digitable_line":"00190000090361557400500000024174396700000991000",
        "payer_name":"COOPERATIVA TESTE",
        "payer_document_number":"00037025000160",
        "beneficiary_name":"TESTE EQUIPAMENTOS E SERVICOS LTDA",
        "beneficiary_trading_name":"TESTE EQUIPAMENTOS E SERVICOS LTDA",
        "beneficiary_document_number":"52069937000117",
        "beneficiary_bank_ispb":"00000000",
        "guarantor_name":null,
        "guarantor_document_number":null,
        "expiration_date":"2024-03-29",
        "max_payment_data": "2026-03-29",
        "partial_payment_indicator":"allowed",
        "registered_payment_amount":9029.0,
        "nominal_amount":9910.0,
        "total_amount":10129.1,
        "rebate_amount":0.0,
        "discount_amount":0.0,
        "fine_amount":0.0,
        "interest_amount":219.1
    },
   "collection_slip":null,
   "payment_status": "pending_execution"
}
信息

若返回 HTTP Status 202 且 payment_status 字段值为 pending_execution，则不应重新尝试支付。

该支付将异步处理。需要通过支付查询核实转账状态，或等待 webhooks 页面 中描述的待执行支付 webhook。

Response Body 参数​

字段类型描述
payment_key *uuid4支付唯一标识键。
request_control_key *uuid4客户请求唯一标识键。
payer_name *string实际付款人姓名。
payer_document_number *string实际付款人文件号码（CPF/CNPJ）。
source_account_key *uuid4被扣款账户的键。
transaction_key *uuid4支付交易键。
transaction_revert_keyuuid4支付冲销交易键。
paid_amount *number实际支付金额。
payment_date *string支付日期。
payment_type *enum支付类型。
bank_slipobject银行票据。
collection_slipobject征税发票。
payment_status *enum支付状态。

payment_type 枚举值​

枚举值类型描述
bank_slipstring银行票据
collection_slipstring征税发票
警告

collection_slip 枚举值不适用于银行票据流程，collection_slip 对象也始终为空。

payment_status 枚举值​

枚举值描述
pending_execution待执行
executed已执行
reverted已冲销
rejected已拒绝
error错误
警告

对于 QI 在两分钟内未收到 CIP 响应的支付，支付将以 pending_execution 状态返回。QI 收到 CIP 响应后，将向客户发送 webhooks 页面 中描述的待执行支付 webhook。

bank_slip 对象​

字段类型描述
barcode *string条形码。
digitable_line *string数字行。
payer_name *string付款人姓名。
payer_document_number *string付款人文件号码（CPF/CNPJ）。
beneficiary_name *string受益人姓名。
beneficiary_trading_namestring受益人商业名称。
beneficiary_document_number *string受益人文件号码（CPF/CNPJ）。
beneficiary_bank_ispb *string受益人银行的 ispb 代码。
guarantor_namestring担保人姓名。
guarantor_document_numberstring担保人文件号码（CPF/CNPJ）。
expiration_date *string到期日期。
max_payment_date *string最大支付日期。
partial_payment_indicator *enum部分支付指示器。
registered_payment_amountstring注册的总支付金额。
nominal_amount *number原始金额。
total_amount *number总金额。
rebate_amount *number折扣金额。
discount_amount *number优惠金额。
fine_amount *number罚款金额。
interest_amount *number利息金额。

partial_payment_indicator 枚举值​

枚举值类型描述
allowedstring允许
not_allowedstring不允许

错误响应​

STATUS
4XX
Response Body
{
    "title": "Título",
    "description": "Description in english",
    "translation": "Descrição em português",
    "code": "Código"
}
HTTP 代码QI 代码标题描述（英文）描述（葡文）
400BIP000001Bad RequestThe 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.
400BIP000002Bad RequestThe bill sent does not correspond to a bank slip.A conta enviado não corresponde a um boleto bancário.
400BIP000003Bad RequestThe digitable line sent is invalid.A linha digitável enviada é inválida.
404BIP000004Not FoundThe bank slip was not found.O boleto não foi encontrado.
400BIP000005Bad RequestIt was not possible to consult the bank slip at this time. Please try again in a few minutes.Não foi possível consultar o boleto neste momento. Por favor, tente novamente em alguns minutos.
400BIP000006Bad RequestBank slip already written offBoleto já baixado
400BIP000007Bad RequestBank slip blocked for paymentBoleto bloqueado para pagamento
400BIP000008Bad RequestBank slip already paidBoleto já pago
400BIP000009Bad RequestInvalid bank slip. Please consult issuing bankBoleto inválido. Favor consultar banco emissor
403BIP000010ForbiddenUser is not allowed to do this actionUsuário não tem autorização para fazer essa ação
404BIP000011Not FoundThe source account key was not found.A chave da conta de origem não foi encontrada.
400BIP000012Bad RequestIt was not possible to consult the source account at this time. Please try again in a few minutes.Não foi possível consultar a conta de origem neste momento. Por favor, tente novamente em alguns minutos.
400BIP000013Bad RequestThe source account is closed.A conta de origem está fechada.
400BIP000014Bad RequestThe source account is blocked.A conta de origem está bloqueada.
400BIP000015Bad RequestPayment date is greater than the maximum payment date.A data de pagamento é maior que a data máxima de pagamento.
400BIP000016Bad RequestPayment date is smaller than the calculation date.A data de pagamento é menor que a data de cálculo.
400BIP000017Bad RequestInvalid payment amount.Valor de pagamento inválido.
400BIP000018Bad RequestPartial payment is not allowed.Pagamento parcial não é permitido.
400BIP000019Bad RequestThe payment amount is greater than the available amount.O valor do pagamento é maior que o valor disponível.
400BIP000020Bad RequestAll partial payments for this bank slip have already been made.Todos os pagamentos parciais deste boleto já foram realizados.
400BIP000022Bad RequestBank slip payment service is closed.Serviço de pagamento de boleto está fechado.
400BIP000023Bad RequestThe source account has insufficient balance. Payment cannot be made.A conta de origem possui saldo insuficiente. Pagamento não pode ser realizado.
400BIP000024Bad RequestRequest control key already exists.Chave de controle da requisição já existe.
400BIP000025Bad RequestIt was not possible to pay the bank slip at this time. Please verify your information and, if necessary, contact us for assistance.Não foi possível pagar o boleto neste momento. Por favor, verifique suas informações e, se necessário, entre em contato conosco para assistência.
400BIP000028Bad RequestThe source account has blocked balance. Payment cannot be made.A conta de origem possui saldo em conta bloqueado. Pagamento não pode ser realizado.

Sandbox 环境​

在我们的 sandbox 环境中，我们提供了模拟的数字行，用于模拟成功支付和测试错误场景。

成功场景​

数字行
00190000090361557400500000024174396700000991000
00190000090282802601919212747174596760001294161
23793390014000000455277000249001596900000103995
75691434020137513680900001040013196770002417240
21390001171200000570700168167484796770000148206
07790001161200000039300602819070498470000182970
23792372059034189564835003432701998420000008306
03399199530490000005254172701010698420000467696
03399135012340000000830681701014198420038743888
75691324620100735471370255730478698420064900819

pending_execution 场景​

此场景的模拟在模拟页面中有更详细的描述。

数字行
75691333790100505390300569460017397220000306867

错误场景​

数字行错误代码
34191090083273252027893634770007296690012513600BIP000007
07090010287045349010776686070590896770001160123BIP000007
42297048060005815702500130494123896770000239491BIP000006
74891123702849020818918378871083196690000050000BIP000009
23792374119000209350986000372408496610000122810BIP000008