Package com.adyen.service.balanceplatform

Class ScaAssociationManagementApi

java.lang.Object

com.adyen.Service

com.adyen.service.balanceplatform.ScaAssociationManagementApi

public class ScaAssociationManagementApi
extends Service

Field Summary

Fields

Modifier and Type	Field	Description
static String	API_VERSION
protected String	baseURL

Constructor Summary

Constructors

Constructor	Description
ScaAssociationManagementApi(Client client)	SCA association management constructor in package.
ScaAssociationManagementApi(Client client, String baseURL)	SCA association management constructor in package.

Method Summary

Modifier and Type	Method	Description
ApproveAssociationResponse	approveAssociation(ApproveAssociationRequest approveAssociationRequest)	Approve a pending approval association
ApproveAssociationResponse	approveAssociation(ApproveAssociationRequest approveAssociationRequest, RequestOptions requestOptions)	Approve a pending approval association
ListAssociationsResponse	listAssociations(ScaEntityType entityType, String entityId, Integer pageSize, Integer pageNumber)	Get a list of devices associated with an entity
ListAssociationsResponse	listAssociations(ScaEntityType entityType, String entityId, Integer pageSize, Integer pageNumber, RequestOptions requestOptions)	Get a list of devices associated with an entity
void	removeAssociation(RemoveAssociationRequest removeAssociationRequest)	Delete association to devices
void	removeAssociation(RemoveAssociationRequest removeAssociationRequest, RequestOptions requestOptions)	Delete association to 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

ScaAssociationManagementApi

public ScaAssociationManagementApi(Client client)

SCA association management constructor in package.

Parameters:

client - Client (required)

ScaAssociationManagementApi

public ScaAssociationManagementApi(Client client,
                                   String baseURL)

SCA association management 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

approveAssociation

public ApproveAssociationResponse approveAssociation(ApproveAssociationRequest approveAssociationRequest)
                                              throws ApiException,
                                                     IOException

Approve a pending approval association

Parameters:

approveAssociationRequest - ApproveAssociationRequest (required)

Returns:

ApproveAssociationResponse

Throws:

ApiException - if fails to make API call

IOException

approveAssociation

public ApproveAssociationResponse approveAssociation(ApproveAssociationRequest approveAssociationRequest,
                                                     RequestOptions requestOptions)
                                              throws ApiException,
                                                     IOException

Approve a pending approval association

Parameters:

approveAssociationRequest - ApproveAssociationRequest (required)

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

Returns:

ApproveAssociationResponse

Throws:

ApiException - if fails to make API call

IOException

listAssociations

public ListAssociationsResponse listAssociations(ScaEntityType entityType,
                                                 String entityId,
                                                 Integer pageSize,
                                                 Integer pageNumber)
                                          throws ApiException,
                                                 IOException

Get a list of devices associated with an entity

Parameters:

entityType - ScaEntityType Query: The type of entity you want to retrieve a list of associations for. Possible values: **accountHolder**, **legalEntity** or **paymentInstrument**. (required)

entityId - String Query: The unique identifier of the entity. (required)

pageSize - Integer Query: The number of items to have on a page. Default: **5**. (required)

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

Returns:

ListAssociationsResponse

Throws:

ApiException - if fails to make API call

IOException

listAssociations

public ListAssociationsResponse listAssociations(ScaEntityType entityType,
                                                 String entityId,
                                                 Integer pageSize,
                                                 Integer pageNumber,
                                                 RequestOptions requestOptions)
                                          throws ApiException,
                                                 IOException

Get a list of devices associated with an entity

Parameters:

entityType - ScaEntityType Query: The type of entity you want to retrieve a list of associations for. Possible values: **accountHolder**, **legalEntity** or **paymentInstrument**. (required)

entityId - String Query: The unique identifier of the entity. (required)

pageSize - Integer Query: The number of items to have on a page. Default: **5**. (required)

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

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

Returns:

ListAssociationsResponse

Throws:

ApiException - if fails to make API call

IOException

removeAssociation

public void removeAssociation(RemoveAssociationRequest removeAssociationRequest)
                       throws ApiException,
                              IOException

Delete association to devices

Parameters:

removeAssociationRequest - RemoveAssociationRequest (required)

Throws:

ApiException - if fails to make API call

IOException

removeAssociation

public void removeAssociation(RemoveAssociationRequest removeAssociationRequest,
                              RequestOptions requestOptions)
                       throws ApiException,
                              IOException

Delete association to devices

Parameters:

removeAssociationRequest - RemoveAssociationRequest (required)

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

Throws:

ApiException - if fails to make API call

IOException