com.truelayer.java.paymentsproviders.IPaymentsProvidersHandler Maven / Gradle / Ivy

Go to download
package com.truelayer.java.paymentsproviders;

import com.truelayer.java.http.entities.ApiResponse;
import com.truelayer.java.paymentsproviders.entities.PaymentsProvider;
import com.truelayer.java.paymentsproviders.entities.searchproviders.SearchPaymentProvidersRequest;
import com.truelayer.java.paymentsproviders.entities.searchproviders.SearchPaymentProvidersResponse;
import java.util.concurrent.CompletableFuture;

/**
 * Exposes all the payments providers related capabilities of the library.
 *
 * @see Payments Providers API reference
 */
public interface IPaymentsProvidersHandler {

    /**
     * Gets a payment provider resource by id.
     *
     * @param providerId the provider identifier
     * @return the response of the Get Payments Provider operation
     * @see Get Payment Provider API reference
     */
    CompletableFuture> getProvider(String providerId);

    /**
     * Returns a list of payments providers.
     *
     * @param request the request with filters to search providers
     * @return the response of the Search Payments Providers operation
     * @see Search Payment Providers API reference
     */
    CompletableFuture> searchProviders(
            SearchPaymentProvidersRequest request);
}