Request a grant payout
post/grants
Requests the payout of the selected grant offer.
Endpoint destination URL
https://balanceplatform-api-test.adyen.com/btl/v3/grants
Click to copy
Header Parameters
Idempotency-Keystring
A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).
Request Parameters
counterpartyobject
An object containing the details of the receiving party of the grant. Setting either an accountHolderId
, balanceAccountId
, or both is required.
grantAccountIdstringRequired
The identifier of the grant account used for the grant.
grantOfferIdstringRequired
The identifier of the grant offer that has been selected and from which the grant details will be used.
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.