Get the details of a grant offer

get/grantOffers/{id}

API Version

Returns the details of the specified grant offer.

Endpoint destination URL

Path Parameters

Required

Optional

The unique identifier of the grant offer.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

200 - OK
The request has succeeded.
accountHolderIdstring
The unique identifier of the account holder to which the grant is offered.
amountobject
The amount that would be paid out to the user for business financing.
currencystring
The three-character ISO currency code.
valueinteger
The amount of the transaction, in minor units.
contractType
The contract type of the grant offer. Possible values: cashAdvance, loan.
expiresAtstring
The date when the grant offer expires.
feeobject
Contains information about the fee that your user would pay for the grant.
amountobject
Contains the amount of the grant fee.
currencystring
The three-character ISO currency code.
valueinteger
The amount of the transaction, in minor units.
idstring
The unique identifier of the grant offer.
repaymentobject
Contains information about the repayment configuration of the grant.
basisPointsinteger
The percentage of your user's incoming net volume that is deducted for repaying the grant. The percentage expressed in basis points.
termobject
Contains information about the time period in which your user must repay the total amount of the grant.
estimatedDaysinteger
The estimated duration of the repayment term, in days.
maximumDaysinteger
The maximum duration of the repayment term, in days. Only applies when contractType is loan.
thresholdobject
Contains the minimum threshold amount that your user must repay every 30-day period.
amountobject
The minimum threshold amount that your user must repay on every 30-day period.
currencystring
The three-character ISO currency code.
valueinteger
The amount of the transaction, in minor units.
startsAtstring
The date when the grant offer becomes available.
404 - Not Found
The entity was not found.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
namestring
The field that has an invalid value.
valuestring
The invalid value.
messagestring
Description of the validation error.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.
422 - Unprocessable Entity
A request validation error.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
namestring
The field that has an invalid value.
valuestring
The invalid value.
messagestring
Description of the validation error.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.

Get the details of a grant offer

HTTP Responses

200 - OK

404 - Not Found

422 - Unprocessable Entity