Criar boleto

Siga nosso passo a passo para criar um boleto de cobrança.

Criar boleto

1 - Para iniciar você já precisa estar logado no Internet Banking

❗️

lembre-se de sempre enviar uid, access-token e client no cabeçalho da requisição

CHAVEVALORDESCRIÇÃO
uid[email protected]identificador unico
access-tokenZ_eOiMQwaRaGN14Iw8r0iQtoken de acesso
client892RXGrwWaEC96QoQp5Dcgtoken do cliente

endpoint: https://{{base_url}}/bills/bank_slips

verbo http POST

{{base_url}} será substituida pela URL da sua empresa, exemplo: https://cwdev.ib.hmg.cashway.io/api/v3

Corpo da requisição

{
  "bank_slips": {
    "due_on": "2022-12-09",                         // Data de vencimento
    "value": 33.33,                                 // Valor
    "fine_code": "2",                               // Código da Multa (1 - valor/ 2 - porcentagem)
    "fine": 1.0,                                    // Multa
    "interest_code": "1",                           // Código do Juros  (1 - valor/ 2 - porcentagem)
    "interest": 0.11,                               // Juros
    "periodicity_type": 2,                          // Tipo de Periodicidade (0 - Mensal/ 1 - Dinamico)
    "number_of_installments": 1,                    // Número de Parcelas
    "periodicity": "15",                            // Intervalo entre parcelas
    "note": "",                                     // Campo Livre
    "people_id": [24527],                           // Identificador do sacado
    "instructions": [],                             // Instruções livres
    "mail_owner": "1",                              // "1" dono do boleto recebe boleto por email. "0" não envia boleto para dono
    "mail_payer": "0",                              // "1" pagador do boleto recebe boleto via email. "0", não envia boleto para pagador
    "deposit": false                                // Depóstio por boleto (Deve ser falso)
  }
}

2 - Se tudo ocorrer bem, você receberá uma resposta com Status 200 OK

Corpo da resposta com sucesso:

{
    "id": 119562,
    "assignor_name": "CASHWAY TECNOLOGIA DA INFORMACAO LTDA",
    "assignor_document": "99999999999999",
    "assignor_address": "Rod. José Carlos Daux, nº 5500, 88032005, Florianópolis - SC",
    "payer_name": "CASHWAY",
    "payer_document": "99999999999999",
    "payer_address": "Rodovia José Carlos Daux, nº 5500, 88032005, Florianópolis - SC",
    "due_on": "09/12/2022",
    "value": "33.33",
    "status_description": "Aberto",
    "instructions_list": [],
    "bills_user_id": null,
    "digitable_line": null,
    "registered": false,
    "created_at": "17/08/2021",
    "our_number": 277,
    "interest_date": "2022-12-10",
    "fine_date": "2022-12-10",
    "rates": null,
    "payer_id": 24527,
    "assignor_id": 24377,
    "fine_code": "2",
    "fine": "1.0",
    "interest_code": "1",
    "interest": 0.11,
    "days_of_protest": null,
    "note": "",
    "barcode": null,
    "payer_email": "[email protected]",
    "payer_phone": "99999999",
    "assignor_email": null,
    "assignor_phone": null,
    "provider_our_number": null,
    "errors": []
}