Get all the grants of an account holder
Returns a list of all the grants of a specific account holder.
The unique identifier of the account holder that received the grants.
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.
grantsarray[object]Contains a list of the grants that the account holder has received.
amountobjectContains information about the amount of the grant. This is the sum of the amounts of all the disbursements related to the grant.
currencystringThe three-character ISO currency code.
valueintegerThe amount of the transaction, in minor units.
balancesobjectContains information about the balances of the grant.
currencystringThe three-character ISO currency code.
feeintegerThe amount of the grant fee.
principalintegerThe grant amount that is paid out to the user for business financing.
totalintegerThe total amount of the grant that the user must repay. It is the sum of the fee amount and the principal amount.
counterpartyobjectContains the details of the party that receives the grant. Setting either an
accountHolderId
,balanceAccountId
, or both is required.accountHolderIdstringThe unique identifier of the account holder that receives the grant. If no
balanceAccountId
is provided, the grant funds are disbursed to the primary balance account of this account holder.balanceAccountIdstringThe unique identifier of the balance account where the funds are disbursed. The balance account must belong to the specified account holder.
transferInstrumentIdstringThe unique identifier of the transfer instrument where the funds are disbursed. The transfer instrument must belong to the legal entity of the specified account holder.
feeobjectContains information about the fee that your user must pay for the grant. This is the sum of the fees of all the disbursements related to the grant.
amountobjectContains the amount of the grant fee.
currencystringThe three-character ISO currency code.
valueintegerThe amount of the transaction, in minor units.
grantAccountIdstringThe unique identifier of the grant account that tracks this grant.
grantOfferIdstringThe unique identifier of the selected grant offer. Adyen uses the details of the selected grant offer to create a grant.
idstringThe unique identifier of the grant reference.
repaymentobjectContains information about the repayment configuration of the grant. By default, this repayment configuration applies to all the disbursements related to the grant.
basisPointsintegerThe percentage of your user's incoming net volume that is deducted for repaying the grant. The percentage expressed in basis points.
termobjectContains information about the time period in which your user must repay the total amount of the grant.
estimatedDaysintegerThe estimated duration of the repayment term, in days.
maximumDaysintegerThe maximum duration of the repayment term, in days. Only applies when
contractType
is loan.thresholdobjectContains the minimum threshold amount that your user must repay every 30-day period.
amountobjectThe minimum threshold amount that your user must repay on every 30-day period.
currencystringThe three-character ISO currency code.
valueintegerThe amount of the transaction, in minor units.
statusobjectContains the status of the grant.
codeThe code for the status of the grant. Possible values:
- Pending
- Active
- Repaid
- WrittenOff
- Failed
- Revoked
404 - Not Found
The entity was not found.
detailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringUnique business error code.
instancestringA URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]Array of fields with validation errors when applicable.
namestringThe field that has an invalid value.
valuestringThe invalid value.
messagestringDescription of the validation error.
requestIdstringThe unique reference for the request.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA URI that identifies the validation error type. It points to human-readable documentation for the problem type.
422 - Unprocessable Entity
A request validation error.
detailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringUnique business error code.
instancestringA URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]Array of fields with validation errors when applicable.
namestringThe field that has an invalid value.
valuestringThe invalid value.
messagestringDescription of the validation error.
requestIdstringThe unique reference for the request.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA URI that identifies the validation error type. It points to human-readable documentation for the problem type.