Update the repayment configuration of a disbursement

patch/grants/{grantId}/disbursements/{disbursementId}

API Version

Update the percentage of your user's net income that is deducted for repaying the grant.

Endpoint destination URL

Path Parameters

Required

Optional

The unique identifier of the disbursement.

The unique identifier of the grant reference.

Request Parameters

Required

Optional

Contains information about the basis points configured for repaying the disbursement.

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 that received the disbursement.
amountobject
Contains information about the amount of the disbursement.
currencystring
The three-character ISO currency code.
valueinteger
The amount of the transaction, in minor units.
balanceAccountIdstring
The unique identifier of the balance account that received the disbursement.
balancesobject
Contains information about the balances of the disbursement.
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.
feeobject
Contains information about the fee that your user must pay for the disbursement.
amountobject
Contains the amount of the grant fee.
currencystring
The three-character ISO currency code.
valueinteger
The amount of the transaction, in minor units.
fundsCollectionsarray[object]
Contains information about the accounts that Adyen uses to collect funds related to repayments.
accountIdentificationobject
Contains the identification information of the account to which you can transfer funds related to repayments.
typestring
The type of account, which depends on the country of the account and the currency of the transfer.
fundsCollectionTypestring
The type of funds collection.

Possible values: UnscheduledRepayment, Revocation.
grantIdstring
The unique identifier of the grant related to the disbursement.
idstring
The unique identifier of the disbursement.
repaymentobject
Contains information about the basis points configured for repaying the disbursement.
basisPointsinteger
Maximum: 10000
The percentage of your user's incoming net volume that is deducted for repaying the grant. The percentage expressed in basis points.
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.

Update the repayment configuration of a disbursement

HTTP Responses

200 - OK

404 - Not Found

422 - Unprocessable Entity