com.onlinepayments.merchant.services

Interface ServicesClientInterface

All Known Implementing Classes:

ServicesClient

public interface ServicesClientInterface

Services client. Thread-safe.

Method Summary

Modifier and Type	Method and Description
CurrencyConversionResponse	getDccRateInquiry(CurrencyConversionRequest body) Resource /v2/{merchantId}/services/dccrate - Get Dcc Rate Inquiry Api
CurrencyConversionResponse	getDccRateInquiry(CurrencyConversionRequest body, CallContext context) Resource /v2/{merchantId}/services/dccrate - Get Dcc Rate Inquiry Api
GetIINDetailsResponse	getIINDetails(GetIINDetailsRequest body) Resource /v2/{merchantId}/services/getIINdetails - Get IIN details
GetIINDetailsResponse	getIINDetails(GetIINDetailsRequest body, CallContext context) Resource /v2/{merchantId}/services/getIINdetails - Get IIN details
GetPrivacyPolicyResponse	getPrivacyPolicy(GetPrivacyPolicyParams query) Resource /v2/{merchantId}/services/privacypolicy - Get Privacy Policy
GetPrivacyPolicyResponse	getPrivacyPolicy(GetPrivacyPolicyParams query, CallContext context) Resource /v2/{merchantId}/services/privacypolicy - Get Privacy Policy
CalculateSurchargeResponse	surchargeCalculation(CalculateSurchargeRequest body) Resource /v2/{merchantId}/services/surchargecalculation - Surcharge Calculation
CalculateSurchargeResponse	surchargeCalculation(CalculateSurchargeRequest body, CallContext context) Resource /v2/{merchantId}/services/surchargecalculation - Surcharge Calculation
TestConnection	testConnection() Resource /v2/{merchantId}/services/testconnection - Test connection
TestConnection	testConnection(CallContext context) Resource /v2/{merchantId}/services/testconnection - Test connection

Method Detail

surchargeCalculation

CalculateSurchargeResponse surchargeCalculation(CalculateSurchargeRequest body)

Resource /v2/{merchantId}/services/surchargecalculation - Surcharge Calculation

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

surchargeCalculation

CalculateSurchargeResponse surchargeCalculation(CalculateSurchargeRequest body,
                                                CallContext context)

Resource /v2/{merchantId}/services/surchargecalculation - Surcharge Calculation

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

getDccRateInquiry

CurrencyConversionResponse getDccRateInquiry(CurrencyConversionRequest body)

Resource /v2/{merchantId}/services/dccrate - Get Dcc Rate Inquiry Api

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

getDccRateInquiry

CurrencyConversionResponse getDccRateInquiry(CurrencyConversionRequest body,
                                             CallContext context)

Resource /v2/{merchantId}/services/dccrate - Get Dcc Rate Inquiry Api

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

getPrivacyPolicy

GetPrivacyPolicyResponse getPrivacyPolicy(GetPrivacyPolicyParams query)

Resource /v2/{merchantId}/services/privacypolicy - Get Privacy Policy

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

getPrivacyPolicy

GetPrivacyPolicyResponse getPrivacyPolicy(GetPrivacyPolicyParams query,
                                          CallContext context)

Resource /v2/{merchantId}/services/privacypolicy - Get Privacy Policy

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

testConnection

TestConnection testConnection()

Resource /v2/{merchantId}/services/testconnection - Test connection

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

testConnection

TestConnection testConnection(CallContext context)

Resource /v2/{merchantId}/services/testconnection - Test connection

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

getIINDetails

GetIINDetailsResponse getIINDetails(GetIINDetailsRequest body)

Resource /v2/{merchantId}/services/getIINdetails - Get IIN details

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

getIINDetails

GetIINDetailsResponse getIINDetails(GetIINDetailsRequest body,
                                    CallContext context)

Resource /v2/{merchantId}/services/getIINdetails - Get IIN details

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