com.clover.remote.client.messages.VoidPaymentRequest Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of remote-pay-java-connector Show documentation

Clover Connector Java library

There is a newer version: 1.4.1

Show newest version

/*
 * Copyright (C) 2016 Clover Network, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 *
 * You may obtain a copy of the License at
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.clover.remote.client.messages;

/**
 * Request object for requesting to void a payment
 */
@SuppressWarnings(value="unused")
public class VoidPaymentRequest extends BaseRequest {
  private String paymentId;
  private String voidReason;

  private String employeeId;//optional TODO: Revisit
  private String orderId; //optional TODO: Revisit

  /**
   * Get the field value
   *
   * @return The unique identifier of the associated payment
   */
  public String getPaymentId() {
    return paymentId;
  }

  /**
   * Set the field value
   *
   * @param paymentId The unique identifier of the associated payment
   */
  public void setPaymentId(String paymentId) {
    this.paymentId = paymentId;
  }

  /**
   * Get the field value
   *
   * @return Reason for void
   */
  public String getVoidReason() {
    return voidReason;
  }

  /**
   * Set the field value
   *
   * @param voidReason Reason for void
   */
  public void setVoidReason(String voidReason) {
    this.voidReason = voidReason;
  }

  /**
   * Get the field value
   *
   * @return The id of the employee requesting the void
   */
  public String getEmployeeId() {
    return employeeId;
  }

  /**
   * Set the field value
   *
   * @param employeeId The id of the employee requesting the void
   */
  public void setEmployeeId(String employeeId) {
    this.employeeId = employeeId;
  }

  /**
   * Get the field value
   *
   * @return The unique identifier of the associated order
   */
  public String getOrderId() {
    return orderId;
  }

  /**
   * Set the field value
   *
   * @param orderId The unique identifier of the associated order
   */
  public void setOrderId(String orderId) {
    this.orderId = orderId;
  }
}