com.truelayer.java.commonapi.ICommonApi 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.commonapi;

import com.truelayer.java.commonapi.entities.SubmitPaymentsProviderReturnRequest;
import com.truelayer.java.commonapi.entities.SubmitPaymentsProviderReturnResponse;
import com.truelayer.java.http.entities.ApiResponse;
import java.util.Map;
import java.util.concurrent.CompletableFuture;
import retrofit2.http.Body;
import retrofit2.http.HeaderMap;
import retrofit2.http.POST;

/**
 * Exposes all the general purpose capabilities of the library.
 *
 * @see General purpose API reference
 */
public interface ICommonApi {

    /**
     * Submits payments return parameters.
     * @param headers map representing custom HTTP headers to be sent
     * @param request a submit payment return parameters payload
     * @return the response of the Submit payment returns parameters operation
     * @see Submit payments return parameters API reference
     */
    @POST("/payments-provider-return")
    CompletableFuture> submitPaymentReturnParameters(
            @HeaderMap Map headers, @Body SubmitPaymentsProviderReturnRequest request);
}