Get a grant offer

Returns the details of a single grant offer.

get/grantOffers/{grantOfferId}

Path parameters

grantOfferIdstring required

The unique identifier of the grant offer.

Response

OK - the request has succeeded.

accountHolderIdstring required

The identifier of the account holder to which the grant is offered.

contractType'cashAdvance' | 'loan'

The contract type of the grant offer. Possible value: cashAdvance, loan.

expiresAtstring date-time

The end date of the grant offer validity period.

idstring

The unique identifier of the grant offer.

startsAtstring date-time

The starting date of the grant offer validity period.

Changes

Changed in 4 of the 51 revisions of this API.8102

Sep 9, 2025v2dd6159049c956See the full diff
- ▲
  the / response property's maxLength was unset from 3 for the response status
  response-property-max-length-unset
- ▲
  the // response property's maxLength was unset from 3 for the response status
  response-property-max-length-unset
- ▲
  the /// response property's maxLength was unset from 3 for the response status
  response-property-max-length-unset
- ▲
  the / response property's minLength was decreased from 3 to 0 for the response status
  response-property-min-length-decreased
- ▲
  the // response property's minLength was decreased from 3 to 0 for the response status
  response-property-min-length-decreased
- ▲
  the /// response property's minLength was decreased from 3 to 0 for the response status
  response-property-min-length-decreased
Feb 14, 2025v27ab1c2b70cc41See the full diff
- ○
  endpoint deprecated
  endpoint-deprecated
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jan 16, 2024v224691235e72121See the full diff
- ▲
  the response's property type changed from object to string, and format from no format to date-time for status
  response-property-type-changed
- ▲
  the response's property type changed from object to string, and format from no format to date-time for status
  response-property-type-changed
- ○
  the endpoint scheme security clientKey was added to the API
  api-security-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Nov 14, 2023v212a0c6036e6b10See the full diff
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history