Solicitação de pagamento de Boleto Bancário com Autenticação de Dois Fatores
Este endpoint permite realizar a solicitação de pagamento de boletos bancários. A solicitação deve ser realizado após a consulta, utilizando as informações retornadas para garantir o funcionamento correto do fluxo, evitando falhas durante o processo.
É o boleto bancário convencional (linhas digitáveis não iniciadas com dígito 8). Possui registro na Câmara Interbancária de Pagamento (CIP/Núclea) e pode ser pago em instituições financeiras e de pagamento autorizadas a funcionar pelo Banco Central.
Request
Request Endpoint
Request Path Params
Campo | Tipo | Descrição | Caracteres |
---|---|---|---|
account_key * | uuid4 | Chave única de identificação da conta. | 36 |
Request Body: Solicitação de boleto bancário com linha digitável
{
"request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
"digitable_line": "00190000090361557400500000024174396700000991000",
"payment_amount": 1156.8,
"tfa_info": {
"approver_document_number": "98765432100",
"contact_type": "email"
}
}
Request Body: Solicitação de boleto bancário com código de barras
{
"request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
"barcode": "00190000090361557400500000024174396700000991000",
"payment_amount": 1156.8,
"tfa_info": {
"approver_document_number": "98765432100",
"contact_type": "email"
}
}
Body Params
Campo | Tipo | Descrição |
---|---|---|
request_control_key * | uuid4 | Chave única de identificação da request do cliente. |
barcode | string | Código de barras. |
digitable_line | string | Linha digitável. |
payment_amount * | number | Valor a ser pago. |
tfa_info * | object | Objeto contendo o documento da pessoa aprovadora da conta e a forma de contato. |
O payment_amount
deve sempre igual ao total_amount
retornado na consulta do boleto bancário caso o pagamento parcial não seja permitido para o boleto bancário. Para títulos em que o pagamento parcial é permitido, o cliente pode escolher o payment_amount
, desde que a soma do mesmo com o registered_payment_amount
do boleto bancário não seja superior que o total_amount
.
Objeto tfa_info
Campo | Tipo | Descrição |
---|---|---|
approver_document_number * | string | Número de documento da pessoa aprovadora da conta. |
contact_type * | enumerator | Forma de envio do token de autenticação |
Enumerador | Descrição |
---|---|
sms | Envio por Mensagem de Texto para telefone celular |
Envio por correio eletrônico |
Response
Success Response
Response Body: Pagamento pendente de aprovação de dois fatores
{
"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_2fa_approval"
}