Package com.adyen.service.checkout

Class OrdersApi

java.lang.Object

com.adyen.Service

com.adyen.service.checkout.OrdersApi

public class OrdersApi
extends Service

Field Summary

Fields

Modifier and Type	Field	Description
static String	API_VERSION
protected String	baseURL

Constructor Summary

Constructors

Constructor	Description
OrdersApi(Client client)	Orders constructor in package.
OrdersApi(Client client, String baseURL)	Orders constructor in package.

Method Summary

Modifier and Type	Method	Description
CancelOrderResponse	cancelOrder(CancelOrderRequest cancelOrderRequest)	Cancel an order
CancelOrderResponse	cancelOrder(CancelOrderRequest cancelOrderRequest, RequestOptions requestOptions)	Cancel an order
BalanceCheckResponse	getBalanceOfGiftCard(BalanceCheckRequest balanceCheckRequest)	Get the balance of a gift card
BalanceCheckResponse	getBalanceOfGiftCard(BalanceCheckRequest balanceCheckRequest, RequestOptions requestOptions)	Get the balance of a gift card
CreateOrderResponse	orders(CreateOrderRequest createOrderRequest)	Create an order
CreateOrderResponse	orders(CreateOrderRequest createOrderRequest, RequestOptions requestOptions)	Create an order

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

OrdersApi

public OrdersApi(Client client)

Orders constructor in package.

Parameters:

client - Client (required)

OrdersApi

public OrdersApi(Client client,
                 String baseURL)

Orders 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

cancelOrder

public CancelOrderResponse cancelOrder(CancelOrderRequest cancelOrderRequest)
                                throws ApiException,
                                       IOException

Cancel an order

Parameters:

cancelOrderRequest - CancelOrderRequest (required)

Returns:

CancelOrderResponse

Throws:

ApiException - if fails to make API call

IOException

cancelOrder

public CancelOrderResponse cancelOrder(CancelOrderRequest cancelOrderRequest,
                                       RequestOptions requestOptions)
                                throws ApiException,
                                       IOException

Cancel an order

Parameters:

cancelOrderRequest - CancelOrderRequest (required)

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

Returns:

CancelOrderResponse

Throws:

ApiException - if fails to make API call

IOException

getBalanceOfGiftCard

public BalanceCheckResponse getBalanceOfGiftCard(BalanceCheckRequest balanceCheckRequest)
                                          throws ApiException,
                                                 IOException

Get the balance of a gift card

Parameters:

balanceCheckRequest - BalanceCheckRequest (required)

Returns:

BalanceCheckResponse

Throws:

ApiException - if fails to make API call

IOException

getBalanceOfGiftCard

public BalanceCheckResponse getBalanceOfGiftCard(BalanceCheckRequest balanceCheckRequest,
                                                 RequestOptions requestOptions)
                                          throws ApiException,
                                                 IOException

Get the balance of a gift card

Parameters:

balanceCheckRequest - BalanceCheckRequest (required)

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

Returns:

BalanceCheckResponse

Throws:

ApiException - if fails to make API call

IOException

orders

public CreateOrderResponse orders(CreateOrderRequest createOrderRequest)
                           throws ApiException,
                                  IOException

Create an order

Parameters:

createOrderRequest - CreateOrderRequest (required)

Returns:

CreateOrderResponse

Throws:

ApiException - if fails to make API call

IOException

orders

public CreateOrderResponse orders(CreateOrderRequest createOrderRequest,
                                  RequestOptions requestOptions)
                           throws ApiException,
                                  IOException

Create an order

Parameters:

createOrderRequest - CreateOrderRequest (required)

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

Returns:

CreateOrderResponse

Throws:

ApiException - if fails to make API call

IOException