Package com.onlinepayments.merchant.refunds

Interface RefundsClientInterface

All Known Implementing Classes:
RefundsClient
public interface RefundsClientInterface
Refunds client. Thread-safe.

  • Method Summary

    Modifier and Type
    Method
    Description
    RefundsResponse
    getRefunds(String paymentId)
    Resource /v2/{merchantId}/payments/{paymentId}/refunds - Get refunds of payment
    RefundsResponse
    getRefunds(String paymentId, CallContext context)
    Resource /v2/{merchantId}/payments/{paymentId}/refunds - Get refunds of payment

  • Method Details

    • getRefunds

      RefundsResponse getRefunds(String paymentId)
      Resource /v2/{merchantId}/payments/{paymentId}/refunds - Get refunds of payment
      Parameters:
      paymentId - String
      Returns:
      RefundsResponse
      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

    • getRefunds

      RefundsResponse getRefunds(String paymentId, CallContext context)
      Resource /v2/{merchantId}/payments/{paymentId}/refunds - Get refunds of payment
      Parameters:
      paymentId - String
      context - CallContext
      Returns:
      RefundsResponse
      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