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

Request parameters

counterparty object

An object containing the details of the receiving party of the grant. Setting either an accountHolderId, balanceAccountId, or both is required.

grantAccountId string Required

The identifier of the grant account used for the grant.

grantOfferId string Required

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 more Show less
  • 400 - Bad Request

    A problem reading or understanding the request.

    Show more Show less
  • 401 - Unauthorized

    Authentication required.

    Show more Show less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show more Show less
  • 404 - Not Found

    The payment was not found

    Show more Show less
  • 422 - Unprocessable Entity

    A request validation error.

    Show more Show less
  • 500 - Internal Server Error

    The server could not process the request.

    Show more Show less
  • Request
  • Click to copy
  • Response
  • Click to copy