com.onlinepayments.merchant.hostedcheckout

Interface HostedCheckoutClientInterface

All Known Implementing Classes:

HostedCheckoutClient

public interface HostedCheckoutClientInterface

HostedCheckout client. Thread-safe.

Method Summary

Modifier and Type	Method and Description
CreateHostedCheckoutResponse	createHostedCheckout(CreateHostedCheckoutRequest body) Resource /v2/{merchantId}/hostedcheckouts - Create hosted checkout
CreateHostedCheckoutResponse	createHostedCheckout(CreateHostedCheckoutRequest body, CallContext context) Resource /v2/{merchantId}/hostedcheckouts - Create hosted checkout
GetHostedCheckoutResponse	getHostedCheckout(String hostedCheckoutId) Resource /v2/{merchantId}/hostedcheckouts/{hostedCheckoutId} - Get hosted checkout status
GetHostedCheckoutResponse	getHostedCheckout(String hostedCheckoutId, CallContext context) Resource /v2/{merchantId}/hostedcheckouts/{hostedCheckoutId} - Get hosted checkout status

Method Detail

createHostedCheckout

CreateHostedCheckoutResponse createHostedCheckout(CreateHostedCheckoutRequest body)

Resource /v2/{merchantId}/hostedcheckouts - Create hosted checkout

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

createHostedCheckout

CreateHostedCheckoutResponse createHostedCheckout(CreateHostedCheckoutRequest body,
                                                  CallContext context)

Resource /v2/{merchantId}/hostedcheckouts - Create hosted checkout

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

getHostedCheckout

GetHostedCheckoutResponse getHostedCheckout(String hostedCheckoutId)

Resource /v2/{merchantId}/hostedcheckouts/{hostedCheckoutId} - Get hosted checkout status

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

getHostedCheckout

GetHostedCheckoutResponse getHostedCheckout(String hostedCheckoutId,
                                            CallContext context)

Resource /v2/{merchantId}/hostedcheckouts/{hostedCheckoutId} - Get hosted checkout status

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