Package com.adyen.service.balanceplatform

Class ManageScaDevicesApi

java.lang.Object

com.adyen.Service

com.adyen.service.balanceplatform.ManageScaDevicesApi

public class ManageScaDevicesApi
extends Service

Field Summary

Fields

Modifier and Type	Field	Description
static String	API_VERSION
protected String	baseURL

Constructor Summary

Constructors

Constructor	Description
ManageScaDevicesApi(Client client)	Manage SCA devices constructor in package.
ManageScaDevicesApi(Client client, String baseURL)	Manage SCA devices constructor in package.

Method Summary

Modifier and Type	Method	Description
RegisterSCAFinalResponse	completeRegistrationOfScaDevice(String id, RegisterSCARequest registerSCARequest)	Complete the registration of an SCA device
RegisterSCAFinalResponse	completeRegistrationOfScaDevice(String id, RegisterSCARequest registerSCARequest, RequestOptions requestOptions)	Complete the registration of an SCA device
void	deleteRegistrationOfScaDevice(String id, String paymentInstrumentId)	Delete a registration of an SCA device
void	deleteRegistrationOfScaDevice(String id, String paymentInstrumentId, RequestOptions requestOptions)	Delete a registration of an SCA device
RegisterSCAResponse	initiateRegistrationOfScaDevice(RegisterSCARequest registerSCARequest)	Initiate the registration of an SCA device
RegisterSCAResponse	initiateRegistrationOfScaDevice(RegisterSCARequest registerSCARequest, RequestOptions requestOptions)	Initiate the registration of an SCA device
SearchRegisteredDevicesResponse	listRegisteredScaDevices(String paymentInstrumentId)	Get a list of registered SCA devices
SearchRegisteredDevicesResponse	listRegisteredScaDevices(String paymentInstrumentId, Integer pageNumber, Integer pageSize, RequestOptions requestOptions)	Get a list of registered SCA devices

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

ManageScaDevicesApi

public ManageScaDevicesApi(Client client)

Manage SCA devices constructor in package.

Parameters:

client - Client (required)

ManageScaDevicesApi

public ManageScaDevicesApi(Client client,
                           String baseURL)

Manage SCA devices 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

completeRegistrationOfScaDevice

public RegisterSCAFinalResponse completeRegistrationOfScaDevice(String id,
                                                                RegisterSCARequest registerSCARequest)
                                                         throws ApiException,
                                                                IOException

Complete the registration of an SCA device

Parameters:

id - String The unique identifier of the SCA device. You obtain this `id` in the response of a POST [/registeredDevices](https://docs.adyen.com/api-explorer/balanceplatform/2/post/registeredDevices#responses-200-id) request. (required)

registerSCARequest - RegisterSCARequest (required)

Returns:

RegisterSCAFinalResponse

Throws:

ApiException - if fails to make API call

IOException

completeRegistrationOfScaDevice

public RegisterSCAFinalResponse completeRegistrationOfScaDevice(String id,
                                                                RegisterSCARequest registerSCARequest,
                                                                RequestOptions requestOptions)
                                                         throws ApiException,
                                                                IOException

Complete the registration of an SCA device

Parameters:

id - String The unique identifier of the SCA device. You obtain this `id` in the response of a POST [/registeredDevices](https://docs.adyen.com/api-explorer/balanceplatform/2/post/registeredDevices#responses-200-id) request. (required)

registerSCARequest - RegisterSCARequest (required)

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

Returns:

RegisterSCAFinalResponse

Throws:

ApiException - if fails to make API call

IOException

deleteRegistrationOfScaDevice

public void deleteRegistrationOfScaDevice(String id,
                                          String paymentInstrumentId)
                                   throws ApiException,
                                          IOException

Delete a registration of an SCA device

Parameters:

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

paymentInstrumentId - String The unique identifier of the payment instrument linked to the SCA device. (required)

Throws:

ApiException - if fails to make API call

IOException

deleteRegistrationOfScaDevice

public void deleteRegistrationOfScaDevice(String id,
                                          String paymentInstrumentId,
                                          RequestOptions requestOptions)
                                   throws ApiException,
                                          IOException

Delete a registration of an SCA device

Parameters:

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

paymentInstrumentId - String Query: The unique identifier of the payment instrument linked to the SCA device. (required)

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

Throws:

ApiException - if fails to make API call

IOException

initiateRegistrationOfScaDevice

public RegisterSCAResponse initiateRegistrationOfScaDevice(RegisterSCARequest registerSCARequest)
                                                    throws ApiException,
                                                           IOException

Initiate the registration of an SCA device

Parameters:

registerSCARequest - RegisterSCARequest (required)

Returns:

RegisterSCAResponse

Throws:

ApiException - if fails to make API call

IOException

initiateRegistrationOfScaDevice

public RegisterSCAResponse initiateRegistrationOfScaDevice(RegisterSCARequest registerSCARequest,
                                                           RequestOptions requestOptions)
                                                    throws ApiException,
                                                           IOException

Initiate the registration of an SCA device

Parameters:

registerSCARequest - RegisterSCARequest (required)

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

Returns:

RegisterSCAResponse

Throws:

ApiException - if fails to make API call

IOException

listRegisteredScaDevices

public SearchRegisteredDevicesResponse listRegisteredScaDevices(String paymentInstrumentId)
                                                         throws ApiException,
                                                                IOException

Get a list of registered SCA devices

Parameters:

paymentInstrumentId - String The unique identifier of a payment instrument. It limits the returned list to SCA devices associated to this payment instrument. (required)

Returns:

SearchRegisteredDevicesResponse

Throws:

ApiException - if fails to make API call

IOException

listRegisteredScaDevices

public SearchRegisteredDevicesResponse listRegisteredScaDevices(String paymentInstrumentId,
                                                                Integer pageNumber,
                                                                Integer pageSize,
                                                                RequestOptions requestOptions)
                                                         throws ApiException,
                                                                IOException

Get a list of registered SCA devices

Parameters:

paymentInstrumentId - String Query: The unique identifier of a payment instrument. It limits the returned list to SCA devices associated to this payment instrument. (required)

pageNumber - Integer Query: The index of the page to retrieve. The index of the first page is 0 (zero). Default: 0. (optional)

pageSize - Integer Query: The number of items to have on a page. Default: 20. Maximum: 100. (optional)

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

Returns:

SearchRegisteredDevicesResponse

Throws:

ApiException - if fails to make API call

IOException