Package com.adyen.service.transfers

Class CapitalApi

java.lang.Object

com.adyen.Service

com.adyen.service.transfers.CapitalApi

public class CapitalApi
extends Service

Field Summary

Fields

Modifier and Type	Field	Description
static String	API_VERSION
protected String	baseURL

Constructor Summary

Constructors

Constructor	Description
CapitalApi(Client client)	Capital constructor in package.
CapitalApi(Client client, String baseURL)	Capital constructor in package.

Method Summary

Modifier and Type	Method	Description
CapitalGrants	getCapitalAccount()	Get a capital account
CapitalGrants	getCapitalAccount(String counterpartyAccountHolderId, RequestOptions requestOptions)	Get a capital account
CapitalGrant	getGrantReferenceDetails(String id)	Get grant reference details
CapitalGrant	getGrantReferenceDetails(String id, RequestOptions requestOptions)	Get grant reference details
CapitalGrant	requestGrantPayout(CapitalGrantInfo capitalGrantInfo)	Request a grant payout
CapitalGrant	requestGrantPayout(CapitalGrantInfo capitalGrantInfo, RequestOptions requestOptions)	Request a grant payout

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

CapitalApi

public CapitalApi(Client client)

Capital constructor in package.

Parameters:

client - Client (required)

CapitalApi

public CapitalApi(Client client,
                  String baseURL)

Capital 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

getCapitalAccount

public CapitalGrants getCapitalAccount()
                                throws ApiException,
                                       IOException

Get a capital account

Returns:

CapitalGrants

Throws:

ApiException - if fails to make API call

IOException

getCapitalAccount

public CapitalGrants getCapitalAccount(String counterpartyAccountHolderId,
                                       RequestOptions requestOptions)
                                throws ApiException,
                                       IOException

Get a capital account

Parameters:

counterpartyAccountHolderId - String Query: The counterparty account holder id. (optional)

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

Returns:

CapitalGrants

Throws:

ApiException - if fails to make API call

IOException

getGrantReferenceDetails

public CapitalGrant getGrantReferenceDetails(String id)
                                      throws ApiException,
                                             IOException

Get grant reference details

Parameters:

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

Returns:

CapitalGrant

Throws:

ApiException - if fails to make API call

IOException

getGrantReferenceDetails

public CapitalGrant getGrantReferenceDetails(String id,
                                             RequestOptions requestOptions)
                                      throws ApiException,
                                             IOException

Get grant reference details

Parameters:

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

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

Returns:

CapitalGrant

Throws:

ApiException - if fails to make API call

IOException

requestGrantPayout

public CapitalGrant requestGrantPayout(CapitalGrantInfo capitalGrantInfo)
                                throws ApiException,
                                       IOException

Request a grant payout

Parameters:

capitalGrantInfo - CapitalGrantInfo (required)

Returns:

CapitalGrant

Throws:

ApiException - if fails to make API call

IOException

requestGrantPayout

public CapitalGrant requestGrantPayout(CapitalGrantInfo capitalGrantInfo,
                                       RequestOptions requestOptions)
                                throws ApiException,
                                       IOException

Request a grant payout

Parameters:

capitalGrantInfo - CapitalGrantInfo (required)

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

Returns:

CapitalGrant

Throws:

ApiException - if fails to make API call

IOException