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 String	API_VERSION
protected String	baseURL

Constructor Summary

Constructors

Constructor	Description
GrantsApi(Client client)	Grants constructor in package.
GrantsApi(Client client, String baseURL)	Grants constructor in package.

Method Summary

Modifier and Type	Method	Description
Disbursements	getAllGrantDisbursements(String grantId)	Get all the disbursements of a grant
Disbursements	getAllGrantDisbursements(String grantId, RequestOptions requestOptions)	Get all the disbursements of a grant
Grants	getAllGrants(String counterpartyAccountHolderId)	Get all the grants of an account holder
Grants	getAllGrants(String counterpartyAccountHolderId, RequestOptions requestOptions)	Get all the grants of an account holder
Grant	getGrant(String grantId)	Get the details of a grant
Grant	getGrant(String grantId, RequestOptions requestOptions)	Get the details of a grant
Disbursement	getGrantDisbursement(String grantId, String disbursementId)	Get disbursement details
Disbursement	getGrantDisbursement(String grantId, String disbursementId, RequestOptions requestOptions)	Get disbursement details
Grant	requestGrant(GrantInfo grantInfo)	Make a request for a grant
Grant	requestGrant(GrantInfo grantInfo, RequestOptions requestOptions)	Make a request for a grant
Disbursement	updateGrantDisbursement(String grantId, String disbursementId, DisbursementInfoUpdate disbursementInfoUpdate)	Update the repayment configuration of a disbursement
Disbursement	updateGrantDisbursement(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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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 in package.

Parameters:

client - Client (required)

GrantsApi

public GrantsApi(Client client,
                 String baseURL)

Grants constructor in package. Please use this constructor only if you would like to pass along your own url for routing or testing purposes. The latest API version is defined in this class as a constant.

Parameters:

client - Client (required)

baseURL - String (required)

Method Detail

getAllGrantDisbursements

public Disbursements getAllGrantDisbursements(String grantId)
                                       throws ApiException,
                                              IOException

Get all the disbursements of a grant

Parameters:

grantId - String The unique identifier of the grant reference. (required)

Returns:

Disbursements

Throws:

ApiException - if fails to make API call

IOException

getAllGrantDisbursements

public Disbursements getAllGrantDisbursements(String grantId,
                                              RequestOptions requestOptions)
                                       throws ApiException,
                                              IOException

Get all the disbursements of a grant

Parameters:

grantId - String The unique identifier of the grant reference. (required)

requestOptions - RequestOptions Object to store additional HTTP headers such as idempotency-keys (optional)

Returns:

Disbursements

Throws:

ApiException - if fails to make API call

IOException

getAllGrants

public Grants getAllGrants(String counterpartyAccountHolderId)
                    throws ApiException,
                           IOException

Get all the grants of an account holder

Parameters:

counterpartyAccountHolderId - String Query: The unique identifier of the account holder that received the grants. (required)

Returns:

Grants

Throws:

ApiException - if fails to make API call

IOException

getAllGrants

public Grants getAllGrants(String counterpartyAccountHolderId,
                           RequestOptions requestOptions)
                    throws ApiException,
                           IOException

Get all the grants of an account holder

Parameters:

counterpartyAccountHolderId - String Query: The unique identifier of the account holder that received the grants. (required)

requestOptions - RequestOptions Object to store additional HTTP headers such as idempotency-keys (optional)

Returns:

Grants

Throws:

ApiException - if fails to make API call

IOException

getGrant

public Grant getGrant(String grantId)
               throws ApiException,
                      IOException

Get the details of a grant

Parameters:

grantId - String The unique identifier of the grant reference. (required)

Returns:

Grant

Throws:

ApiException - if fails to make API call

IOException

getGrant

public Grant getGrant(String grantId,
                      RequestOptions requestOptions)
               throws ApiException,
                      IOException

Get the details of a grant

Parameters:

grantId - String The unique identifier of the grant reference. (required)

requestOptions - RequestOptions Object to store additional HTTP headers such as idempotency-keys (optional)

Returns:

Grant

Throws:

ApiException - if fails to make API call

IOException

getGrantDisbursement

public Disbursement getGrantDisbursement(String grantId,
                                         String disbursementId)
                                  throws ApiException,
                                         IOException

Get disbursement details

Parameters:

grantId - String The unique identifier of the grant reference. (required)

disbursementId - String The unique identifier of the disbursement. (required)

Returns:

Disbursement

Throws:

ApiException - if fails to make API call

IOException

getGrantDisbursement

public Disbursement getGrantDisbursement(String grantId,
                                         String disbursementId,
                                         RequestOptions requestOptions)
                                  throws ApiException,
                                         IOException

Get disbursement details

Parameters:

grantId - String The unique identifier of the grant reference. (required)

disbursementId - String The unique identifier of the disbursement. (required)

requestOptions - RequestOptions Object to store additional HTTP headers such as idempotency-keys (optional)

Returns:

Disbursement

Throws:

ApiException - if fails to make API call

IOException

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 call

IOException

requestGrant

public Grant requestGrant(GrantInfo grantInfo,
                          RequestOptions requestOptions)
                   throws ApiException,
                          IOException

Make a request for a grant

Parameters:

grantInfo - GrantInfo (required)

requestOptions - RequestOptions Object to store additional HTTP headers such as idempotency-keys (optional)

Returns:

Grant

Throws:

ApiException - if fails to make API call

IOException

updateGrantDisbursement

public Disbursement updateGrantDisbursement(String grantId,
                                            String disbursementId,
                                            DisbursementInfoUpdate disbursementInfoUpdate)
                                     throws ApiException,
                                            IOException

Update the repayment configuration of a disbursement

Parameters:

grantId - String The unique identifier of the grant reference. (required)

disbursementId - String The unique identifier of the disbursement. (required)

disbursementInfoUpdate - DisbursementInfoUpdate (required)

Returns:

Disbursement

Throws:

ApiException - if fails to make API call

IOException

updateGrantDisbursement

public Disbursement updateGrantDisbursement(String grantId,
                                            String disbursementId,
                                            DisbursementInfoUpdate disbursementInfoUpdate,
                                            RequestOptions requestOptions)
                                     throws ApiException,
                                            IOException

Update the repayment configuration of a disbursement

Parameters:

grantId - String The unique identifier of the grant reference. (required)

disbursementId - String The unique identifier of the disbursement. (required)

disbursementInfoUpdate - DisbursementInfoUpdate (required)

requestOptions - RequestOptions Object to store additional HTTP headers such as idempotency-keys (optional)

Returns:

Disbursement

Throws:

ApiException - if fails to make API call

IOException