GRgreendot
Users

Get Credit Line Range – Retrieves the eligible credit line range for an account based on income and expense information.

Retrieves the eligible credit line range for the specified account based on provided income and expense information. Returns the calculated range or an error if the input is invalid.

get/programs/{programCode}/accounts/{accountIdentifier}/creditLinesRange

Request

  • The document declares no server URL.
  • Auth
    API key in header Authorization

Path parameters

programCodestring required

The program code associated with the request.

accountIdentifierstring required

The unique identifier of the account for which to retrieve the credit line range. Must be a valid GUID.

Query parameters

incomenumber double

The user's monthly income amount. Optional; must be non-negative if provided.

incomeFrequencystring

The frequency of the income (e.g., "monthly", "weekly"). Optional.

expensenumber double

The user's monthly expense amount. Optional; must be non-negative if provided.

expenseFrequencystring

The frequency of the expense (e.g., "monthly", "weekly"). Optional.

Headers

X-GD-RequestIdstring required

The unique request identifier for idempotency and tracking. Must be provided in the X-GD-RequestId header.

Response

OK

minCreditLineinteger nullable

The minimum eligible credit line amount for the account.

maxCreditLineinteger nullable

The maximum eligible credit line amount for the account.

incomenumber double nullable

The user's monthly income amount used in the credit line calculation.

incomeFrequencystring nullable

The frequency of the income (e.g., "monthly", "weekly") used in the calculation.

expensenumber double nullable

The user's monthly expense amount used in the credit line calculation.

expenseFrequencystring nullable

The frequency of the expense (e.g., "monthly", "weekly") used in the calculation.

Changes

No recorded changes to this operation across all 2 revisions of this API.