Package com.onlinepayments.merchant.paymentlinks

Interface PaymentLinksClientInterface

All Known Implementing Classes:
PaymentLinksClient
public interface PaymentLinksClientInterface
PaymentLinks client. Thread-safe.

  • Method Details

    • createPaymentLink

      PaymentLinkResponse createPaymentLink(CreatePaymentLinkRequest body)
      Resource /v2/{merchantId}/paymentlinks - Create payment link
      Parameters:
      body - CreatePaymentLinkRequest
      Returns:
      PaymentLinkResponse
      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

    • createPaymentLink

      PaymentLinkResponse createPaymentLink(CreatePaymentLinkRequest body, CallContext context)
      Resource /v2/{merchantId}/paymentlinks - Create payment link
      Parameters:
      body - CreatePaymentLinkRequest
      context - CallContext
      Returns:
      PaymentLinkResponse
      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

    • getPaymentLinkById

      PaymentLinkResponse getPaymentLinkById(String paymentLinkId)
      Resource /v2/{merchantId}/paymentlinks/{paymentLinkId} - Get payment link by ID
      Parameters:
      paymentLinkId - String
      Returns:
      PaymentLinkResponse
      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

    • getPaymentLinkById

      PaymentLinkResponse getPaymentLinkById(String paymentLinkId, CallContext context)
      Resource /v2/{merchantId}/paymentlinks/{paymentLinkId} - Get payment link by ID
      Parameters:
      paymentLinkId - String
      context - CallContext
      Returns:
      PaymentLinkResponse
      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

    • cancelPaymentLinkById

      void cancelPaymentLinkById(String paymentLinkId)
      Resource /v2/{merchantId}/paymentlinks/{paymentLinkId}/cancel - Cancel PaymentLink by ID
      Parameters:
      paymentLinkId - String
      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

    • cancelPaymentLinkById

      void cancelPaymentLinkById(String paymentLinkId, CallContext context)
      Resource /v2/{merchantId}/paymentlinks/{paymentLinkId}/cancel - Cancel PaymentLink by ID
      Parameters:
      paymentLinkId - String
      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