com.ingenico.connect.gateway.sdk.java.merchant.mandates

Class MandatesClient

java.lang.Object

com.ingenico.connect.gateway.sdk.java.ApiResource

com.ingenico.connect.gateway.sdk.java.merchant.mandates.MandatesClient

public class MandatesClient
extends ApiResource

Mandates client. Thread-safe.

Field Summary

Fields inherited from class com.ingenico.connect.gateway.sdk.java.ApiResource

clientMetaInfo, communicator

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
GetMandateResponse	block(String uniqueMandateReference) Resource /{merchantId}/mandates/{uniqueMandateReference}/block - Block mandate
GetMandateResponse	block(String uniqueMandateReference, CallContext context) Resource /{merchantId}/mandates/{uniqueMandateReference}/block - Block mandate
CreateMandateResponse	create(CreateMandateRequest body) Resource /{merchantId}/mandates - Create mandate
CreateMandateResponse	create(CreateMandateRequest body, CallContext context) Resource /{merchantId}/mandates - Create mandate
CreateMandateResponse	createWithMandateReference(String uniqueMandateReference, CreateMandateRequest body) Resource /{merchantId}/mandates/{uniqueMandateReference} - Create mandate with mandatereference
CreateMandateResponse	createWithMandateReference(String uniqueMandateReference, CreateMandateRequest body, CallContext context) Resource /{merchantId}/mandates/{uniqueMandateReference} - Create mandate with mandatereference
GetMandateResponse	get(String uniqueMandateReference) Resource /{merchantId}/mandates/{uniqueMandateReference} - Get mandate
GetMandateResponse	get(String uniqueMandateReference, CallContext context) Resource /{merchantId}/mandates/{uniqueMandateReference} - Get mandate
GetMandateResponse	revoke(String uniqueMandateReference) Resource /{merchantId}/mandates/{uniqueMandateReference}/revoke - Revoke mandate
GetMandateResponse	revoke(String uniqueMandateReference, CallContext context) Resource /{merchantId}/mandates/{uniqueMandateReference}/revoke - Revoke mandate
GetMandateResponse	unblock(String uniqueMandateReference) Resource /{merchantId}/mandates/{uniqueMandateReference}/unblock - Unblock mandate
GetMandateResponse	unblock(String uniqueMandateReference, CallContext context) Resource /{merchantId}/mandates/{uniqueMandateReference}/unblock - Unblock mandate

Methods inherited from class com.ingenico.connect.gateway.sdk.java.ApiResource

createException, getClientHeaders, instantiateUri

Methods inherited from class java.lang.Object

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

Constructor Detail

MandatesClient

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

Method Detail

create

public CreateMandateResponse create(CreateMandateRequest body)

Resource /{merchantId}/mandates - Create mandate

Parameters:

body - CreateMandateRequest

Returns:

CreateMandateResponse

Throws:

ValidationException - if the request was not correct and couldn't be processed (HTTP status code 400)

AuthorizationException - if the request was not allowed (HTTP status code 403)

ReferenceException - if an object was attempted to be referenced that doesn't exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

GlobalCollectException - if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

ApiException - if the Ingenico ePayments platform returned any other error

create

public CreateMandateResponse create(CreateMandateRequest body,
                                    CallContext context)

Resource /{merchantId}/mandates - Create mandate

Parameters:

body - CreateMandateRequest

context - CallContext

Returns:

CreateMandateResponse

Throws:

ValidationException - if the request was not correct and couldn't be processed (HTTP status code 400)

AuthorizationException - if the request was not allowed (HTTP status code 403)

IdempotenceException - if an idempotent request caused a conflict (HTTP status code 409)

ReferenceException - if an object was attempted to be referenced that doesn't exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

GlobalCollectException - if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

ApiException - if the Ingenico ePayments platform returned any other error

createWithMandateReference

public CreateMandateResponse createWithMandateReference(String uniqueMandateReference,
                                                        CreateMandateRequest body)

Resource /{merchantId}/mandates/{uniqueMandateReference} - Create mandate with mandatereference

Parameters:

uniqueMandateReference - String

body - CreateMandateRequest

Returns:

CreateMandateResponse

Throws:

ValidationException - if the request was not correct and couldn't be processed (HTTP status code 400)

AuthorizationException - if the request was not allowed (HTTP status code 403)

ReferenceException - if an object was attempted to be referenced that doesn't exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

GlobalCollectException - if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

ApiException - if the Ingenico ePayments platform returned any other error

createWithMandateReference

public CreateMandateResponse createWithMandateReference(String uniqueMandateReference,
                                                        CreateMandateRequest body,
                                                        CallContext context)

Resource /{merchantId}/mandates/{uniqueMandateReference} - Create mandate with mandatereference

Parameters:

uniqueMandateReference - String

body - CreateMandateRequest

context - CallContext

Returns:

CreateMandateResponse

Throws:

ValidationException - if the request was not correct and couldn't be processed (HTTP status code 400)

AuthorizationException - if the request was not allowed (HTTP status code 403)

IdempotenceException - if an idempotent request caused a conflict (HTTP status code 409)

ReferenceException - if an object was attempted to be referenced that doesn't exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

GlobalCollectException - if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

ApiException - if the Ingenico ePayments platform returned any other error

get

public GetMandateResponse get(String uniqueMandateReference)

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

Parameters:

uniqueMandateReference - String

Returns:

GetMandateResponse

Throws:

ValidationException - if the request was not correct and couldn't be processed (HTTP status code 400)

AuthorizationException - if the request was not allowed (HTTP status code 403)

ReferenceException - if an object was attempted to be referenced that doesn't exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

GlobalCollectException - if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

ApiException - if the Ingenico ePayments platform returned any other error

get

public GetMandateResponse get(String uniqueMandateReference,
                              CallContext context)

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

Parameters:

uniqueMandateReference - String

context - CallContext

Returns:

GetMandateResponse

Throws:

ValidationException - if the request was not correct and couldn't be processed (HTTP status code 400)

AuthorizationException - if the request was not allowed (HTTP status code 403)

IdempotenceException - if an idempotent request caused a conflict (HTTP status code 409)

ReferenceException - if an object was attempted to be referenced that doesn't exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

GlobalCollectException - if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

ApiException - if the Ingenico ePayments platform returned any other error

block

public GetMandateResponse block(String uniqueMandateReference)

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

Parameters:

uniqueMandateReference - String

Returns:

GetMandateResponse

Throws:

ValidationException - if the request was not correct and couldn't be processed (HTTP status code 400)

AuthorizationException - if the request was not allowed (HTTP status code 403)

ReferenceException - if an object was attempted to be referenced that doesn't exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

GlobalCollectException - if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

ApiException - if the Ingenico ePayments platform returned any other error

block

public GetMandateResponse block(String uniqueMandateReference,
                                CallContext context)

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

Parameters:

uniqueMandateReference - String

context - CallContext

Returns:

GetMandateResponse

Throws:

ValidationException - if the request was not correct and couldn't be processed (HTTP status code 400)

AuthorizationException - if the request was not allowed (HTTP status code 403)

IdempotenceException - if an idempotent request caused a conflict (HTTP status code 409)

ReferenceException - if an object was attempted to be referenced that doesn't exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

GlobalCollectException - if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

ApiException - if the Ingenico ePayments platform returned any other error

unblock

public GetMandateResponse unblock(String uniqueMandateReference)

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

Parameters:

uniqueMandateReference - String

Returns:

GetMandateResponse

Throws:

ValidationException - if the request was not correct and couldn't be processed (HTTP status code 400)

AuthorizationException - if the request was not allowed (HTTP status code 403)

ReferenceException - if an object was attempted to be referenced that doesn't exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

GlobalCollectException - if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

ApiException - if the Ingenico ePayments platform returned any other error

unblock

public GetMandateResponse unblock(String uniqueMandateReference,
                                  CallContext context)

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

Parameters:

uniqueMandateReference - String

context - CallContext

Returns:

GetMandateResponse

Throws:

ValidationException - if the request was not correct and couldn't be processed (HTTP status code 400)

AuthorizationException - if the request was not allowed (HTTP status code 403)

IdempotenceException - if an idempotent request caused a conflict (HTTP status code 409)

ReferenceException - if an object was attempted to be referenced that doesn't exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

GlobalCollectException - if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

ApiException - if the Ingenico ePayments platform returned any other error

revoke

public GetMandateResponse revoke(String uniqueMandateReference)

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

Parameters:

uniqueMandateReference - String

Returns:

GetMandateResponse

Throws:

ValidationException - if the request was not correct and couldn't be processed (HTTP status code 400)

AuthorizationException - if the request was not allowed (HTTP status code 403)

ReferenceException - if an object was attempted to be referenced that doesn't exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

GlobalCollectException - if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

ApiException - if the Ingenico ePayments platform returned any other error

revoke

public GetMandateResponse revoke(String uniqueMandateReference,
                                 CallContext context)

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

Parameters:

uniqueMandateReference - String

context - CallContext

Returns:

GetMandateResponse

Throws:

ValidationException - if the request was not correct and couldn't be processed (HTTP status code 400)

AuthorizationException - if the request was not allowed (HTTP status code 403)

IdempotenceException - if an idempotent request caused a conflict (HTTP status code 409)

ReferenceException - if an object was attempted to be referenced that doesn't exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

GlobalCollectException - if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

ApiException - if the Ingenico ePayments platform returned any other error