com.ingenico.connect.gateway.sdk.java.merchant.refunds.FindRefundsParams Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of connect-sdk-java Show documentation

SDK to communicate with the Ingenico ePayments platform using the Ingenico Connect Server API

There is a newer version: 6.47.0

/*
 * This class was auto-generated from the API references found at
 * https://epayments-api.developer-ingenico.com/s2sapi/v1/
 */

package com.ingenico.connect.gateway.sdk.java.merchant.refunds;

import java.util.LinkedList;
import java.util.List;

import com.ingenico.connect.gateway.sdk.java.ParamRequest;
import com.ingenico.connect.gateway.sdk.java.RequestParam;

/**
 * Query parameters for
 * Find refunds
 */
public class FindRefundsParams implements ParamRequest {

	private String hostedCheckoutId;

	private String merchantReference;

	private Long merchantOrderId;

	private Integer offset;

	private Integer limit;

	/**
	 * Your hosted checkout identifier to filter on.
	 */
	public String getHostedCheckoutId() {
		return hostedCheckoutId;
	}

	/**
	 * Your hosted checkout identifier to filter on.
	 */
	public void setHostedCheckoutId(String value) {
		this.hostedCheckoutId = value;
	}

	/**
	 * Your unique transaction reference to filter on.
	 */
	public String getMerchantReference() {
		return merchantReference;
	}

	/**
	 * Your unique transaction reference to filter on.
	 */
	public void setMerchantReference(String value) {
		this.merchantReference = value;
	}

	/**
	 * Your order identifier to filter on.
	 */
	public Long getMerchantOrderId() {
		return merchantOrderId;
	}

	/**
	 * Your order identifier to filter on.
	 */
	public void setMerchantOrderId(Long value) {
		this.merchantOrderId = value;
	}

	/**
	 * The zero-based index of the first refund in the result. If omitted, the offset will be 0.
	 */
	public Integer getOffset() {
		return offset;
	}

	/**
	 * The zero-based index of the first refund in the result. If omitted, the offset will be 0.
	 */
	public void setOffset(Integer value) {
		this.offset = value;
	}

	/**
	 * The maximum number of refunds to return, with a maximum of 100. If omitted, the limit will be 10.
	 */
	public Integer getLimit() {
		return limit;
	}

	/**
	 * The maximum number of refunds to return, with a maximum of 100. If omitted, the limit will be 10.
	 */
	public void setLimit(Integer value) {
		this.limit = value;
	}

	@Override
	public List toRequestParameters() {
		List result = new LinkedList();
		if (hostedCheckoutId != null) {
			result.add(new RequestParam("hostedCheckoutId", hostedCheckoutId));
		}
		if (merchantReference != null) {
			result.add(new RequestParam("merchantReference", merchantReference));
		}
		if (merchantOrderId != null) {
			result.add(new RequestParam("merchantOrderId", merchantOrderId.toString()));
		}
		if (offset != null) {
			result.add(new RequestParam("offset", offset.toString()));
		}
		if (limit != null) {
			result.add(new RequestParam("limit", limit.toString()));
		}
		return result;
	}
}