Skip Navigation
Log In Sign Up

Retrieve a Credit Limit

·

Retrieve detailed information about a specific credit limit by its unique identifier.

Request

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

Authentication

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

Path Parameters

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

Notes

  • This endpoint returns all details for a specific credit limit, including the associated entity information.
  • The credit limit must belong to your organization to be accessible.
  • The response includes real-time balance information, which reflects the current loan utilization against the credit limit.
  • The balance field represents the amount of credit still available to the entity.
  • The rate field indicates the default interest rate that will be applied to loans created against this credit limit.
  • Before creating a loan, check the available balance to ensure sufficient credit is available.

Example Request

curl -X GET https://tupel.com/api/limits/5rQ6s/ \
  -u <YOUR_ORG_ID>:<YOUR_API_KEY>

Response

A successful request returns a 200 OK status code and a complete Credit Limit 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 credit limit.
404 Not Found - The specified credit limit could not be found.

Example Error Response

{
  "detail": [
    {
      "type": "not_found",
      "loc": ["path", "uid"],
      "msg": "Credit limit with id 5rQ6s not found."
    }
  ]
}