API Reference

Listar empréstimos

get
https://api-bnpl-wl.sandbox.open-co.tech/person//loans

Retorna todos os empréstimos (aplicações com status FUNDED) de uma pessoa, incluindo planos de pagamento aninhados e detalhes das parcelas.

Um Empréstimo é uma aplicação que atingiu o status FUNDED, significando que o desembolso foi bem-sucedido e o comerciante pode confirmar o pedido.

Cada empréstimo inclui:

  • Resumo do empréstimo (valor, status, datas)
  • Plano de pagamento com todas as parcelas e seus status atuais
  • Referência do pedido para reconciliação com o sistema do comerciante
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

Identificador da pessoa (UUID)

Query Params
string
enum

Filtrar por status do empréstimo

Show Details
FUNDEDEmpréstimo ativo — desembolso concluído com sucesso
COMPLETEDTodas as parcelas foram pagas integralmente
DEFAULTEDEmpréstimo em inadimplência por delinquência grave
CANCELLEDEmpréstimo cancelado (estorno total processado)
REFUNDEDEmpréstimo estornado (parcial ou total)
Allowed:
integer
≥ 1
Defaults to 1

Número da página (baseado em 1)

integer
1 to 100
Defaults to 20

Número de itens por página

Responses

Updated 3 months ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago