Package com.adyen.service.capital

Class DynamicOffersApi

java.lang.Object

com.adyen.Service

com.adyen.service.capital.DynamicOffersApi

public class DynamicOffersApi
extends Service

Field Summary

Fields

Modifier and Type	Field	Description
static String	API_VERSION
protected String	baseURL

Constructor Summary

Constructors

Constructor	Description
DynamicOffersApi(Client client)	Dynamic offers constructor in package.
DynamicOffersApi(Client client, String baseURL)	Dynamic offers constructor in package.

Method Summary

Modifier and Type	Method	Description
CalculatedGrantOffer	calculatePreliminaryOfferFromDynamicOffer(String id, CalculateGrantOfferRequest calculateGrantOfferRequest)	Calculate a preliminary offer for a selected financing amount
CalculatedGrantOffer	calculatePreliminaryOfferFromDynamicOffer(String id, CalculateGrantOfferRequest calculateGrantOfferRequest, RequestOptions requestOptions)	Calculate a preliminary offer for a selected financing amount
GrantOffer	createStaticOfferFromDynamicOffer(String id, CreateGrantOfferRequest createGrantOfferRequest)	Create a static offer for a selected financing amount
GrantOffer	createStaticOfferFromDynamicOffer(String id, CreateGrantOfferRequest createGrantOfferRequest, RequestOptions requestOptions)	Create a static offer for a selected financing amount
GetDynamicOffersResponse	getAllDynamicOffers(String accountHolderId)	Get all available dynamic offers
GetDynamicOffersResponse	getAllDynamicOffers(String accountHolderId, FinancingType financingType, RequestOptions requestOptions)	Get all available dynamic offers

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

DynamicOffersApi

public DynamicOffersApi(Client client)

Dynamic offers constructor in package.

Parameters:

client - Client (required)

DynamicOffersApi

public DynamicOffersApi(Client client,
                        String baseURL)

Dynamic 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

calculatePreliminaryOfferFromDynamicOffer

public CalculatedGrantOffer calculatePreliminaryOfferFromDynamicOffer(String id,
                                                                      CalculateGrantOfferRequest calculateGrantOfferRequest)
                                                               throws ApiException,
                                                                      IOException

Calculate a preliminary offer for a selected financing amount

Parameters:

id - String The unique identifier of the dynamic offer from which the user selected the financing amount. (required)

calculateGrantOfferRequest - CalculateGrantOfferRequest (required)

Returns:

CalculatedGrantOffer

Throws:

ApiException - if fails to make API call

IOException

calculatePreliminaryOfferFromDynamicOffer

public CalculatedGrantOffer calculatePreliminaryOfferFromDynamicOffer(String id,
                                                                      CalculateGrantOfferRequest calculateGrantOfferRequest,
                                                                      RequestOptions requestOptions)
                                                               throws ApiException,
                                                                      IOException

Calculate a preliminary offer for a selected financing amount

Parameters:

id - String The unique identifier of the dynamic offer from which the user selected the financing amount. (required)

calculateGrantOfferRequest - CalculateGrantOfferRequest (required)

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

Returns:

CalculatedGrantOffer

Throws:

ApiException - if fails to make API call

IOException

createStaticOfferFromDynamicOffer

public GrantOffer createStaticOfferFromDynamicOffer(String id,
                                                    CreateGrantOfferRequest createGrantOfferRequest)
                                             throws ApiException,
                                                    IOException

Create a static offer for a selected financing amount

Parameters:

id - String The unique identifier of the dynamic offer from which the user selected the financing amount. (required)

createGrantOfferRequest - CreateGrantOfferRequest (required)

Returns:

GrantOffer

Throws:

ApiException - if fails to make API call

IOException

createStaticOfferFromDynamicOffer

public GrantOffer createStaticOfferFromDynamicOffer(String id,
                                                    CreateGrantOfferRequest createGrantOfferRequest,
                                                    RequestOptions requestOptions)
                                             throws ApiException,
                                                    IOException

Create a static offer for a selected financing amount

Parameters:

id - String The unique identifier of the dynamic offer from which the user selected the financing amount. (required)

createGrantOfferRequest - CreateGrantOfferRequest (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

getAllDynamicOffers

public GetDynamicOffersResponse getAllDynamicOffers(String accountHolderId)
                                             throws ApiException,
                                                    IOException

Get all available dynamic offers

Parameters:

accountHolderId - String Query: The unique identifier of the account holder that the dynamic offer is for. (required)

Returns:

GetDynamicOffersResponse

Throws:

ApiException - if fails to make API call

IOException

getAllDynamicOffers

public GetDynamicOffersResponse getAllDynamicOffers(String accountHolderId,
                                                    FinancingType financingType,
                                                    RequestOptions requestOptions)
                                             throws ApiException,
                                                    IOException

Get all available dynamic offers

Parameters:

accountHolderId - String Query: The unique identifier of the account holder that the dynamic offer is for. (required)

financingType - FinancingType Query: The type of financing that the offer is for. If the value is not specified, returns all available types. Possible values: **businessFinancing** (optional)

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

Returns:

GetDynamicOffersResponse

Throws:

ApiException - if fails to make API call

IOException