Make a request for a grant

post/grants

API Version

Make a request for a grant on behalf of an account holder.

Endpoint destination URL

Request Parameters

Required

Optional

Contains information about the amount of the grant. This is the sum of the amounts of all the disbursements related to the grant.

Contains the details of the party that receives the grant. Setting either an accountHolderId, balanceAccountId, or both is required.

Contains 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.

The unique identifier of the grant account that tracks this grant.

The unique identifier of the selected grant offer. Adyen uses the details of the selected grant offer to create a grant.

Contains information about the repayment configuration of the grant. By default, this repayment configuration applies to all the disbursements related to the grant.

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.
amountobject
Contains information about the amount of the grant. This is the sum of the amounts of all the disbursements related to the grant.
currencystring
The three-character ISO currency code.
valueinteger
The amount of the transaction, in minor units.
balancesobject
Contains information about the balances of the grant.
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.
counterpartyobject
Contains the details of the party that receives the grant. Setting either an accountHolderId, balanceAccountId, or both is required.
accountHolderIdstring
The 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.
balanceAccountIdstring
The unique identifier of the balance account where the funds are disbursed. The balance account must belong to the specified account holder.
transferInstrumentIdstring
The 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.
feeobject
Contains 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.
amountobject
Contains the amount of the grant fee.
currencystring
The three-character ISO currency code.
valueinteger
The amount of the transaction, in minor units.
grantAccountIdstring
The unique identifier of the grant account that tracks this grant.
grantOfferIdstring
The unique identifier of the selected grant offer. Adyen uses the details of the selected grant offer to create a grant.
idstring
The unique identifier of the grant reference.
repaymentobject
Contains information about the repayment configuration of the grant. By default, this repayment configuration applies to all the disbursements related to 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.
statusobject
Contains the status of the grant.
code
The code for the status of the grant. Possible values:

Pending

Active

Repaid

WrittenOff

Failed

Revoked
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.

Make a request for a grant

HTTP Responses

200 - OK

422 - Unprocessable Entity