com.global.api.builders.AuthorizationBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of globalpayments-sdk Show documentation
API for processing payments through Global Payments
There is a newer version: 14.2.3
package com.global.api.builders;

import com.global.api.ServicesContainer;
import com.global.api.entities.*;
import com.global.api.entities.billing.Bill;
import com.global.api.entities.enums.*;
import com.global.api.entities.exceptions.ApiException;
import com.global.api.entities.exceptions.BuilderException;
import com.global.api.entities.exceptions.MessageException;
import com.global.api.entities.exceptions.UnsupportedTransactionException;
import com.global.api.gateways.IOpenBankingProvider;
import com.global.api.gateways.IPaymentGateway;
import com.global.api.network.elements.EWICData;
import com.global.api.network.entities.*;
import com.global.api.network.entities.gnap.GnapRequestData;
import com.global.api.network.entities.nts.*;
import com.global.api.network.enums.CardIssuerEntryTag;
import com.global.api.network.enums.FeeType;
import com.global.api.paymentMethods.*;
import com.global.api.utils.StringUtils;
import lombok.Getter;
import lombok.Setter;
import lombok.var;

import java.math.BigDecimal;
import java.util.*;

public class AuthorizationBuilder extends TransactionBuilder {
    private static final String TAG_DATA_INVALID = "Please ensure that the Tag data is not empty or composed only of spaces.";
    private static final String EMPTY_MESSAGE = "";
    private static final String WEX_FALLBACK="FALLBACK";
    private AccountType accountType;
    private String alias;
    private AliasAction aliasAction;
    private boolean allowDuplicates;
    @Getter private boolean generateReceipt;
    @Getter private boolean isAvs;
    private boolean allowPartialAuth;
    private BigDecimal amount;
    private boolean amountEstimated;
    private BigDecimal authAmount;
    private AutoSubstantiation autoSubstantiation;
    private InquiryType balanceInquiryType;
    private Address billingAddress;
    @Getter @Setter
    private BlockedCardType cardTypesBlocking;
    private String cardBrandTransactionId;
    private String cardHolderLanguage;
    private BigDecimal cashBackAmount;
    private String clerkId;
    private String clientTransactionId;
    private BigDecimal convenienceAmount;
    private String currency;
    private String customerId;
    private Customer customerData;
    private ArrayList customData;
    private String customerIpAddress;
    private String cvn;
    private DccRateData dccRateData;
    private DecisionManager decisionManager;
    private String dynamicDescriptor;
    private EcommerceInfo ecommerceInfo;
    @Getter @Setter private EmvFallbackCondition emvFallbackCondition;
    private EmvChipCondition emvChipCondition;
    private EmvLastChipRead emvLastChipRead;
    private FraudFilterMode fraudFilterMode;
    @Getter @Setter private FraudRuleCollection fraudRules;
    private BigDecimal gratuity;
    private HostedPaymentData hostedPaymentData;
    @Getter@Setter private String gatewayTxnId;
    @Getter @Setter private String clientTxnId;

    @Getter @Setter private String idempotencyKey;
    private String invoiceNumber;
    private boolean level2Request;
    private LodgingData lodgingData;
    private String messageAuthenticationCode;
    private boolean multiCapture;
    private Integer estimatedNumberTransactions;
    private String offlineAuthCode;
    private boolean oneTimePayment;
    private String orderId;
    @Getter @Setter private String paymentApplicationVersion;
    @Getter @Setter private PaymentMethodUsageMode paymentMethodUsageMode;
    @Getter @Setter private PhoneNumber homePhone;
    @Getter @Setter private PhoneNumber workPhone;
    @Getter @Setter private PhoneNumber shippingPhone;
    @Getter @Setter private PhoneNumber mobilePhone;
    @Getter @Setter private RemittanceReferenceType remittanceReferenceType;
    @Getter @Setter private String remittanceReferenceValue;
    private String productId;
    private ArrayList miscProductData;
    private RecurringSequence recurringSequence;
    private RecurringType recurringType;
    private boolean requestMultiUseToken;
    private GiftCard replacementCard;
    private ReversalReasonCode reversalReasonCode;
    private String scheduleId;
    private Address shippingAddress;
    private BigDecimal shippingAmount;
    @Getter @Setter private BigDecimal shippingDiscount;
    @Getter @Setter private OrderDetails orderDetails;
    private StoredCredential storedCredential;
    private HashMap> supplementaryData;
    private BigDecimal surchargeAmount;
    @Getter @Setter private Boolean maskedDataResponse;
    @Getter
    private MerchantCategory merchantCategory;
    @Getter @Setter
    private CreditDebitIndicator creditDebitIndicator;
    private boolean hasEmvFallbackData;

    private String tagData;
    private String timestamp;
    private StoredCredentialInitiator transactionInitiator;
    @Getter @Setter private BNPLShippingMethod BNPLShippingMethod;
    private List bills;

    // network fields
    private BigDecimal feeAmount;
    private FeeType feeType;
    private String followOnTimestamp;
    private String shiftNumber;
    private String transportData;

    //Nts
    @Getter
    private NtsUtilityMessageRequest ntsUtilityMessageRequest;
    public AuthorizationBuilder withNtsUtilityMessageRequest(NtsUtilityMessageRequest value) {
        ntsUtilityMessageRequest = value;
        return this;
    }

    @Getter
    private NtsPDLData ntsPDLData;
    @Getter
    private EBTVoucherEntryData voucherEntryData;
    @Getter
    private NtsMailData ntsMailData;
    @Getter
    private NtsMailRequest ntsMailRequest;
    @Getter
    private String goodsSold;
    @Getter
    private EWICData ewicData;
    private String eWICIssuingEntity;
    @Getter
    private String checkCustomerId;
    @Getter
    private String rawMICRData;
    @Getter
    private POSSiteConfigurationData posSiteConfigurationData;
    @Getter
    private String country;

    @Getter
    private String paymentPurposeCode;

    @Getter
    private BigDecimal salesTaxAdditionAmount;

    @Getter @Setter
    private String categoryIndicator;

    public boolean requestUniqueToken;

    public AuthorizationBuilder withNtsProductData(NtsProductData ntsProductData) {
        this.ntsProductData = ntsProductData;
        return this;
    }
    public AuthorizationBuilder withEcommerceAuthIndicator(String ecommerceAuthIndicator) {
        this.ecommerceAuthIndicator = ecommerceAuthIndicator;
        return this;
    }
    public AuthorizationBuilder withEcommerceData1(String ecommerceData1) {
        this.ecommerceData1 = ecommerceData1;
        return  this;
    }

    public AuthorizationBuilder withEcommerceData2(String ecommerceData2) {
        this.ecommerceData2 = ecommerceData2;
        return this;
    }
    public AuthorizationBuilder withNtsMailData(NtsMailData value) {
        ntsMailData = value;
        return this;
    }
    public AuthorizationBuilder withPOSSiteConfigData(POSSiteConfigurationData value) {
        this.posSiteConfigurationData = value;
        return this;
    }

    public AuthorizationBuilder withTransactionDate(String value) {
        transactionDate = value;
        return this;
    }
    public AuthorizationBuilder withTransactionTime(String value) {
        transactionTime = value;
        return this;
    }

    public String getAlias() {
        return alias;
    }
    public AliasAction getAliasAction() {
        return aliasAction;
    }
    public boolean isAllowDuplicates() {
        return allowDuplicates;
    }
    public boolean isAllowPartialAuth() {
        return allowPartialAuth;
    }
    public BigDecimal getAmount() {
        return amount;
    }
    public boolean isAmountEstimated() {
        return amountEstimated;
    }
    public BigDecimal getAuthAmount() {
        return authAmount;
    }
    public AutoSubstantiation getAutoSubstantiation() {
        return autoSubstantiation;
    }
    public InquiryType getBalanceInquiryType() {
        return balanceInquiryType;
    }
    public Address getBillingAddress() {
        return billingAddress;
    }
    public List getBills() {
        return bills;
    }
    public String getCardBrandTransactionId( ) {
        return cardBrandTransactionId;
    }

    public BigDecimal getCashBackAmount() {
        return cashBackAmount;
    }

    public String getClerkId() {
        return clerkId;
    }
    public String getClientTransactionId() {
        return clientTransactionId;
    }
    public String getCurrency() {
        return currency;
    }
    public Customer getCustomer() {
        return getCustomerData();
    }
    public String getCustomerId() {
        return customerId;
    }
    public String getCustomerIpAddress() {
        return customerIpAddress;
    }
    public Customer getCustomerData() {
        return customerData;
    }
    public ArrayList getCustomData() {
        return customData;
    }
    public String getCvn() {
        return cvn;
    }
    public DccRateData getDccRateData() { return dccRateData; }
    public String getDescription() {
        return description;
    }
    public DecisionManager getDecisionManager() {
        return decisionManager;
    }
    public String getDynamicDescriptor() {
        return dynamicDescriptor;
    }
    public EcommerceInfo getEcommerceInfo() {
        return ecommerceInfo;
    }
    public FraudFilterMode getFraudFilterMode() {
        return fraudFilterMode;
    }
    public BigDecimal getGratuity() {
        return gratuity;
    }
    public HostedPaymentData getHostedPaymentData() {
        return hostedPaymentData;
    }
    public String getInvoiceNumber() {
        return invoiceNumber;
    }
    public boolean isLevel2Request() {
        return level2Request;
    }
    public LodgingData getLodgingData() {
        return lodgingData;
    }
    public String getOfflineAuthCode() {
        return offlineAuthCode;
    }
    public boolean isOneTimePayment() {
        return oneTimePayment;
    }
    public String getOrderId() {
        return orderId;
    }
    public String getProductId() {
        return productId;
    }
    public boolean isRequestMultiUseToken() {
        return requestMultiUseToken;
    }
    public RecurringSequence getRecurringSequence() { return recurringSequence; }
    public RecurringType getRecurringType() {
        return recurringType;
    }
    public GiftCard getReplacementCard() {
        return replacementCard;
    }
    public ReversalReasonCode getReversalReasonCode() {
        return reversalReasonCode;
    }
    public String getScheduleId() { return scheduleId; }
    public Address getShippingAddress() {
        return shippingAddress;
    }
    public StoredCredential getStoredCredential() {
        return storedCredential;
    }
    public BigDecimal getSurchargeAmount() { return surchargeAmount; }
    public String getTimestamp() {
        return timestamp;
    }
    public boolean hasEmvFallbackData() {
        return (emvFallbackCondition != null || emvChipCondition != null || !StringUtils.isNullOrEmpty(paymentApplicationVersion));
    }
    public BigDecimal getConvenienceAmount() {
        return convenienceAmount;
    }
    public BigDecimal getShippingAmount() {
        return shippingAmount;
    }
    public HashMap> getSupplementaryData() {
        return supplementaryData;
    }
    public AccountType getAccountType() {
        return accountType;
    }
    public EmvChipCondition getEmvChipCondition() {
        return emvChipCondition;
    }
    public EmvLastChipRead getEmvLastChipRead() {
        return emvLastChipRead;
    }
    public String getMessageAuthenticationCode() {
        return messageAuthenticationCode;
    }
    public boolean isMultiCapture() {
        return multiCapture;
    }
    public Integer getEstimatedNumberTransactions() {return estimatedNumberTransactions; }
    public String getPosSequenceNumber() {
        return super.getPosSequenceNumber();
    }
    public ArrayList getMiscProductData() {
        return miscProductData;
    }
    public String getTagData() {
        return tagData;
    }
    public StoredCredentialInitiator getTransactionInitiator() {
        return transactionInitiator;
    }

    // network getters
    public BigDecimal getFeeAmount() {
        return feeAmount;
    }
    public FeeType getFeeType() {
        return feeType;
    }
    public String getFollowOnTimestamp() { return followOnTimestamp; }
    public String getShiftNumber() {
        return shiftNumber;
    }
    public String getTransportData() {
        return transportData;
    }
    public String getCardHolderLanguage() { return cardHolderLanguage; }
    public AuthorizationBuilder withAccountType(AccountType value) {
        this.accountType = value;
        return this;
    }
    public AuthorizationBuilder withAddress(Address value) {
        return withAddress(value, AddressType.Billing);
    }
    public AuthorizationBuilder withAddress(Address value, AddressType type) {
        if(value != null) {
            value.setType(type);
            if (type == AddressType.Billing)
                this.billingAddress = value;
            else this.shippingAddress = value;
        }
        return this;
    }
    public AuthorizationBuilder withAlias(AliasAction action, String value) {
        this.alias = value;
        this.aliasAction = action;
        return this;
    }
    public AuthorizationBuilder withAllowDuplicates(boolean value) {
        this.allowDuplicates = value;
        return this;
    }
    public AuthorizationBuilder withGenerateReceipt(boolean value) {
        this.generateReceipt = value;
        return this;
    }
    public AuthorizationBuilder withAvs(boolean value) {
        this.isAvs = value;
        return this;
    }
    public AuthorizationBuilder withAllowPartialAuth(boolean value) {
        this.allowPartialAuth = value;
        return this;
    }
    public AuthorizationBuilder withAmount(BigDecimal value) {
        this.amount = value;
        return this;
    }
    public AuthorizationBuilder withAmount(double amount) {
        return withAmount(new BigDecimal(amount));
    }
    public AuthorizationBuilder withAmountEstimated(boolean value) {
        amountEstimated = value;
        return this;
    }
    public AuthorizationBuilder withAuthAmount(BigDecimal value) {
        this.authAmount = value;
        return this;
    }
    public AuthorizationBuilder withAutoSubstantiation(AutoSubstantiation value) {
        this.autoSubstantiation = value;
        return this;
    }
    public AuthorizationBuilder withBalanceInquiryType(InquiryType value) {
        this.balanceInquiryType = value;
        return this;
    }
    public AuthorizationBuilder withCardHolderLanguage(String value) {
        cardHolderLanguage = value;
        return this;
    }
    public AuthorizationBuilder withBills(Bill ... bills) {
        this.bills = Arrays.asList(bills);
        return this;
    }
    public AuthorizationBuilder withBills(List values) {
        this.bills = values;
        return this;
    }
    public AuthorizationBuilder withBlockedCardType(BlockedCardType cardTypesBlocking) throws BuilderException {
        if (cardTypesBlocking.areAllPropertiesSetToNull()) {
            throw new BuilderException("No properties set on the object");
        }
        this.cardTypesBlocking = cardTypesBlocking;

        return this;
    }
    public AuthorizationBuilder withCashBack(BigDecimal value) {
        this.cashBackAmount = value;
        this.transactionModifier = TransactionModifier.CashBack;
        return this;
    }
    public AuthorizationBuilder withSalesTaxAdditionAmount(BigDecimal value) {
        this.salesTaxAdditionAmount = value;
        return this;
    }

    public AuthorizationBuilder withChipCondition(EmvChipCondition value) {
        this.emvChipCondition = value;
        return this;
    }
    public AuthorizationBuilder withFallbackCondition(EmvFallbackCondition value) {
        this.emvFallbackCondition = value;
        return this;
    }
    public AuthorizationBuilder withLastChipRead(EmvLastChipRead value) {
        this.emvLastChipRead = value;
        return this;
    }
    public AuthorizationBuilder withClerkId(String value) {
        clerkId = value;
        return this;
    }
    public AuthorizationBuilder withClientTransactionId(String value) {
        if(transactionType.equals(TransactionType.Reversal)) {
            if(paymentMethod instanceof TransactionReference)
                ((TransactionReference)paymentMethod).setClientTransactionId(value);
            else {
                TransactionReference ref = new TransactionReference();
                ref.setClientTransactionId(value);
                if(this.paymentMethod != null) {
                    ref.setPaymentMethodType(this.paymentMethod.getPaymentMethodType());
                }

                this.paymentMethod = ref;
            }
        }
        else clientTransactionId = value;
        return this;
    }
    public AuthorizationBuilder withCommercialRequest(boolean value) {
        this.level2Request = value;
        return this;
    }
    public AuthorizationBuilder withGatewayTxnId(String id){
        this.gatewayTxnId = id;
        return this;
    }
    public AuthorizationBuilder withClientTxnId(String clientTxnId) {
        this.clientTxnId = clientTxnId;
        return this;
    }
    public AuthorizationBuilder withConvenienceAmt(BigDecimal value) {
        this.convenienceAmount = value;
        return this;
    }
    public AuthorizationBuilder withCurrency(String value) {
        this.currency = value;
        return this;
    }

    public AuthorizationBuilder withNtsNetworkMessageHeader(NtsNetworkMessageHeader value) {
        this.ntsNetworkMessageHeader = value;
        return this;
    }
    public AuthorizationBuilder withNtsRequestMessageHeader(NtsRequestMessageHeader value) {
        this.ntsRequestMessageHeader = value;
        return this;
    }
    public AuthorizationBuilder withCustomer(Customer value) {
        return withCustomerData(value);
    }
    public AuthorizationBuilder withCustomerId(String value) {
        this.customerId = value;
        return this;
    }
    public AuthorizationBuilder withCustomerIpAddress(String value) {
        this.customerIpAddress = value;
        return this;
    }
    public AuthorizationBuilder withCustomerData(Customer value) {
        this.customerData = value;
        return this;
    }
    public AuthorizationBuilder withCustomData(String... value) {
        if (this.customData == null) {
            customData = new ArrayList();
        }
        this.customData.add(value);
        return this;
    }
    public AuthorizationBuilder withCvn(String value) {
        this.cvn = value;
        return this;
    }

    public AuthorizationBuilder withCardSequenceNumber(String value) {
        this.cardSequenceNumber = value;
        return this;
    }

    public AuthorizationBuilder withVoucherEntryData(EBTVoucherEntryData voucherEntryData) {
        this.voucherEntryData = voucherEntryData;
        return this;
    }
    public AuthorizationBuilder withPDLData(NtsPDLData pdlData) {
        this.ntsPDLData = pdlData;
        return this;
    }
    public AuthorizationBuilder withDccRateData(DccRateData dccRateData) {
        this.dccRateData = dccRateData;
        return this;
    }
    public AuthorizationBuilder withDescription(String value) {
        this.description = value;
        return this;
    }
    public AuthorizationBuilder withDecisionManager(DecisionManager value) {
        this.decisionManager = value;
        return this;
    }
    public AuthorizationBuilder withDynamicDescriptor(String value) {
        this.dynamicDescriptor = value;
        return this;
    }
    public AuthorizationBuilder withEcommerceInfo(EcommerceInfo value) {
        this.ecommerceInfo = value;
        return this;
    }

    public AuthorizationBuilder withFraudFilter(FraudFilterMode fraudFilterMode) {
        return withFraudFilter(fraudFilterMode, null);
    }
    public AuthorizationBuilder withFraudFilter(FraudFilterMode fraudFilterMode, FraudRuleCollection fraudRules) {
        this.fraudFilterMode = fraudFilterMode;
        if(fraudRules != null) {
            this.fraudRules = fraudRules;
        }
        return this;
    }
    public AuthorizationBuilder withGratuity(BigDecimal value) {
        this.gratuity = value;
        return this;
    }
    public AuthorizationBuilder withHostedPaymentData(HostedPaymentData value) {
        this.hostedPaymentData = value;
        return this;
    }
    public AuthorizationBuilder withIdempotencyKey(String value) {
        this.idempotencyKey = value;
        return this;
    }
    public AuthorizationBuilder withInvoiceNumber(String value) {
        this.invoiceNumber = value;
        return this;
    }
    public AuthorizationBuilder withLodgingData(LodgingData value) {
        this.lodgingData = value;
        return this;
    }
    public AuthorizationBuilder withMessageAuthenticationCode(String value) {
        this.messageAuthenticationCode = value;
        return this;
    }
    public AuthorizationBuilder withMultiCapture(Boolean value) {
        this.multiCapture = value;
        this.estimatedNumberTransactions = null;
        return this;
    }
    public AuthorizationBuilder withMultiCapture(Boolean value, Integer estimatedNumberTransactions) {
        this.multiCapture = value;
        this.estimatedNumberTransactions = estimatedNumberTransactions;
        return this;
    }
    public AuthorizationBuilder withOfflineAuthCode(String value) {
        this.offlineAuthCode = value;
        this.transactionModifier = TransactionModifier.Offline;
        return this;
    }
    public AuthorizationBuilder withOneTimePayment(boolean value) {
        this.oneTimePayment = value;
        this.transactionModifier = TransactionModifier.Recurring;
        return this;
    }
    public AuthorizationBuilder withOrderId(String value) {
        this.orderId = value;
        return this;
    }
    public AuthorizationBuilder withPosSequenceNumber(String value) {
        super.setPosSequenceNumber(value);
        return this;
    }
    public AuthorizationBuilder withMiscProductData(ArrayList values) {
        this.miscProductData = values;
        return this;
    }
    public AuthorizationBuilder withProductData(ProductData value) {
        productData = value;
        return this;
    }
    public AuthorizationBuilder withProductId(String value) {
        this.productId = value;
        return this;
    }
    public AuthorizationBuilder withPaymentApplicationVersion(String value) {
        this.paymentApplicationVersion = value;
        return this;
    }
    public AuthorizationBuilder withPaymentMethodUsageMode(PaymentMethodUsageMode value) {
        this.paymentMethodUsageMode = value;
        return this;
    }
    public AuthorizationBuilder withPhoneNumber(String phoneCountryCode, String number, PhoneNumberType type) {
        var phoneNumber = new PhoneNumber();
        phoneNumber.setCountryCode(phoneCountryCode);
        phoneNumber.setNumber(number);

        switch (type) {
            case Home:
                this.homePhone = phoneNumber;
                break;
            case Work:
                this.workPhone = phoneNumber;
                break;
            case Shipping:
                this.shippingPhone = phoneNumber;
                break;
            case Mobile:
                this.mobilePhone = phoneNumber;
                break;
            default:
                break;
        }
        return this;
    }
    public AuthorizationBuilder withPaymentMethod(IPaymentMethod value) {
        this.paymentMethod = value;
        if (value instanceof EBTCardData && ((EBTCardData)value).getSerialNumber() != null)
            this.transactionModifier = TransactionModifier.Voucher;
        if (value instanceof CreditCardData && ((CreditCardData) value).getMobileType() != null)
            this.transactionModifier = TransactionModifier.EncryptedMobile;
        return this;
    }
    public AuthorizationBuilder withPriorMessageInformation(PriorMessageInformation value) {
        this.priorMessageInformation = value;
        return this;
    }
    public AuthorizationBuilder withRecurringInfo(RecurringType type, RecurringSequence sequence) {
        this.recurringType = type;
        this.recurringSequence = sequence;
        return this;
    }
    public AuthorizationBuilder withRequestMultiUseToken(boolean value) {
        this.requestMultiUseToken = value;
        return this;
    }
    public AuthorizationBuilder withRequestMultiUseToken(boolean requestMultiUseToken, boolean requestUniqueToken) {
        this.requestMultiUseToken = requestMultiUseToken;
        this.requestUniqueToken = requestUniqueToken;
        return this;
    }
    public AuthorizationBuilder withReplacementCard(GiftCard value) {
        this.replacementCard = value;
        return this;
    }
    public AuthorizationBuilder withReversalReasonCode(ReversalReasonCode value) {
        this.reversalReasonCode = value;
        return this;
    }
    public AuthorizationBuilder withTransactionId(String value) {
        if(paymentMethod instanceof TransactionReference) {
            ((TransactionReference)paymentMethod).setTransactionId(value);
        }
        else {
            TransactionReference ref = new TransactionReference();
            ref.setTransactionId(value);
            if(paymentMethod != null) {
                ref.setPaymentMethodType(paymentMethod.getPaymentMethodType());
            }

            this.paymentMethod = ref;
        }
        return this;
    }
    public AuthorizationBuilder withModifier(TransactionModifier value) {
        this.transactionModifier = value;
        return this;
    }
    public AuthorizationBuilder withScheduleId(String value) {
        this.scheduleId = value;
        return this;
    }
    public AuthorizationBuilder withShippingAmt(BigDecimal value) {
        this.shippingAmount = value;
        return this;
    }
    public AuthorizationBuilder withShippingDiscount(BigDecimal value) {
        this.shippingDiscount = value;
        return this;
    }
    public AuthorizationBuilder withOrderDetails(OrderDetails value) {
        this.orderDetails = value;
        return this;
    }
    public AuthorizationBuilder withSimulatedHostErrors(Host host, HostError... errors) {
        if(simulatedHostErrors == null) {
            simulatedHostErrors = new HashMap>();
        }

        if(!simulatedHostErrors.containsKey(host)) {
            simulatedHostErrors.put(host, new ArrayList());
        }
        for(HostError error: errors) {
            simulatedHostErrors.get(host).add(error);
        }
        return this;
    }
    public AuthorizationBuilder withStoredCredential(StoredCredential value) {
        this.storedCredential = value;
        return this;
    }
    public AuthorizationBuilder withSupplementaryData(String type, String... values) {
        // create the dictionary if needed
        if (supplementaryData == null) {
            supplementaryData = new HashMap>();
        }

        // add the type if needed
        if(!supplementaryData.containsKey(type)) {
            supplementaryData.put(type, new ArrayList());
        }

        // add the values to it
        supplementaryData.get(type).add(values);
        return this;
    }
    public AuthorizationBuilder withSurchargeAmount(BigDecimal value) {
        return withSurchargeAmount(value, null);
    }
    public AuthorizationBuilder withSurchargeAmount(BigDecimal value, CreditDebitIndicator creditDebitIndicator) {
        this.surchargeAmount = value;
        this.creditDebitIndicator = creditDebitIndicator;
        return this;
    }

    public AuthorizationBuilder withTimestamp(String value) {
        return withTimestamp(value, null);
    }
    public AuthorizationBuilder withTimestamp(String value, String followOn) {
        this.timestamp = value;
        this.followOnTimestamp = followOn;
        return this;
    }
    public AuthorizationBuilder withTagData(String value) throws ApiException {
        if(value != null){
            value = value.trim();
            if(value.equalsIgnoreCase(WEX_FALLBACK)){
                value = value.toUpperCase();
            }else if(value.equals(EMPTY_MESSAGE)){
                throw new ApiException(TAG_DATA_INVALID);
            }
            this.tagData = value;
        }
        return this;
    }

    // network with statements
    public AuthorizationBuilder withBatchNumber(int batchNumber) {
        return withBatchNumber(batchNumber, 0);
    }
    public AuthorizationBuilder withBatchNumber(int batchNumber, int sequenceNumber) {
        this.batchNumber = batchNumber;
        this.sequenceNumber = sequenceNumber;
        return this;
    }
    public AuthorizationBuilder withCardBrandStorage(StoredCredentialInitiator transactionInitiator) {
        return withCardBrandStorage(transactionInitiator, null);
    }
    public AuthorizationBuilder withCardBrandStorage(StoredCredentialInitiator transactionInitiator, String value) {
        return withCardBrandStorage(transactionInitiator,value,null);
    }
    public AuthorizationBuilder withCardBrandStorage(StoredCredentialInitiator transactionInitiator, String cardBrandTransactionId, String categoryIndicator) {
        this.transactionInitiator = transactionInitiator;
        this.cardBrandTransactionId = cardBrandTransactionId;
        this.categoryIndicator = categoryIndicator;
        return this;
    }
    public AuthorizationBuilder withCompanyId(String companyId) {
        this.companyId = companyId;
        return this;
    }
    public AuthorizationBuilder withFee(FeeType feeType, BigDecimal feeAmount) {
        this.feeType = feeType;
        this.feeAmount = feeAmount;

        return this;
    }
    public AuthorizationBuilder withFleetData(FleetData value) {
        fleetData = value;
        return this;
    }
    public AuthorizationBuilder withIssuerData(CardIssuerEntryTag tag, String value) {
        if(issuerData == null) {
            issuerData = new LinkedHashMap();
        }
        issuerData.put(tag, value);

        return this;
    }
    public AuthorizationBuilder withShiftNumber(String value) {
        shiftNumber = value;
        return this;
    }
    public AuthorizationBuilder withSystemTraceAuditNumber(int original) {
        return withSystemTraceAuditNumber(original, null);
    }
    public AuthorizationBuilder withSystemTraceAuditNumber(int original, Integer followOn) {
        systemTraceAuditNumber = original;
        followOnStan = followOn;
        return this;
    }
    public AuthorizationBuilder withTerminalError(boolean value) {
        terminalError = value;
        return this;
    }
    public AuthorizationBuilder withTransportData(String value) {
        transportData = value;
        return this;
    }
    public AuthorizationBuilder withTransactionMatchingData(TransactionMatchingData value) {
        transactionMatchingData = value;
        return this;
    }
    public AuthorizationBuilder withUniqueDeviceId(String value) {
        uniqueDeviceId = value;
        return this;
    }
    public AuthorizationBuilder withGnapRequestData(GnapRequestData gnapRequestData) {
        this.gnapRequestData = gnapRequestData;
        return this;
    }
    public AuthorizationBuilder withTaxAmount(BigDecimal taxAmount) {
        this.taxAmount = taxAmount;
        return this;
    }

    public AuthorizationBuilder withTipAmount(BigDecimal tipAmount) {
        this.tipAmount = tipAmount;
        return this;
    }

    public AuthorizationBuilder withPayByLinkData(PayByLinkData payByLinkData)
    {
        this.payByLinkData = payByLinkData;
        return this;
    }

    public AuthorizationBuilder withPaymentLinkId(String value) {
        paymentLinkId = value;
        return this;
    }

    public AuthorizationBuilder withRemittanceReference(RemittanceReferenceType remittanceReferenceType, String remittanceReferenceValue) {
        this.remittanceReferenceType = remittanceReferenceType;
        this.remittanceReferenceValue = remittanceReferenceValue;
        return this;
    }

    public AuthorizationBuilder withBNPLShippingMethod(BNPLShippingMethod value) throws UnsupportedTransactionException {
        if (!(paymentMethod instanceof BNPL)) {
            throw new UnsupportedTransactionException("The selected payment method doesn't support this property!");
        }

        BNPLShippingMethod = value;
        return this;
    }

    public AuthorizationBuilder withTransactiontype(TransactionType type) {
        transactionType = type;
        return this;
    }

    public AuthorizationBuilder withPaymentPurposeCode(String paymentPurposeCode) {
        this.paymentPurposeCode = paymentPurposeCode;
        return this;
    }

    public AuthorizationBuilder(TransactionType type) {
        this(type, null);
    }
    public AuthorizationBuilder(TransactionType type, IPaymentMethod paymentMethod) {
        super(type);
        withPaymentMethod(paymentMethod);
    }

    public Transaction execute(String configName) throws ApiException {
        super.execute(configName);

        IPaymentGateway client = ServicesContainer.getInstance().getGateway(configName);

        if (client.supportsOpenBanking() && paymentMethod instanceof BankPayment) {
            IOpenBankingProvider obClient = ServicesContainer.getInstance().getOpenBankingClient(configName);

            if (obClient != null) {
                return obClient.processOpenBanking(this);
            }
        }

        return client.processAuthorization(this);
    }

    public String serialize() throws ApiException {
        return serialize("default");
    }
    public String serialize(String configName) throws ApiException {
        transactionModifier = TransactionModifier.HostedRequest;
        super.execute(configName);

        IPaymentGateway client = ServicesContainer.getInstance().getGateway(configName);
        if(client.supportsHostedPayments())
            return client.serializeRequest(this);
        throw new UnsupportedTransactionException("Your current gateway does not support hosted payments.");
    }

    @Override
    public void setupValidations() {
        this.validations.of(EnumSet.of(TransactionType.Auth, TransactionType.Sale, TransactionType.Refund, TransactionType.AddValue))
                .with(TransactionModifier.None)
                .check("amount").isNotNull()
                .check("currency").isNotNull()
                .check("paymentMethod").isNotNull();

        this.validations.of(EnumSet.of(TransactionType.Auth, TransactionType.Sale))
                .with(TransactionModifier.HostedRequest)
                .check("amount").isNotNull()
                .check("currency").isNotNull();

        this.validations.of(TransactionType.Verify)
                .with(TransactionModifier.HostedRequest)
                .check("currency").isNotNull();

        this.validations.of(EnumSet.of(TransactionType.Auth, TransactionType.Sale))
                .with(TransactionModifier.Offline)
                .check("amount").isNotNull()
                .check("currency").isNotNull()
                .check("offlineAuthCode").isNotNull();

        this.validations.of(TransactionType.BenefitWithdrawal)
                .with(TransactionModifier.CashBack)
                .check("amount").isNotNull()
                .check("currency").isNotNull()
                .check("paymentMethod").isNotNull();

        this.validations.of(TransactionType.Balance).check("paymentMethod").isNotNull();

        this.validations.of(TransactionType.Alias)
                .check("aliasAction").isNotNull()
                .check("alias").isNotNull();

        this.validations.of(TransactionType.Replace).check("replacementCard").isNotNull();

        if((transactionType != TransactionType.CheckQueryInfo
                && paymentMethod != null
                && paymentMethod.getPaymentMethodType() == PaymentMethodType.ACH)){
        this.validations.of(PaymentMethodType.ACH).check("billingAddress").isNotNull();
        }
        this.validations.of(PaymentMethodType.Debit)
                .when("reversalReasonCode").isNotNull()
                .check("transactionType").isEqualTo(TransactionType.Reversal);

        this.validations.of(EnumSet.of(PaymentMethodType.Debit, PaymentMethodType.Credit))
                .when("emvChipCondition").isNotNull().check("tagData").isNull();
        this.validations.of(EnumSet.of(PaymentMethodType.Debit, PaymentMethodType.Credit))
                .when("tagData").isNotNull().check("emvChipCondition").isNull();
        this.validations.of(EnumSet.of(TransactionType.Auth, TransactionType.Sale))
                .with(TransactionModifier.EncryptedMobile).check("paymentMethod").isNotNull();

        this.validations.of(TransactionType.DccRateLookup)
                .check("dccRateData").isNotNull();

        this.validations.of(TransactionType.Tokenize)
                .check("paymentMethod").isNotNull()
                .check("paymentMethod").isInstanceOf(ITokenizable.class);

        this.validations.of(PaymentMethodType.Credit)
                .with(TransactionType.LoadReversal)
                .check("paymentMethod").propertyOf(Credit.class, "cardType").isEqualTo("VisaReadyLink");

        this.validations.of(TransactionType.Sale)
                .with(TransactionModifier.AlternativePaymentMethod)
                .check("paymentMethod").isNotNull()
                .check("amount").isNotNull()
                .check("currency").isNotNull()
                .check("paymentMethod").propertyOf(String.class, "statusUpdateUrl").isNotNull()
                .check("paymentMethod").propertyOf(String.class, "accountHolderName").isNotNull()
                .check("paymentMethod").propertyOf(String.class, "returnUrl").isNotNull();

        this.validations.of(TransactionType.Auth)
                .with(TransactionModifier.AlternativePaymentMethod)
                .check("paymentMethod").isNotNull()
                .check("amount").isNotNull()
                .check("currency").isNotNull()
                .check("paymentMethod").propertyOf(String.class, "statusUpdateUrl").isNotNull()
                .check("paymentMethod").propertyOf(String.class, "accountHolderName").isNotNull()
                .check("paymentMethod").propertyOf(String.class, "returnUrl").isNotNull();
    }


    public AuthorizationBuilder withEmvMaxPinEntry(String emvMaxPinEntry){
        this.emvMaxPinEntry = emvMaxPinEntry;
        return this;
    }

    public AuthorizationBuilder withNtsTag16(NtsTag16 tag){
        this.ntsTag16 = tag;
        return this;
    }

    public AuthorizationBuilder withServiceCode(String serviceCode) {
        this.serviceCode = serviceCode;
        return this;
    }

    public AuthorizationBuilder withGoodsSold(String goodsSold) {
        this.goodsSold = goodsSold;
        return this;
    }
    public AuthorizationBuilder withCheckCustomerId(String checkCustomerId) {
        this.checkCustomerId = checkCustomerId;
        return this;
    }
    public AuthorizationBuilder withRawMICRData(String rawMICRData) {
        this.rawMICRData = rawMICRData;
        return this;
    }
    public  AuthorizationBuilder withEWICData(EWICData ewicData){
        this.ewicData=ewicData;
        return this;
    }
    public EWICData getEwicData(){
        return ewicData;
    }
    public AuthorizationBuilder WithEWICIssuingEntity(String eWICIssuingEntity) {
        this.eWICIssuingEntity = eWICIssuingEntity;
        return this;
    }
    public AuthorizationBuilder withCountry(String country) {
        this.country = country;
        return this;
    }

    public AuthorizationBuilder withMaskedDataResponse(Boolean value) {
        this.maskedDataResponse = value;
        return this;
    }

    public AuthorizationBuilder withMerchantCategory(MerchantCategory merchantCategory) {
        this.merchantCategory = merchantCategory;
        return this;
    }

    public AuthorizationBuilder withMasterCardIndicator(MasterCardCITMITIndicator citMitIndicator) {
        this.citMitIndicator = citMitIndicator;
        return this;
    }
}