Capital

Get grant reference details

Returns the details of a capital account specified in the path.

get/grants/{id}

Path parameters

idstring required

The unique identifier of the grant.

Response

OK - the request has succeeded.

grantAccountIdstring required

The identifier of the grant account used for the grant.

grantOfferIdstring required

The identifier of the grant offer that has been selected and from which the grant details will be used.

idstring required

The identifier of the grant reference.

The current status of the grant. Possible values: Pending, Active, Repaid, WrittenOff, Failed, Revoked.

Changes

Changed in 10 of the 51 revisions of this API.62112

Jul 6, 2026v3514d1ed036e12See the full diff
- ○
  api tag Capital added
  api-tag-added
- ○
  api tag Capital (deprecated) removed
  api-tag-removed
Jun 1, 2026v32188d062ff1b62See 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
- ○
  api tag Capital (deprecated) added
  api-tag-added
- ○
  api tag Capital removed
  api-tag-removed
Mar 4, 2025v3bc888fe170cf3See the full diff
- ●
  added the new Failed enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new Revoked enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new WrittenOff enum value to the response property for the response status
  response-property-enum-value-added
Mar 4, 2025v36f904aa6b8033See the full diff
- ○
  removed the Failed enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the Revoked enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the WrittenOff enum value from the response property for the response status
  response-property-enum-value-removed
Mar 4, 2025v3bc888fe170cf3See the full diff
- ●
  added the new Failed enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new Revoked enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new WrittenOff enum value to the response property for the response status
  response-property-enum-value-added
Mar 4, 2025v36f904aa6b8033See the full diff
- ○
  removed the Failed enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the Revoked enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the WrittenOff enum value from the response property for the response status
  response-property-enum-value-removed
Mar 4, 2025v3bc888fe170cf3See the full diff
- ●
  added the new Failed enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new Revoked enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new WrittenOff enum value to the response property for the response status
  response-property-enum-value-added
Dec 20, 2023v3ec02d539f7541See the full diff
- ○
  the endpoint scheme security clientKey was added to the API
  api-security-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Oct 27, 2023v3073f244a026312See 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
- ●
  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 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 20, 2023v3e9eb8c599a571See the full diff
- ○
  endpoint added
  endpoint-added

Full history