com.global.api.paymentMethods.RecurringPaymentMethod 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.paymentMethods;

import com.global.api.builders.AuthorizationBuilder;
import com.global.api.entities.*;
import com.global.api.entities.enums.DccProcessor;
import com.global.api.entities.enums.DccRateType;
import com.global.api.entities.enums.PaymentMethodType;
import com.global.api.entities.enums.TransactionType;
import com.global.api.entities.exceptions.ApiException;
import com.global.api.services.RecurringService;
import lombok.Getter;
import lombok.Setter;

import java.math.BigDecimal;
import java.util.List;

public class RecurringPaymentMethod extends RecurringEntity implements  IPaymentMethod, IChargable, IAuthable, IVerifiable, IRefundable, ISecure3d  {
    private Address address;
    private String accountNumberLast4;
    private String commercialIndicator;
    private String customerKey;
    private String expirationDate;
    private String nameOnAccount;
    private IPaymentMethod paymentMethod;
    private String paymentType;
    private boolean preferredPayment;
    private String status;
    private String taxType;
    private ThreeDSecure threeDSecure;
    @Getter @Setter private StoredCredential storedCredential;
    @Getter @Setter private String token;

    public Address getAddress() {
        return address;
    }
    public void setAddress(Address address) {
        this.address = address;
    }
    public String getCommercialIndicator() {
        return commercialIndicator;
    }
    public void setCommercialIndicator(String commercialIndicator) {
        this.commercialIndicator = commercialIndicator;
    }
    public String getCustomerKey() {
        return customerKey;
    }
    public void setCustomerKey(String customerKey) {
        this.customerKey = customerKey;
    }
    public String getExpirationDate() {
        return expirationDate;
    }
    public void setExpirationDate(String expirationDate) {
        this.expirationDate = expirationDate;
    }
    public String getNameOnAccount() {
        return nameOnAccount;
    }
    public void setNameOnAccount(String nameOnAccount) {
        this.nameOnAccount = nameOnAccount;
    }
    public IPaymentMethod getPaymentMethod() {
        return paymentMethod;
    }
    public void setPaymentMethod(IPaymentMethod paymentMethod) throws ApiException {
        this.paymentMethod = paymentMethod;
    }
    public PaymentMethodType getPaymentMethodType() {
        return PaymentMethodType.Recurring;
    }
    public String getPaymentType() {
        return paymentType;
    }
    public void setPaymentType(String paymentType) {
        this.paymentType = paymentType;
    }
    public boolean isPreferredPayment() {
        return preferredPayment;
    }
    public void setPreferredPayment(boolean preferredPayment) {
        this.preferredPayment = preferredPayment;
    }
    public String getStatus() {
        return status;
    }
    public void setStatus(String status) {
        this.status = status;
    }
    public String getTaxType() {
        return taxType;
    }
    public void setTaxType(String taxType) {
        this.taxType = taxType;
    }
    public ThreeDSecure getThreeDSecure() {
        return threeDSecure;
    }
    public void setThreeDSecure(ThreeDSecure threeDSecure) {
        this.threeDSecure = threeDSecure;
    }
    public String getAccountNumberLast4() {
        return accountNumberLast4;
    }
    public void setAccountNumberLast4(String accountNumberLast4) {
        this.accountNumberLast4 = accountNumberLast4;
    }

    public RecurringPaymentMethod() {
        this(null, null);
    }
    public RecurringPaymentMethod(IPaymentMethod paymentMethod) {
        this.paymentMethod = paymentMethod;
    }
    public RecurringPaymentMethod(String customerKey, String paymentId) {
        this.customerKey = customerKey;
        this.key = paymentId;
        paymentType = "Credit Card";
    }

    public AuthorizationBuilder authorize() {
        return authorize(null);
    }
    public AuthorizationBuilder authorize(BigDecimal amount) {
        return authorize(amount, false);
    }
    public AuthorizationBuilder authorize(BigDecimal amount, boolean isEstimated) {
        return new AuthorizationBuilder(TransactionType.Auth, this)
                .withAmount(amount)
                .withOneTimePayment(true)
                .withAmountEstimated(isEstimated);
    }

    public AuthorizationBuilder charge() {
        return charge(null);
    }
    public AuthorizationBuilder charge(BigDecimal amount) {
        return charge(amount, false);
    }
    public AuthorizationBuilder charge(BigDecimal amount, boolean isEstimated) {
        return new AuthorizationBuilder(TransactionType.Sale, this)
                .withAmount(amount)
                .withAmountEstimated(isEstimated)
                .withOneTimePayment(true);
    }

    public AuthorizationBuilder getDccRate(DccRateType dccRateType, DccProcessor dccProcessor) {
        DccRateData dccRateData = new DccRateData();
        dccRateData.setDccRateType(dccRateType);
        dccRateData.setDccProcessor(dccProcessor);

        return new AuthorizationBuilder(TransactionType.DccRateLookup, this)
                .withDccRateData(dccRateData);
    }

    public AuthorizationBuilder refund() {
        return refund(null);
    }
    public AuthorizationBuilder refund(BigDecimal amount) {
        return new AuthorizationBuilder(TransactionType.Refund, this).withAmount(amount);
    }

    public AuthorizationBuilder verify() {
        return new AuthorizationBuilder(TransactionType.Verify, this);
    }

    public RecurringPaymentMethod create() throws ApiException {
        return create("default");
    }
    public RecurringPaymentMethod create(String configName) throws ApiException {
        return RecurringService.create(this, RecurringPaymentMethod.class, configName);
    }

    public void delete() throws ApiException {
        delete(false);
    }

    public void delete(boolean force) throws ApiException {
        delete(force, "default");
    }

    public void delete(boolean force, String configName) throws ApiException {
        try {
            RecurringService.delete(this, RecurringPaymentMethod.class, force, configName);
        } catch (ApiException e) {
            throw new ApiException("Failed to delete payment method, see inner exception for more details.", e);
        }
    }

    public static RecurringPaymentMethod find(String id) throws ApiException {
        return find(id, "default");
    }
    public static RecurringPaymentMethod find(String id, String configName) throws ApiException {
        checkSupportsRetrieval(configName);

        List response = RecurringService.search(RecurringPaymentMethodCollection.class)
                .addSearchCriteria("paymentMethodIdentifier", id)
                .execute();
        if(response.size() > 0) {
            RecurringPaymentMethod entity = response.get(0);
            if (entity != null)
                return RecurringService.get(entity.getKey(), RecurringPaymentMethod.class);
        }
        return null;
    }

    public static List findAll() throws ApiException {
        return findAll("default");
    }
    public static List findAll(String configName) throws ApiException {
        checkSupportsRetrieval(configName);
        return RecurringService.search(RecurringPaymentMethodCollection.class).execute();
    }

    public static RecurringPaymentMethod get(String key) throws ApiException {
        return get(key, "default");
    }
    public static RecurringPaymentMethod get(String key, String configName) throws ApiException {
        checkSupportsRetrieval(configName);
        return RecurringService.get(key, RecurringPaymentMethod.class);
    }

    public RecurringPaymentMethod saveChanges() throws ApiException {
        return saveChanges("default");
    }

    public RecurringPaymentMethod saveChanges(String configName) throws ApiException {
        try {
            return RecurringService.edit(this, RecurringPaymentMethod.class, configName);
        } catch (ApiException e) {
            throw new ApiException("Update failed, see inner exception for more details", e);
        }
    }

    public Schedule addSchedule(String scheduleId) {
        String paymentKey = key != null ? key : id;

        Schedule schedule = new Schedule(customerKey, paymentKey);
        schedule.setId(scheduleId);
        return schedule;
    }
}