Get grant details

After you successfully create a grant, you can get the details of these grants by making API requests. These details include, for example, the grant balances, repayment configuration, and status.

You can use this information for use cases such as:

• Showing your user the details of their grants.
• Tracking whether your users are repaying their grants.

Get all grants of an account holder

You can get the details of all the grants given to a specific account holder. To do so:

1. Make a GET /grants request and specify the following query parameter in the path:

   Query parameter	Description
   counterpartyAccountHolderId	The unique identifier of the counterparty account holder.

2. In the response, note the grants array, which includes an object for each grant associated to the account holder. Each object includes the following parameters:

   Parameter	Description
   id	The identifier of the grant reference.
   grantAccountId	The identifier of the grant account used to account for the grant.
   grantOfferId	The identifier of the grant offer that has been selected by the receiving account holder.
   counterparty	An object containing the details of the receiving account holder.
   amount	An object containing the amount of the grant, in minor units.
   fee	An object containing the fee amount.
   repayment	An object containing the repayment amount, in basis points.
   balances	An object containing the details of the existing grant.
   status	The status of the grant.

Get details of a specific grant

To get the balance of a specific grant:

1. Make a GET /grants/{grantId} request and specify the following parameter in the path:

   Path parameter	Description
   grantId	The unique identifier of the grant reference received when requesting a grant.

2. In the response, note the following parameters:

   Parameter	Description
   id	The identifier of the grant reference.
   grantAccountId	The identifier of the grant account used to account for the grant.
   grantOfferId	The identifier of the grant offer that has been selected by the receiving account holder.
   counterparty	An object containing the details of the receiving account holder.
   amount	An object containing the amount of the grant, in minor units.
   fee	An object containing the fee amount.
   repayment	An object containing the repayment amount, in basis points.
   balances	An object containing the details of the existing grant.
   status	The status of the grant.

Get details of your grant account

The balances of all grants in your balance platform are tracked by your grant account.

To get the details of your grant account:

1. Make a GET /grantAccounts/{id} request and specify the following parameter in the path:

   Path parameter	Description
   id	The unique identifier of the grant account received from your Adyen contact.

2. In the response, note the following parameters:

   Parameter	Description
   id	The unique identifier of the grant account.
   balances	An object containing the details of all the existing grant(s) on your platform's grant account.
   limits	An object containing the details about the maximum allowed total amount for all grants on this grant account.