Package com.onlinepayments.merchant.payouts

Interface PayoutsClientInterface

All Known Implementing Classes:
PayoutsClient
public interface PayoutsClientInterface
Payouts client. Thread-safe.

  • Method Details

    • getPayout

      PayoutResponse getPayout(String payoutId)
      Resource /v2/{merchantId}/payouts/{payoutId} - Get payout
      Parameters:
      payoutId - String
      Returns:
      PayoutResponse
      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

    • getPayout

      PayoutResponse getPayout(String payoutId, CallContext context)
      Resource /v2/{merchantId}/payouts/{payoutId} - Get payout
      Parameters:
      payoutId - String
      context - CallContext
      Returns:
      PayoutResponse
      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

    • createPayout

      PayoutResponse createPayout(CreatePayoutRequest body)
      Resource /v2/{merchantId}/payouts - Create payout
      Parameters:
      body - CreatePayoutRequest
      Returns:
      PayoutResponse
      Throws:
      DeclinedPayoutException - if the payment platform declined / rejected the payout. The payout result will be available from the exception.
      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

    • createPayout

      PayoutResponse createPayout(CreatePayoutRequest body, CallContext context)
      Resource /v2/{merchantId}/payouts - Create payout
      Parameters:
      body - CreatePayoutRequest
      context - CallContext
      Returns:
      PayoutResponse
      Throws:
      DeclinedPayoutException - if the payment platform declined / rejected the payout. The payout result will be available from the exception.
      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