Consultar 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

CHAVE	VALOR	DESCRIÇÃO
uid	[email protected]	identificador unico
access-token	Z_eOiMQwaRaGN14Iw8r0iQ	token de acesso
client	892RXGrwWaEC96QoQp5Dcg	token do cliente

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

verbo http GET

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

:id será substituido pelo ID do boleto que você deseja consultar

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

Corpo da resposta com sucesso:

{
    "id": 118647,
    "assignor_name": "CASHWAY TECNOLOGIA DA INFORMACAO LTDA",
    "assignor_document": "000000000000",
    "assignor_address": "ROD SC 401, nº 5500, 88032000, FLORIANOPOLIS - SC",
    "payer_name": "SACADO DE TESTE",
    "payer_document": "07615661986",
    "payer_address": "ROD. JOSE CARLOS DAUX, nº 5500, 88052003, FLORIANOPOLIS - SC",
    "due_on": "06/08/2021",
    "value": "6.0",
    "status_description": "Baixa solicitada",
    "instructions_list": [
        "",
        ""
    ],
    "bills_user_id": null,
    "digitable_line": "21390001171200006210400015730641187040000000600",
    "registered": true,
    "created_at": "03/08/2021",
    "our_number": 270,
    "interest_date": "2021-08-07",
    "fine_date": "2021-08-07",
    "rates": "0.0",
    "payer_id": 29296,
    "assignor_id": 26914,
    "fine_code": "1",
    "fine": "0.0",
    "interest_code": "1",
    "interest": 0,
    "days_of_protest": null,
    "note": "",
    "barcode": "21391870400000006000001112000062100001573064",
    "payer_email": "[email protected]",
    "bank_agreement_id": 11,
    "payer_phone": "00000000",
    "assignor_email": null,
    "assignor_phone": null,
    "provider_our_number": "00001573064",
    "errors": []
}

📘
caso deseje o boleto em pdf, basta passar na url do endpoint o seguinte parametro: format=pdf

Exemplo:

endpoint: https://{{base_url}}/bills/bank_slips/:id?format=pdf