API Boleto Fácil
API destinada a criação de cobranças boleto Fácil na plataforma Blu.
A funcionalidade listada abaixo deve ser acessada através dos seguintes endereços:
Homologação: https://api-hlg.blu.com.br/b2b
Produção: https://api.blu.com.br/b2b
#ATENÇÃO! O envio de boletos devem ser realizados todos para o mesmo banco, seguindo os moldes da geração de boletos através do web services do seu respectivo banco.
Enviar Boleto Fácil
POST
/payment-collections/bank-billets
Realiza o envio de boletos para o portal da Blu.
Headers
Authorization*
String
Bearer Token
Request Body
bank_code*
String
identificação do banco (deve conter 3 dígitos)
cedant*
String
Nome do beneficiário/cobrador
emission
String
Data de emissão do arquivo (obrigatório para Caixa Econômica Federal - DDMMAAAA sendo 'D' = dia / M = mês / A = ano)
wallet*
String
Carteira utilizada (deve conter 2 dígitos ou menos)
agency*
String
Número da agência sem dígito verificador (deve conter 4 dígitos ou menos)
agency_checker_digit
String
Dígito verificador da agência (obrigatório para o Banco Safra)
current_account*
String
Número da conta corrente sem dígito verificador (deve conter 7 dígitos ou menos)
account_checker_digit
String
Dígito verificador da conta corrente (obrigatório para o Banco Safra)
agreement*
Number
Convênio, número do convênio/contrato do cliente junto ao banco emissor
cedant_document*
String
Documento do beneficiário/cobrador (CPF ou CNPJ)
accept*
String
Aceite, informa se o banco deve aceitar o boleto após o vencimento.
document_date*
String
Data do pedido, Nota fiscal ou documento que originou o boleto (DDMMAAAA sendo 'D' = dia / M = mês / A = ano)
due_date*
String
Data de vencimento do boleto (DDMMAAAA)
coin_type*
Number
Tipo de moeda utilizada (Real(R$) igual a 9)
document_kind*
String
Tipo do documento
payment_location
String
Informação sobre onde o sacado poderá efetuar o pagamento
coin_symbol
String
Símbolo da moeda utilizada (R$ no Brasil)
quantity
Number
Quantidade de boleto (padrão igual a 1)
charged_name*
String
Nome do sacado/cobrado
charged_cpf_cnpj*
String
Documento do sacado/cobrado (CPF ou CNPJ)
value*
String
Valor do boleto
our_number*
String
Nosso número (deve conter 11 dígitos ou menos)
our_number_dv
String
Dígito verificador do nosso número (obrigatório para o Banco Santander)
office
String
Posto, código do posto da cooperativa de crédito (obrigatório para a Cooperativa Sicredi)
byte_idt
String
Byte de identificação do cedente/cobrador do boleto utilizado para compor o nosso número (obrigatório para a Cooperativa Sicredi)
barcode
String
Código de barras do boleto
document_number
String
Identificação do pedido, Nota Fiscal ou documento que originou o boleto
interest_kind
String
Tipo de juros ('1' = Valor por Dia / '2' = Taxa Mensal / '3' = Isento)
interest
String
Juros
ticket_kind
String
Tipo de multa ('1' = Valor Fixo / '2' = Percentual)
ticket
String
Multa
abatement_value
String
Valor do abatimento
anticipation_discount
String
Desconto por antecipação
discount_kind1
String
Código do desconto 1 ('0' = Sem desconto / '1', '3', '4' = Valor / '2', '5', '6' = Percentual / '7' = Cancelamento de Desconto)
discount_date1
String
Data do desconto 1 (DDMMAAAA sendo 'D' = dia / M = mês / A = ano)
discount1
String
Desconto 1
discount_kind2
String
Código do desconto 2 (mesma regra do Código do desconto 1)
discount_date2
String
Data do desconto 2 (DDMMAAAA)
discount2
String
Desconto 2
discount_kind3
String
Código do desconto 3 (vide Código do desconto 1)
discount_date3
String
Data do desconto 3 (DDMMAAAA)
discount3
String
Desconto 3
digitable_line
String
Linha digitável
Exemplos de chamada
Last updated
Was this helpful?