Package com.onlinepayments.merchant.webhooks

Interface WebhooksClientInterface

All Known Implementing Classes:
WebhooksClient
public interface WebhooksClientInterface
Webhooks client. Thread-safe.

  • Method Details

    • validateWebhookCredentials

      ValidateCredentialsResponse validateWebhookCredentials(ValidateCredentialsRequest body)
      Resource /v2/{merchantId}/webhooks/validateCredentials - Validate credentials
      Parameters:
      body - ValidateCredentialsRequest
      Returns:
      ValidateCredentialsResponse
      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)
      PlatformException - 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

    • validateWebhookCredentials

      ValidateCredentialsResponse validateWebhookCredentials(ValidateCredentialsRequest body, CallContext context)
      Resource /v2/{merchantId}/webhooks/validateCredentials - Validate credentials
      Parameters:
      body - ValidateCredentialsRequest
      context - CallContext
      Returns:
      ValidateCredentialsResponse
      Throws:
      IdempotenceException - if an idempotent request caused a conflict (HTTP status code 409)
      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)
      PlatformException - 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

    • sendTestWebhook

      void sendTestWebhook(SendTestRequest body)
      Resource /v2/{merchantId}/webhooks/sendtest - Send test
      Parameters:
      body - SendTestRequest
      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)
      PlatformException - 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

    • sendTestWebhook

      void sendTestWebhook(SendTestRequest body, CallContext context)
      Resource /v2/{merchantId}/webhooks/sendtest - Send test
      Parameters:
      body - SendTestRequest
      context - CallContext
      Throws:
      IdempotenceException - if an idempotent request caused a conflict (HTTP status code 409)
      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)
      PlatformException - 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