com.truelayer.java.merchantaccounts.IMerchantAccountsHandler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of truelayer-java Show documentation

TrueLayer Java SDK for https://truelayer.com

There is a newer version: 16.0.0

package com.truelayer.java.merchantaccounts;

import com.truelayer.java.http.entities.ApiResponse;
import com.truelayer.java.http.entities.Headers;
import com.truelayer.java.merchantaccounts.entities.*;
import com.truelayer.java.merchantaccounts.entities.sweeping.SweepingSettings;
import java.util.concurrent.CompletableFuture;
import retrofit2.http.*;

public interface IMerchantAccountsHandler {

    CompletableFuture> listMerchantAccounts();

    CompletableFuture> getMerchantAccountById(String merchantAccountId);

    CompletableFuture> listTransactions(
            String merchantAccountId, ListTransactionsQuery query);

    /**
     * Overload meant to give clients created before December 2023 the ability to opt-in for paginated results at a request level via the
     * tl-enable-pagination HTTP header.

     * This is useful for clients that want to ease the migration towards paginated responses, it is not required once
     * the pagination opt-in is enabled at the client level.

     * See Enable pagination for more details.


     * Clients created after November 2023 can use the {@link #listTransactions(String, ListTransactionsQuery) simpler overload}.
     * @param headers map representing custom HTTP headers to be sent. In this case used to specify the {@link Headers#enablePagination enablePagination} flag
     * @param merchantAccountId the id of the merchant account
     * @param query the query to filter the transactions
     * @return a list of transactions matching the specified filters
     */
    CompletableFuture> listTransactions(
            Headers headers, String merchantAccountId, ListTransactionsQuery query);

    CompletableFuture> updateSweeping(
            String merchantAccountId, UpdateSweepingRequest updateSweepingRequest);

    CompletableFuture> updateSweeping(
            Headers headers, String merchantAccountId, UpdateSweepingRequest updateSweepingRequest);

    CompletableFuture> getSweepingSettings(String merchantAccountId);

    CompletableFuture> disableSweeping(String merchantAccountId);

    CompletableFuture> disableSweeping(Headers headers, String merchantAccountId);

    CompletableFuture> listPaymentSources(
            String merchantAccountId, ListPaymentSourcesQuery query);
}