Buscar dados de um pagamento

Buscar informações sobre um pagemento

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/billet_payments/payment_info?document_number=document_number_for_search

verbo http GET

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

document_number_for_search deve ser substituido pelo numero do boleto a ser pequisado, exemplo: 03399543492037956804908973701017484540000017750

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

Corpo da resposta com sucesso:

{
    "id": null,
    "user_id": null,
    "type": "BilletPayment",
    "status": null,
    "cancel_reason": null,
    "reverse_reason": null,
    "auth_code": null,
    "date": "29/11/2020",
    "value": "177.5",
    "agency": null,
    "account": null,
    "ticket_code": null,
    "updated_at": null,
    "created_at": null,
    "scheduled_at": null,
    "ticketed_at": null,
    "canceled_at": null,
    "late_at": null,
    "done_at": null,
    "reversed_at": null,
    "ticket_auth_code": null,
    "ticket_cancel_reason": null,
    "errors": {},
    "display_amount": "177.5",
    "financial_institution_id": null,
    "created_by": "",
    "cancelable_by_user?": false,
    "user": null,
    "liquidation_disponibility_id": null,
    "late_reason": null,
    "pix_favored": null,
    "document_number": "03399543492037956804908973701017484540000017750",
    "discount": "0.0",
    "rebate": null,
    "interest": "0.0",
    "other_value": null,
    "total": "177.5",
    "bank_name": "BANCO SANTANDER (BRASIL) S.A.",
    "assignor": "BENEFICIARIO AMBIENTE HOMOLOGACAO",
    "assignor_document": "21.568.259/0001-00"
}

📘
Execute um teste em nosso sandbox EDITAR LINK