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

Go to download
package one.credify.sdk;

import one.credify.sdk.dto.*;
import one.credify.sdk.enumeration.OnboardingReasonCode;
import one.credify.sdk.enumeration.OnboardingStatus;

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

public interface OfferService {

    /**
     * Updates a status of an offer transaction
     *
     * @param transactionId     - ID of offer approval
     * @param status            - To which status you will update. (PENDING, CANCELED, ACKNOWLEDGED, FAILED, ACCEPTED, COMPLETED)
     * @param transactionAmount - Optional. Premium value in the case of insurance without VAT
     * @param vat               - Optional. value associated with this transaction
     * @param referenceId       - Optional. Reference ID generated inside the service provider
     * @param description       - Optional.
     * @param code              - Optional. reason cod, it is used when you update the status = CANCELED.
     *                          (CONVERSION_FAILURE, INCORRECT_DATA, DUPLICATED_TRANSACTION, EXISTING_USER, DISQUALIFIED_USER, MALICIOUS_USER, OTHER)
     * @return boolean
     */
    boolean updateStatus(UUID transactionId, OnboardingStatus status, FiatCurrency transactionAmount, FiatCurrency vat,
                         String referenceId, String description, OnboardingReasonCode code) throws IOException;

    /**
     * Get offer detail by offer code
     * @param offerCode - Offer code
     */
    Offer getOfferDetail(String offerCode) throws IOException;

}