com.ingenico.direct.merchant.payouts.PayoutsClientInterface Maven / Gradle / Ivy
/*
* This class was auto-generated from the API references found at
* https://support.direct.ingenico.com/documentation/api/reference
*/
package com.ingenico.direct.merchant.payouts;
import com.ingenico.direct.ApiException;
import com.ingenico.direct.AuthorizationException;
import com.ingenico.direct.CallContext;
import com.ingenico.direct.DeclinedPayoutException;
import com.ingenico.direct.DirectException;
import com.ingenico.direct.IdempotenceException;
import com.ingenico.direct.ReferenceException;
import com.ingenico.direct.ValidationException;
import com.ingenico.direct.domain.CreatePayoutRequest;
import com.ingenico.direct.domain.PayoutResponse;
/**
* Payouts client. Thread-safe.
*/
public interface PayoutsClientInterface {
/**
* Resource /v2/{merchantId}/payouts
* - Create payout
*
* @throws DeclinedPayoutException if the Ingenico ePayments platform declined / rejected the payout. The payout result will be available from the exception.
* @throws ValidationException if the request was not correct and couldn't be processed (HTTP status code 400)
* @throws AuthorizationException if the request was not allowed (HTTP status code 403)
* @throws 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)
* @throws DirectException if something went wrong at the Ingenico ePayments platform,
* the Ingenico ePayments 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)
* @throws ApiException if the Ingenico ePayments platform returned any other error
*/
PayoutResponse createPayout(CreatePayoutRequest body);
/**
* Resource /v2/{merchantId}/payouts
* - Create payout
*
* @throws DeclinedPayoutException if the Ingenico ePayments platform declined / rejected the payout. The payout result will be available from the exception.
* @throws ValidationException if the request was not correct and couldn't be processed (HTTP status code 400)
* @throws AuthorizationException if the request was not allowed (HTTP status code 403)
* @throws IdempotenceException if an idempotent request caused a conflict (HTTP status code 409)
* @throws 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)
* @throws DirectException if something went wrong at the Ingenico ePayments platform,
* the Ingenico ePayments 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)
* @throws ApiException if the Ingenico ePayments platform returned any other error
*/
PayoutResponse createPayout(CreatePayoutRequest body, CallContext context);
/**
* Resource /v2/{merchantId}/payouts/{payoutId}
* - Get payout
*
* @throws ValidationException if the request was not correct and couldn't be processed (HTTP status code 400)
* @throws AuthorizationException if the request was not allowed (HTTP status code 403)
* @throws 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)
* @throws DirectException if something went wrong at the Ingenico ePayments platform,
* the Ingenico ePayments 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)
* @throws ApiException if the Ingenico ePayments platform returned any other error
*/
PayoutResponse getPayout(String payoutId);
/**
* Resource /v2/{merchantId}/payouts/{payoutId}
* - Get payout
*
* @throws ValidationException if the request was not correct and couldn't be processed (HTTP status code 400)
* @throws AuthorizationException if the request was not allowed (HTTP status code 403)
* @throws IdempotenceException if an idempotent request caused a conflict (HTTP status code 409)
* @throws 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)
* @throws DirectException if something went wrong at the Ingenico ePayments platform,
* the Ingenico ePayments 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)
* @throws ApiException if the Ingenico ePayments platform returned any other error
*/
PayoutResponse getPayout(String payoutId, CallContext context);
}