Package com.adyen.service.capital
Class GrantsApi
- java.lang.Object
-
- com.adyen.Service
-
- com.adyen.service.capital.GrantsApi
-
public class GrantsApi extends Service
-
-
Field Summary
Fields Modifier and Type Field Description static StringAPI_VERSIONprotected StringbaseURL
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DisbursementsgetAllGrantDisbursements(String grantId)Get all the disbursements of a grantDisbursementsgetAllGrantDisbursements(String grantId, RequestOptions requestOptions)Get all the disbursements of a grantGrantsgetAllGrants(String counterpartyAccountHolderId)Get all the grants of an account holderGrantsgetAllGrants(String counterpartyAccountHolderId, RequestOptions requestOptions)Get all the grants of an account holderGrantgetGrant(String grantId)Get the details of a grantGrantgetGrant(String grantId, RequestOptions requestOptions)Get the details of a grantDisbursementgetGrantDisbursement(String grantId, String disbursementId)Get disbursement detailsDisbursementgetGrantDisbursement(String grantId, String disbursementId, RequestOptions requestOptions)Get disbursement detailsGrantrequestGrant(GrantInfo grantInfo)Make a request for a grantGrantrequestGrant(GrantInfo grantInfo, RequestOptions requestOptions)Make a request for a grantDisbursementupdateGrantDisbursement(String grantId, String disbursementId, DisbursementInfoUpdate disbursementInfoUpdate)Update the repayment configuration of a disbursementDisbursementupdateGrantDisbursement(String grantId, String disbursementId, DisbursementInfoUpdate disbursementInfoUpdate, RequestOptions requestOptions)Update the repayment configuration of a disbursement-
Methods inherited from class com.adyen.Service
createBaseURL, getClient, isApiKeyRequired, setApiKeyRequired, setClient
-
-
-
-
Field Detail
-
API_VERSION
public static final String API_VERSION
- See Also:
- Constant Field Values
-
baseURL
protected String baseURL
-
-
Constructor Detail
-
GrantsApi
public GrantsApi(Client client)
Grants constructor inpackage.- Parameters:
client-Client(required)
-
-
Method Detail
-
getAllGrantDisbursements
public Disbursements getAllGrantDisbursements(String grantId) throws ApiException, IOException
Get all the disbursements of a grant- Parameters:
grantId-StringThe unique identifier of the grant reference. (required)- Returns:
Disbursements- Throws:
ApiException- if fails to make API callIOException
-
getAllGrantDisbursements
public Disbursements getAllGrantDisbursements(String grantId, RequestOptions requestOptions) throws ApiException, IOException
Get all the disbursements of a grant- Parameters:
grantId-StringThe unique identifier of the grant reference. (required)requestOptions-RequestOptionsObject to store additional HTTP headers such as idempotency-keys (optional)- Returns:
Disbursements- Throws:
ApiException- if fails to make API callIOException
-
getAllGrants
public Grants getAllGrants(String counterpartyAccountHolderId) throws ApiException, IOException
Get all the grants of an account holder- Parameters:
counterpartyAccountHolderId-StringQuery: The unique identifier of the account holder that received the grants. (required)- Returns:
Grants- Throws:
ApiException- if fails to make API callIOException
-
getAllGrants
public Grants getAllGrants(String counterpartyAccountHolderId, RequestOptions requestOptions) throws ApiException, IOException
Get all the grants of an account holder- Parameters:
counterpartyAccountHolderId-StringQuery: The unique identifier of the account holder that received the grants. (required)requestOptions-RequestOptionsObject to store additional HTTP headers such as idempotency-keys (optional)- Returns:
Grants- Throws:
ApiException- if fails to make API callIOException
-
getGrant
public Grant getGrant(String grantId) throws ApiException, IOException
Get the details of a grant- Parameters:
grantId-StringThe unique identifier of the grant reference. (required)- Returns:
Grant- Throws:
ApiException- if fails to make API callIOException
-
getGrant
public Grant getGrant(String grantId, RequestOptions requestOptions) throws ApiException, IOException
Get the details of a grant- Parameters:
grantId-StringThe unique identifier of the grant reference. (required)requestOptions-RequestOptionsObject to store additional HTTP headers such as idempotency-keys (optional)- Returns:
Grant- Throws:
ApiException- if fails to make API callIOException
-
getGrantDisbursement
public Disbursement getGrantDisbursement(String grantId, String disbursementId) throws ApiException, IOException
Get disbursement details- Parameters:
grantId-StringThe unique identifier of the grant reference. (required)disbursementId-StringThe unique identifier of the disbursement. (required)- Returns:
Disbursement- Throws:
ApiException- if fails to make API callIOException
-
getGrantDisbursement
public Disbursement getGrantDisbursement(String grantId, String disbursementId, RequestOptions requestOptions) throws ApiException, IOException
Get disbursement details- Parameters:
grantId-StringThe unique identifier of the grant reference. (required)disbursementId-StringThe unique identifier of the disbursement. (required)requestOptions-RequestOptionsObject to store additional HTTP headers such as idempotency-keys (optional)- Returns:
Disbursement- Throws:
ApiException- if fails to make API callIOException
-
requestGrant
public Grant requestGrant(GrantInfo grantInfo) throws ApiException, IOException
Make a request for a grant- Parameters:
grantInfo-GrantInfo(required)- Returns:
Grant- Throws:
ApiException- if fails to make API callIOException
-
requestGrant
public Grant requestGrant(GrantInfo grantInfo, RequestOptions requestOptions) throws ApiException, IOException
Make a request for a grant- Parameters:
grantInfo-GrantInfo(required)requestOptions-RequestOptionsObject to store additional HTTP headers such as idempotency-keys (optional)- Returns:
Grant- Throws:
ApiException- if fails to make API callIOException
-
updateGrantDisbursement
public Disbursement updateGrantDisbursement(String grantId, String disbursementId, DisbursementInfoUpdate disbursementInfoUpdate) throws ApiException, IOException
Update the repayment configuration of a disbursement- Parameters:
grantId-StringThe unique identifier of the grant reference. (required)disbursementId-StringThe unique identifier of the disbursement. (required)disbursementInfoUpdate-DisbursementInfoUpdate(required)- Returns:
Disbursement- Throws:
ApiException- if fails to make API callIOException
-
updateGrantDisbursement
public Disbursement updateGrantDisbursement(String grantId, String disbursementId, DisbursementInfoUpdate disbursementInfoUpdate, RequestOptions requestOptions) throws ApiException, IOException
Update the repayment configuration of a disbursement- Parameters:
grantId-StringThe unique identifier of the grant reference. (required)disbursementId-StringThe unique identifier of the disbursement. (required)disbursementInfoUpdate-DisbursementInfoUpdate(required)requestOptions-RequestOptionsObject to store additional HTTP headers such as idempotency-keys (optional)- Returns:
Disbursement- Throws:
ApiException- if fails to make API callIOException
-
-