one.credify.sdk.BnplService Maven / Gradle / Ivy

Go to download
package one.credify.sdk;

import one.credify.sdk.dto.*;

import java.io.IOException;
import java.util.List;

public interface BnplService {
    /**
     * Create a Bnpl order
     *
     * @param referenceId      Id of the order
     * @param totalAmount      Total amount of the order
     * @param orderLines       Order's orderlines
     * @param paymentRecipient The bank account's information of the payment recipient
     * @return order object
     */
    @Deprecated
    OrderInfo createOrder(String referenceId, FiatCurrency totalAmount, List orderLines, PaymentRecipient paymentRecipient) throws IOException;

    /**
     * Gets order's information
     *
     * @param orderId Id of the Order
     * @return order object
     */
    OrderInfo getOrder(String orderId) throws IOException;

    /**
     * Acknowledge the bnpl order
     *
     * @param orderId  Id of the order
     * @param language language header
     * @param req      Acknowledge order request body
     */
    void acknowledgeOrder(String orderId, String language, AcknowledgeOrderRequest req) throws Exception;

    /**
     * Accept the bnpl order
     *
     * @param orderId  Id of the order
     * @param language language header
     * @param req      Accept order request body
     */
    void acceptOrder(String orderId, String language, AcceptOrderRequest req) throws Exception;

    /**
     * Complete the bnpl order
     *
     * @param orderId  Id of the Order
     * @param language language header
     * @param req      Complete order request body
     */
    void completeOrder(String orderId, String language, CompleteOrderRequest req) throws Exception;

    /**
     * Approve the bnpl order
     *
     * @param orderId  Id of the Order
     * @param language language header
     * @param req      Approve order request body
     */
    void approveOrder(String orderId, String language, ApproveOrderRequest req) throws Exception;

    /**
     * Cancel the bnpl order
     *
     * @param orderId  Id of the order
     * @param language language header
     * @param req      Cancel order request body
     */
    void cancelOrder(String orderId, String language, CancelOrderRequest req) throws Exception;

    /**
     * Get Order documents list
     *
     * @param orderId Id of the order
     * @return GetOrderDocumentsResponse
     */
    GetOrderDocumentsResponse getOrderDocuments(String orderId) throws IOException;
}