Listar todos pagamentos de boleto

Siga nosso passo a passo para listar todos os pagamentos de boletos.

Listar todos os pagamentos de boletos

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/billet_payments

verbo http GET

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

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

Corpo da resposta com sucesso:

[
{
        "id": "6822",
        "user_id": 7,
        "type": "BilletPayment",
        "status": "canceled",
        "cancel_reason": "devolvendo para teste",
        "reverse_reason": null,
        "auth_code": "2017-05-23 02:47:42 -0300",
        "date": "2017-05-23",
        "value": "724.39",
        "agency": "10400",
        "account": "36773",
        "ticket_code": null,
        "updated_at": "2017-11-21T20:23:26.229-02:00",
        "created_at": "2017-05-23T02:47:42.307-03:00",
        "scheduled_at": "2017-05-23T02:47:42.361-03:00",
        "ticketed_at": "2017-05-23T02:49:01.304-03:00",
        "canceled_at": "2017-05-23T02:58:48.691-03:00",
        "late_at": null,
        "done_at": null,
        "reversed_at": null,
        "ticket_auth_code": null,
        "ticket_cancel_reason": "devolvendo para teste",
        "errors": [],
        "display_amount": "1.39",
        "financial_institution_id": null,
        "created_by": "BRUNO IMHOF",
        "cancelable_by_user?": false,
        "user": {
            "name": "BRUNO IMHOF",
            "account": "36773",
            "document": "06615022958",
            "holder": 1,
            "phone": "48 999015907",
            "uid": "[email protected]",
            "payment_max_value": "5000.0",
            "info_email": "[email protected]",
            "set_password?": false,
            "set_short_password?": false
        },
        "liquidation_disponibility_id": null,
        "late_reason": null,
        "pix_favored": null,
        "document_number": "03399160741970000027626568401025780920000072439",
        "discount": "723.0",
        "rebate": "0.0",
        "interest": "0.0",
        "other_value": "0.0",
        "total": "1.39",
        "bank_name": "BANCO SANTANDER (BRASIL) S.A.",
        "assignor": null,
        "assignor_document": null
    },
    {
        "id": "6825",
        "user_id": 7,
        "type": "BilletPayment",
        "status": "canceled",
        "cancel_reason": "teste de cancelamento biti",
        "reverse_reason": null,
        "auth_code": "2017-05-23 03:18:18 -0300",
        "date": "2017-05-23",
        "value": "70.0",
        "agency": "10400",
        "account": "36773",
        "ticket_code": null,
        "updated_at": "2017-11-21T20:23:26.251-02:00",
        "created_at": "2017-05-23T03:18:18.540-03:00",
        "scheduled_at": "2017-05-23T03:18:18.572-03:00",
        "ticketed_at": "2017-05-23T03:19:02.192-03:00",
        "canceled_at": "2017-05-23T03:24:56.928-03:00",
        "late_at": null,
        "done_at": null,
        "reversed_at": null,
        "ticket_auth_code": null,
        "ticket_cancel_reason": "teste de cancelamento biti",
        "errors": [],
        "display_amount": "70.0",
        "financial_institution_id": null,
        "created_by": "BRUNO IMHOF",
        "cancelable_by_user?": false,
        "user": {
            "name": "BRUNO IMHOF",
            "account": "36773",
            "document": "06615022958",
            "holder": 1,
            "phone": "48 999015907",
            "uid": "[email protected]",
            "payment_max_value": "5000.0",
            "info_email": "[email protected]",
            "set_password?": false,
            "set_short_password?": false
        },
        "liquidation_disponibility_id": null,
        "late_reason": null,
        "pix_favored": null,
        "document_number": "75691303260101792483620196400012180990000007000",
        "discount": "0.0",
        "rebate": "0.0",
        "interest": "0.0",
        "other_value": "0.0",
        "total": "70.0",
        "bank_name": "BANCO COOPERATIVO DO BRASIL S.A. - BANCOOB",
        "assignor": null,
        "assignor_document": null
    }
]

📘

Execute um teste em nosso sandbox EDITAR LINK