Get the information of your grant account

get/grantAccounts/{id}

API Version

Returns the details of the specified grant account. This account tracks existing grants in your marketplace or platform.

Endpoint destination URL

Path Parameters

Required

Optional

The unique identifier of the grant account.

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.
balancesarray[object]
Contains the sum of the balances of all grants tracked by this grant account. The balances are separated by currency.
currencystring
The three-character ISO currency code.
feeinteger
The amount of the grant fee.
principalinteger
The grant amount that is paid out to the user for business financing.
totalinteger
The total amount of the grant that the user must repay. It is the sum of the fee amount and the principal amount.
fundingBalanceAccountIdstring
The unique identifier of the balance account used to fund the grant.
idstring
The unique identifier of the grant account.
limitsarray[object]
Contains the maximum amount of funds that you can disburse for grants.
amountobject
The limit amount of the grant account.
currencystring
The three-character ISO currency code.
valueinteger
The amount of the transaction, in minor units.
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 information of your grant account

HTTP Responses

200 - OK

404 - Not Found

422 - Unprocessable Entity