Package com.adyen.service.balanceplatform

Class GrantOffersApi

java.lang.Object

com.adyen.Service

com.adyen.service.balanceplatform.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	getAllAvailableGrantOffers(String accountHolderId)	Deprecated. since Configuration API v2 Use the `/grantOffers` endpoint from the [Capital API](https://docs.adyen.com/api-explorer/capital/latest/get/grantOffers) instead.
GrantOffers	getAllAvailableGrantOffers(String accountHolderId, RequestOptions requestOptions)	Deprecated. since Configuration API v2 Use the `/grantOffers` endpoint from the [Capital API](https://docs.adyen.com/api-explorer/capital/latest/get/grantOffers) instead.
GrantOffer	getGrantOffer(String grantOfferId)	Deprecated. since Configuration API v2 Use the `/grantOffers/{id}` endpoint from the [Capital API](https://docs.adyen.com/api-explorer/capital/latest/get/grantOffers/(id)) instead.
GrantOffer	getGrantOffer(String grantOfferId, RequestOptions requestOptions)	Deprecated. since Configuration API v2 Use the `/grantOffers/{id}` endpoint from the [Capital API](https://docs.adyen.com/api-explorer/capital/latest/get/grantOffers/(id)) instead.

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

getAllAvailableGrantOffers

@Deprecated
public GrantOffers getAllAvailableGrantOffers(String accountHolderId)
                                       throws ApiException,
                                              IOException

Deprecated.

since Configuration API v2 Use the `/grantOffers` endpoint from the [Capital API](https://docs.adyen.com/api-explorer/capital/latest/get/grantOffers) instead.

Get all available grant offers

Parameters:

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

Returns:

GrantOffers

Throws:

ApiException - if fails to make API call

IOException

getAllAvailableGrantOffers

@Deprecated
public GrantOffers getAllAvailableGrantOffers(String accountHolderId,
                                              RequestOptions requestOptions)
                                       throws ApiException,
                                              IOException

Deprecated.

since Configuration API v2 Use the `/grantOffers` endpoint from the [Capital API](https://docs.adyen.com/api-explorer/capital/latest/get/grantOffers) instead.

Get all available grant offers

Parameters:

accountHolderId - String Query: The unique identifier of the grant account. (required)

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

Returns:

GrantOffers

Throws:

ApiException - if fails to make API call

IOException

getGrantOffer

@Deprecated
public GrantOffer getGrantOffer(String grantOfferId)
                         throws ApiException,
                                IOException

Deprecated.

since Configuration API v2 Use the `/grantOffers/{id}` endpoint from the [Capital API](https://docs.adyen.com/api-explorer/capital/latest/get/grantOffers/(id)) instead.

Get a grant offer

Parameters:

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

Returns:

GrantOffer

Throws:

ApiException - if fails to make API call

IOException

getGrantOffer

@Deprecated
public GrantOffer getGrantOffer(String grantOfferId,
                                RequestOptions requestOptions)
                         throws ApiException,
                                IOException

Deprecated.

since Configuration API v2 Use the `/grantOffers/{id}` endpoint from the [Capital API](https://docs.adyen.com/api-explorer/capital/latest/get/grantOffers/(id)) instead.

Get a grant offer

Parameters:

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

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

Returns:

GrantOffer

Throws:

ApiException - if fails to make API call

IOException