Skip Navigation
Log In Sign Up

Retrieve a Loan

·

Retrieve detailed information about a specific loan by its unique identifier.

Request

GET https://tupel.com/api/loans/{uid}/

Authentication

This endpoint requires basic authentication with your Organization ID and API Key.

Path Parameters

  • uid string Required
    The unique identifier of the loan to retrieve.

Notes

  • This endpoint returns all related data for a loan, including the entity, recipient, payment method, payments, invoices, and attachments.
  • The payments array will include all past payments made against this loan (both credits and debits).
  • The installments array shows the remaining installment schedule.
  • The loan status indicates the current state of the loan (PENDING, OPEN, CLOSED, or OVERDUE).

Example Request

curl -X GET https://tupel.com/api/loans/X1LpaA/ \
  -u <YOUR_ORG_ID>:<YOUR_API_KEY>

Response

A successful request returns a 200 OK status code and a complete Loan in the response body.

Error Responses

Code Description
401 Unauthorized - Authentication failed. Check your Organization ID and API Key.
403 Forbidden - Insufficient permissions to access the specified loan.
404 Not Found - The specified loan could not be found.

Example Error Response

{
  "detail": [
    {
      "type": "not_found",
      "loc": ["path", "uid"],
      "msg": "Loan with id X1LpaA not found."
    }
  ]
}