Package com.onlinepayments.merchant.mandates

Interface MandatesClientInterface

All Known Implementing Classes:
MandatesClient
public interface MandatesClientInterface
Mandates client. Thread-safe.

  • Method Details

    • createMandate

      CreateMandateResponse createMandate(CreateMandateRequest body)
      Resource /v2/{merchantId}/mandates - Create mandate
      Parameters:
      body - CreateMandateRequest
      Returns:
      CreateMandateResponse
      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

    • createMandate

      CreateMandateResponse createMandate(CreateMandateRequest body, CallContext context)
      Resource /v2/{merchantId}/mandates - Create mandate
      Parameters:
      body - CreateMandateRequest
      context - CallContext
      Returns:
      CreateMandateResponse
      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

    • getMandate

      GetMandateResponse getMandate(String uniqueMandateReference)
      Resource /v2/{merchantId}/mandates/{uniqueMandateReference} - Get mandate
      Parameters:
      uniqueMandateReference - String
      Returns:
      GetMandateResponse
      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

    • getMandate

      GetMandateResponse getMandate(String uniqueMandateReference, CallContext context)
      Resource /v2/{merchantId}/mandates/{uniqueMandateReference} - Get mandate
      Parameters:
      uniqueMandateReference - String
      context - CallContext
      Returns:
      GetMandateResponse
      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

    • blockMandate

      GetMandateResponse blockMandate(String uniqueMandateReference)
      Resource /v2/{merchantId}/mandates/{uniqueMandateReference}/block - Block mandate
      Parameters:
      uniqueMandateReference - String
      Returns:
      GetMandateResponse
      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

    • blockMandate

      GetMandateResponse blockMandate(String uniqueMandateReference, CallContext context)
      Resource /v2/{merchantId}/mandates/{uniqueMandateReference}/block - Block mandate
      Parameters:
      uniqueMandateReference - String
      context - CallContext
      Returns:
      GetMandateResponse
      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

    • unblockMandate

      GetMandateResponse unblockMandate(String uniqueMandateReference)
      Resource /v2/{merchantId}/mandates/{uniqueMandateReference}/unblock - Unblock mandate
      Parameters:
      uniqueMandateReference - String
      Returns:
      GetMandateResponse
      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

    • unblockMandate

      GetMandateResponse unblockMandate(String uniqueMandateReference, CallContext context)
      Resource /v2/{merchantId}/mandates/{uniqueMandateReference}/unblock - Unblock mandate
      Parameters:
      uniqueMandateReference - String
      context - CallContext
      Returns:
      GetMandateResponse
      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

    • revokeMandate

      GetMandateResponse revokeMandate(String uniqueMandateReference)
      Resource /v2/{merchantId}/mandates/{uniqueMandateReference}/revoke - Revoke mandate
      Parameters:
      uniqueMandateReference - String
      Returns:
      GetMandateResponse
      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

    • revokeMandate

      GetMandateResponse revokeMandate(String uniqueMandateReference, CallContext context)
      Resource /v2/{merchantId}/mandates/{uniqueMandateReference}/revoke - Revoke mandate
      Parameters:
      uniqueMandateReference - String
      context - CallContext
      Returns:
      GetMandateResponse
      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