com.cardpay.sdk.model.ScheduledByMerchantData Maven / Gradle / Ivy
/*
* CardPay REST API
* Welcome to the CardPay REST API. The CardPay API uses HTTP verbs and a [REST](https://en.wikipedia.org/wiki/Representational_state_transfer) resources endpoint structure (see more info about REST). Request and response payloads are formatted as JSON. Merchant uses API to create payments, refunds, payouts or recurrings, check or update transaction status and get information about created transactions. In API authentication process based on [OAuth 2.0](https://oauth.net/2/) standard. For recent changes see changelog section.
*
* OpenAPI spec version: 3.0
*
*
* NOTE: This class is auto generated by the swagger code generator program.
* https://github.com/swagger-api/swagger-codegen.git
* Do not edit the class manually.
*/
package com.cardpay.sdk.model;
import com.google.gson.TypeAdapter;
import com.google.gson.annotations.JsonAdapter;
import com.google.gson.annotations.SerializedName;
import com.google.gson.stream.JsonReader;
import com.google.gson.stream.JsonWriter;
import java.io.IOException;
import java.math.BigDecimal;
import lombok.Data;
@Data
public class ScheduledByMerchantData {
@SerializedName("amount")
private BigDecimal amount = null;
@SerializedName("contract_number")
private String contractNumber = null;
@SerializedName("currency")
private String currency = null;
@SerializedName("dynamic_descriptor")
private String dynamicDescriptor = null;
@SerializedName("filing")
private RecurringResponseFiling filing = null;
@SerializedName("generate_token")
private Boolean generateToken = null;
@SerializedName("initiator")
private String initiator = null;
@SerializedName("network_trans_id")
private String networkTransId = null;
@SerializedName("note")
private String note = null;
@SerializedName("scheduled_type")
private String scheduledType = null;
@SerializedName("three_ds_challenge_indicator")
private String threeDsChallengeIndicator = null;
/**
* Gets or Sets transType
*/
@JsonAdapter(TransTypeEnum.Adapter.class)
public enum TransTypeEnum {
_01("01"),
_03("03"),
_10("10"),
_11("11"),
_28("28");
private String value;
TransTypeEnum(String value) {
this.value = value;
}
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
public static TransTypeEnum fromValue(String text) {
for (TransTypeEnum b : TransTypeEnum.values()) {
if (String.valueOf(b.value).equals(text)) {
return b;
}
}
return null;
}
public static class Adapter extends TypeAdapter {
@Override
public void write(final JsonWriter jsonWriter, final TransTypeEnum enumeration) throws IOException {
jsonWriter.value(enumeration.getValue());
}
@Override
public TransTypeEnum read(final JsonReader jsonReader) throws IOException {
String value = jsonReader.nextString();
return TransTypeEnum.fromValue(String.valueOf(value));
}
}
}
@SerializedName("trans_type")
private TransTypeEnum transType = null;
public void setAmount(BigDecimal amount) {
this.amount = amount;
}
/**
* @param amount The amount of scheduled payment to be charged
* @return bean instance
**/
public ScheduledByMerchantData amount(BigDecimal amount) {
this.amount = amount;
return this;
}
public void setContractNumber(String contractNumber) {
this.contractNumber = contractNumber;
}
/**
* @param contractNumber Contract number between customer and merchant. Required for Mexican merchants for scheduled payments.
* @return bean instance
**/
public ScheduledByMerchantData contractNumber(String contractNumber) {
this.contractNumber = contractNumber;
return this;
}
public void setCurrency(String currency) {
this.currency = currency;
}
/**
* @param currency [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code
* @return bean instance
**/
public ScheduledByMerchantData currency(String currency) {
this.currency = currency;
return this;
}
public void setDynamicDescriptor(String dynamicDescriptor) {
this.dynamicDescriptor = dynamicDescriptor;
}
/**
* @param dynamicDescriptor Short description of the service or product, must be enabled by CardPay manager to be used.
* @return bean instance
**/
public ScheduledByMerchantData dynamicDescriptor(String dynamicDescriptor) {
this.dynamicDescriptor = dynamicDescriptor;
return this;
}
public void setFiling(RecurringResponseFiling filing) {
this.filing = filing;
}
/**
* @param filing Card filing data
* @return bean instance
**/
public ScheduledByMerchantData filing(RecurringResponseFiling filing) {
this.filing = filing;
return this;
}
public void setGenerateToken(Boolean generateToken) {
this.generateToken = generateToken;
}
/**
* @param generateToken This attribute can be received only in first recurring request. In all requests with recurring_id card.token can't be generated. If set to 'true', Card token will be generated and returned in GET response. Will be generated only for successful transactions (not for declined).
* @return bean instance
**/
public ScheduledByMerchantData generateToken(Boolean generateToken) {
this.generateToken = generateToken;
return this;
}
public void setInitiator(String initiator) {
this.initiator = initiator;
}
/**
* @param initiator Use `cit` for initiator attribute for cardholder initiated transactions (first scheduled payment by merchant transactions) Use `mit` for initiator attribute for merchant initiated transactions (continue scheduled payment by merchant transactions)
* @return bean instance
**/
public ScheduledByMerchantData initiator(String initiator) {
this.initiator = initiator;
return this;
}
public void setNetworkTransId(String networkTransId) {
this.networkTransId = networkTransId;
}
/**
* @param networkTransId Network Reference Number of original transaction
* @return bean instance
**/
public ScheduledByMerchantData networkTransId(String networkTransId) {
this.networkTransId = networkTransId;
return this;
}
public void setNote(String note) {
this.note = note;
}
/**
* @param note Note about the recurring that will not be displayed to customer.
* @return bean instance
**/
public ScheduledByMerchantData note(String note) {
this.note = note;
return this;
}
public void setScheduledType(String scheduledType) {
this.scheduledType = scheduledType;
}
/**
* @param scheduledType Scheduled payment type attribute. For scheduled payments by merchant value should be `SM` - scheduled by merchant
* @return bean instance
**/
public ScheduledByMerchantData scheduledType(String scheduledType) {
this.scheduledType = scheduledType;
return this;
}
public void setThreeDsChallengeIndicator(String threeDsChallengeIndicator) {
this.threeDsChallengeIndicator = threeDsChallengeIndicator;
}
/**
* @param threeDsChallengeIndicator threeDsChallengeIndicator
* @return bean instance
**/
public ScheduledByMerchantData threeDsChallengeIndicator(String threeDsChallengeIndicator) {
this.threeDsChallengeIndicator = threeDsChallengeIndicator;
return this;
}
public void setTransType(TransTypeEnum transType) {
this.transType = transType;
}
/**
* @param transType transType
* @return bean instance
**/
public ScheduledByMerchantData transType(TransTypeEnum transType) {
this.transType = transType;
return this;
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("ScheduledByMerchantData( ");
if (amount != null) sb.append("amount=").append(amount.toString()).append("; ");
if (contractNumber != null) sb.append("contractNumber=").append(contractNumber.toString()).append("; ");
if (currency != null) sb.append("currency=").append(currency.toString()).append("; ");
if (dynamicDescriptor != null) sb.append("dynamicDescriptor=").append(dynamicDescriptor.toString()).append("; ");
if (filing != null) sb.append("filing=").append(filing.toString()).append("; ");
if (generateToken != null) sb.append("generateToken=").append(generateToken.toString()).append("; ");
if (initiator != null) sb.append("initiator=").append(initiator.toString()).append("; ");
if (networkTransId != null) sb.append("networkTransId=").append(networkTransId.toString()).append("; ");
if (note != null) sb.append("note=").append(note.toString()).append("; ");
if (scheduledType != null) sb.append("scheduledType=").append(scheduledType.toString()).append("; ");
if (threeDsChallengeIndicator != null) sb.append("threeDsChallengeIndicator=").append(threeDsChallengeIndicator.toString()).append("; ");
if (transType != null) sb.append("transType=").append(transType.toString()).append("; ");
sb.append(")");
return sb.toString();
}
}