Package com.onlinepayments.merchant.mandates

Class MandatesClient

java.lang.Object

com.onlinepayments.ApiResource

com.onlinepayments.merchant.mandates.MandatesClient

All Implemented Interfaces:

MandatesClientInterface

public class MandatesClient
extends ApiResource
implements MandatesClientInterface

Mandates client. Thread-safe.

Field Summary

Fields inherited from class com.onlinepayments.ApiResource

clientMetaInfo, communicator

Constructor Summary

Constructors

Constructor	Description
MandatesClient(ApiResource parent, Map<String,String> pathContext)

Method Summary

Modifier and Type	Method	Description
GetMandateResponse	blockMandate(String uniqueMandateReference)	Resource /v2/{merchantId}/mandates/{uniqueMandateReference}/block - Block mandate
GetMandateResponse	blockMandate(String uniqueMandateReference, CallContext context)	Resource /v2/{merchantId}/mandates/{uniqueMandateReference}/block - Block mandate
CreateMandateResponse	createMandate(CreateMandateRequest body)	Resource /v2/{merchantId}/mandates - Create mandate
CreateMandateResponse	createMandate(CreateMandateRequest body, CallContext context)	Resource /v2/{merchantId}/mandates - Create mandate
GetMandateResponse	getMandate(String uniqueMandateReference)	Resource /v2/{merchantId}/mandates/{uniqueMandateReference} - Get mandate
GetMandateResponse	getMandate(String uniqueMandateReference, CallContext context)	Resource /v2/{merchantId}/mandates/{uniqueMandateReference} - Get mandate
GetMandateResponse	revokeMandate(String uniqueMandateReference)	Resource /v2/{merchantId}/mandates/{uniqueMandateReference}/revoke - Revoke mandate
GetMandateResponse	revokeMandate(String uniqueMandateReference, CallContext context)	Resource /v2/{merchantId}/mandates/{uniqueMandateReference}/revoke - Revoke mandate
GetMandateResponse	unblockMandate(String uniqueMandateReference)	Resource /v2/{merchantId}/mandates/{uniqueMandateReference}/unblock - Unblock mandate
GetMandateResponse	unblockMandate(String uniqueMandateReference, CallContext context)	Resource /v2/{merchantId}/mandates/{uniqueMandateReference}/unblock - Unblock mandate

Methods inherited from class com.onlinepayments.ApiResource

getClientHeaders, instantiateUri

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MandatesClient

public MandatesClient(ApiResource parent,
 Map<String,String> pathContext)

Method Details

createMandate

public CreateMandateResponse createMandate(CreateMandateRequest body)

Resource /v2/{merchantId}/mandates - Create mandate

Specified by:

createMandate in interface MandatesClientInterface

Parameters:

body - CreateMandateRequest

Returns:

CreateMandateResponse

createMandate

public CreateMandateResponse createMandate(CreateMandateRequest body,
 CallContext context)

Resource /v2/{merchantId}/mandates - Create mandate

Specified by:

createMandate in interface MandatesClientInterface

Parameters:

body - CreateMandateRequest

context - CallContext

Returns:

CreateMandateResponse

getMandate

public GetMandateResponse getMandate(String uniqueMandateReference)

Resource /v2/{merchantId}/mandates/{uniqueMandateReference} - Get mandate

Specified by:

getMandate in interface MandatesClientInterface

Parameters:

uniqueMandateReference - String

Returns:

GetMandateResponse

getMandate

public GetMandateResponse getMandate(String uniqueMandateReference,
 CallContext context)

Resource /v2/{merchantId}/mandates/{uniqueMandateReference} - Get mandate

Specified by:

getMandate in interface MandatesClientInterface

Parameters:

uniqueMandateReference - String

context - CallContext

Returns:

GetMandateResponse

blockMandate

public GetMandateResponse blockMandate(String uniqueMandateReference)

Resource /v2/{merchantId}/mandates/{uniqueMandateReference}/block - Block mandate

Specified by:

blockMandate in interface MandatesClientInterface

Parameters:

uniqueMandateReference - String

Returns:

GetMandateResponse

blockMandate

public GetMandateResponse blockMandate(String uniqueMandateReference,
 CallContext context)

Resource /v2/{merchantId}/mandates/{uniqueMandateReference}/block - Block mandate

Specified by:

blockMandate in interface MandatesClientInterface

Parameters:

uniqueMandateReference - String

context - CallContext

Returns:

GetMandateResponse

unblockMandate

public GetMandateResponse unblockMandate(String uniqueMandateReference)

Resource /v2/{merchantId}/mandates/{uniqueMandateReference}/unblock - Unblock mandate

Specified by:

unblockMandate in interface MandatesClientInterface

Parameters:

uniqueMandateReference - String

Returns:

GetMandateResponse

unblockMandate

public GetMandateResponse unblockMandate(String uniqueMandateReference,
 CallContext context)

Resource /v2/{merchantId}/mandates/{uniqueMandateReference}/unblock - Unblock mandate

Specified by:

unblockMandate in interface MandatesClientInterface

Parameters:

uniqueMandateReference - String

context - CallContext

Returns:

GetMandateResponse

revokeMandate

public GetMandateResponse revokeMandate(String uniqueMandateReference)

Resource /v2/{merchantId}/mandates/{uniqueMandateReference}/revoke - Revoke mandate

Specified by:

revokeMandate in interface MandatesClientInterface

Parameters:

uniqueMandateReference - String

Returns:

GetMandateResponse

revokeMandate

public GetMandateResponse revokeMandate(String uniqueMandateReference,
 CallContext context)

Resource /v2/{merchantId}/mandates/{uniqueMandateReference}/revoke - Revoke mandate

Specified by:

revokeMandate in interface MandatesClientInterface

Parameters:

uniqueMandateReference - String

context - CallContext

Returns:

GetMandateResponse