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

Class TokensClient

java.lang.Object

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

com.ingenico.connect.gateway.sdk.java.merchant.tokens.TokensClient

public class TokensClient
extends ApiResource

Tokens client. Thread-safe.

Field Summary

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

clientMetaInfo, communicator

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	approvesepadirectdebit(String tokenId, ApproveTokenRequest body) Resource /{merchantId}/tokens/{tokenId}/approvesepadirectdebit - Approve SEPA DD mandate
void	approvesepadirectdebit(String tokenId, ApproveTokenRequest body, CallContext context) Resource /{merchantId}/tokens/{tokenId}/approvesepadirectdebit - Approve SEPA DD mandate
CreateTokenResponse	create(CreateTokenRequest body) Resource /{merchantId}/tokens - Create token
CreateTokenResponse	create(CreateTokenRequest body, CallContext context) Resource /{merchantId}/tokens - Create token
void	delete(String tokenId, DeleteTokenParams query) Resource /{merchantId}/tokens/{tokenId} - Delete token
void	delete(String tokenId, DeleteTokenParams query, CallContext context) Resource /{merchantId}/tokens/{tokenId} - Delete token
TokenResponse	get(String tokenId) Resource /{merchantId}/tokens/{tokenId} - Get token
TokenResponse	get(String tokenId, CallContext context) Resource /{merchantId}/tokens/{tokenId} - Get token
void	update(String tokenId, UpdateTokenRequest body) Resource /{merchantId}/tokens/{tokenId} - Update token
void	update(String tokenId, UpdateTokenRequest body, CallContext context) Resource /{merchantId}/tokens/{tokenId} - Update token

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

TokensClient

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

Method Detail

create

public CreateTokenResponse create(CreateTokenRequest body)

Resource /{merchantId}/tokens - Create token

Parameters:

body - CreateTokenRequest

Returns:

CreateTokenResponse

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 CreateTokenResponse create(CreateTokenRequest body,
                                  CallContext context)

Resource /{merchantId}/tokens - Create token

Parameters:

body - CreateTokenRequest

context - CallContext

Returns:

CreateTokenResponse

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 TokenResponse get(String tokenId)

Resource /{merchantId}/tokens/{tokenId} - Get token

Parameters:

tokenId - String

Returns:

TokenResponse

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 TokenResponse get(String tokenId,
                         CallContext context)

Resource /{merchantId}/tokens/{tokenId} - Get token

Parameters:

tokenId - String

context - CallContext

Returns:

TokenResponse

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

update

public void update(String tokenId,
                   UpdateTokenRequest body)

Resource /{merchantId}/tokens/{tokenId} - Update token

Parameters:

tokenId - String

body - UpdateTokenRequest

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

update

public void update(String tokenId,
                   UpdateTokenRequest body,
                   CallContext context)

Resource /{merchantId}/tokens/{tokenId} - Update token

Parameters:

tokenId - String

body - UpdateTokenRequest

context - CallContext

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

delete

public void delete(String tokenId,
                   DeleteTokenParams query)

Resource /{merchantId}/tokens/{tokenId} - Delete token

Parameters:

tokenId - String

query - DeleteTokenParams

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

delete

public void delete(String tokenId,
                   DeleteTokenParams query,
                   CallContext context)

Resource /{merchantId}/tokens/{tokenId} - Delete token

Parameters:

tokenId - String

query - DeleteTokenParams

context - CallContext

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

approvesepadirectdebit

public void approvesepadirectdebit(String tokenId,
                                   ApproveTokenRequest body)

Resource /{merchantId}/tokens/{tokenId}/approvesepadirectdebit - Approve SEPA DD mandate

Parameters:

tokenId - String

body - ApproveTokenRequest

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

approvesepadirectdebit

public void approvesepadirectdebit(String tokenId,
                                   ApproveTokenRequest body,
                                   CallContext context)

Resource /{merchantId}/tokens/{tokenId}/approvesepadirectdebit - Approve SEPA DD mandate

Parameters:

tokenId - String

body - ApproveTokenRequest

context - CallContext

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