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.

HTTP Responses

  • 200 - OK

    The request has succeeded.

    Show moreShow less
  • 400 - Bad Request

    A problem reading or understanding the request.

    Show moreShow less
  • 401 - Unauthorized

    Authentication required.

    Show moreShow less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show moreShow less
  • 404 - Not Found

    The payment was not found

    Show moreShow less
  • 422 - Unprocessable Entity

    A request validation error.

    Show moreShow less
  • 500 - Internal Server Error

    The server could not process the request.

    Show moreShow less