com.onlinepayments.merchant.tokens

Interface TokensClientInterface

All Known Implementing Classes:

TokensClient

public interface TokensClientInterface

Tokens client. Thread-safe.

Method Summary

Modifier and Type	Method and Description
CreatedTokenResponse	createToken(CreateTokenRequest body) Resource /v2/{merchantId}/tokens - Create token
CreatedTokenResponse	createToken(CreateTokenRequest body, CallContext context) Resource /v2/{merchantId}/tokens - Create token
void	deleteToken(String tokenId) Resource /v2/{merchantId}/tokens/{tokenId} - Delete token
void	deleteToken(String tokenId, CallContext context) Resource /v2/{merchantId}/tokens/{tokenId} - Delete token
TokenResponse	getToken(String tokenId) Resource /v2/{merchantId}/tokens/{tokenId} - Get token
TokenResponse	getToken(String tokenId, CallContext context) Resource /v2/{merchantId}/tokens/{tokenId} - Get token

Method Detail

createToken

CreatedTokenResponse createToken(CreateTokenRequest body)

Resource /v2/{merchantId}/tokens - Create token

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)

PaymentPlatformException - if something went wrong at the payment platform, the payment 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 payment platform returned any other error

createToken

CreatedTokenResponse createToken(CreateTokenRequest body,
                                 CallContext context)

Resource /v2/{merchantId}/tokens - Create token

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)

PaymentPlatformException - if something went wrong at the payment platform, the payment 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 payment platform returned any other error

getToken

TokenResponse getToken(String tokenId)

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

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)

PaymentPlatformException - if something went wrong at the payment platform, the payment 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 payment platform returned any other error

getToken

TokenResponse getToken(String tokenId,
                       CallContext context)

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

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)

PaymentPlatformException - if something went wrong at the payment platform, the payment 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 payment platform returned any other error

deleteToken

void deleteToken(String tokenId)

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

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)

PaymentPlatformException - if something went wrong at the payment platform, the payment 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 payment platform returned any other error

deleteToken

void deleteToken(String tokenId,
                 CallContext context)

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

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)

PaymentPlatformException - if something went wrong at the payment platform, the payment 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 payment platform returned any other error