Package com.adyen.service.capital

Class GrantOffersApi

java.lang.Object

com.adyen.Service

com.adyen.service.capital.GrantOffersApi

public class GrantOffersApi
extends Service

Field Summary

Fields

Modifier and Type	Field	Description
static String	API_VERSION
protected String	baseURL

Constructor Summary

Constructors

Constructor	Description
GrantOffersApi(Client client)	Grant offers constructor in package.
GrantOffersApi(Client client, String baseURL)	Grant offers constructor in package.

Method Summary

Modifier and Type	Method	Description
GrantOffers	getAllGrantOffers()	Get all available grant offers
GrantOffers	getAllGrantOffers(String accountHolderId, RequestOptions requestOptions)	Get all available grant offers
GrantOffer	getGrantOffer(String id)	Get the details of a grant offer
GrantOffer	getGrantOffer(String id, RequestOptions requestOptions)	Get the details of a grant offer

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

GrantOffersApi

public GrantOffersApi(Client client)

Grant offers constructor in package.

Parameters:

client - Client (required)

GrantOffersApi

public GrantOffersApi(Client client,
                      String baseURL)

Grant offers 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

getAllGrantOffers

public GrantOffers getAllGrantOffers()
                              throws ApiException,
                                     IOException

Get all available grant offers

Returns:

GrantOffers

Throws:

ApiException - if fails to make API call

IOException

getAllGrantOffers

public GrantOffers getAllGrantOffers(String accountHolderId,
                                     RequestOptions requestOptions)
                              throws ApiException,
                                     IOException

Get all available grant offers

Parameters:

accountHolderId - String Query: The unique identifier of the account holder for which you want to get the available grant offers. (optional)

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

Returns:

GrantOffers

Throws:

ApiException - if fails to make API call

IOException

getGrantOffer

public GrantOffer getGrantOffer(String id)
                         throws ApiException,
                                IOException

Get the details of a grant offer

Parameters:

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

Returns:

GrantOffer

Throws:

ApiException - if fails to make API call

IOException

getGrantOffer

public GrantOffer getGrantOffer(String id,
                                RequestOptions requestOptions)
                         throws ApiException,
                                IOException

Get the details of a grant offer

Parameters:

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

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

Returns:

GrantOffer

Throws:

ApiException - if fails to make API call

IOException