com.ingenico.connect.gateway.sdk.java.domain.payment.definitions.OrderReferences 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.domain.payment.definitions;

public class OrderReferences {

	private String descriptor = null;

	private OrderInvoiceData invoiceData = null;

	private Long merchantOrderId = null;

	private String merchantReference = null;

	/**
	 * Descriptive text that is used towards to customer, either during an online checkout at a third party and/or on the statement of the customer. For card transactions this is usually referred to as a Soft Descriptor. The maximum allowed length varies per card acquirer:
	 * AIB - 22 characters
	 * 
American Express - 25 characters
	 * 
Atos Origin BNP - 15 characters
	 * 
Barclays - 25 characters
	 * 
Catella - 22 characters
	 * 
CBA - 20 characters
	 * 
Elavon - 25 characters
	 * 
First Data - 25 characters
	 * 
INICIS (INIPAY) - 22-30 characters
	 * 
JCB - 25 characters
	 * 
Merchant Solutions - 22-25 characters
	 * 
Payvision (EU & HK) - 25 characters
	 * 
SEB Euroline - 22 characters
	 * 
Sub1 Argentina - 15 characters
	 * 
Wells Fargo - 25 characters
	 * 
	 * Note that we advise you to use 22 characters as the max length as beyond this our experience is that issuers will start to truncate. We currently also only allow per API call overrides for AIB and Barclays

	 * For alternative payment products the maximum allowed length varies per payment product:
	 * 402 e-Przelewy - 30 characters
	 * 
404 INICIS - 80 characters
	 * 
802 Nordea ePayment Finland - 234 characters
	 * 
809 iDeal - 32 characters
	 * 
836 SOFORT - 42 characters
	 * 
840 PayPal - 127 characters
	 * 
841 WebMoney - 175 characters
	 * 
849 Yandex - 64 characters
	 * 
861 Alipay - 256 characters
	 * 
863 WeChat Pay - 32 characters
	 * 
880 BOKU - 20 characters
	 * 
8580 Qiwi - 255 characters
	 * 
1504 Konbini - 80 characters
	 * 
	 * All other payment products don't support a descriptor.
	 */
	public String getDescriptor() {
		return descriptor;
	}

	/**
	 * Descriptive text that is used towards to customer, either during an online checkout at a third party and/or on the statement of the customer. For card transactions this is usually referred to as a Soft Descriptor. The maximum allowed length varies per card acquirer:
	 * AIB - 22 characters
	 * 
American Express - 25 characters
	 * 
Atos Origin BNP - 15 characters
	 * 
Barclays - 25 characters
	 * 
Catella - 22 characters
	 * 
CBA - 20 characters
	 * 
Elavon - 25 characters
	 * 
First Data - 25 characters
	 * 
INICIS (INIPAY) - 22-30 characters
	 * 
JCB - 25 characters
	 * 
Merchant Solutions - 22-25 characters
	 * 
Payvision (EU & HK) - 25 characters
	 * 
SEB Euroline - 22 characters
	 * 
Sub1 Argentina - 15 characters
	 * 
Wells Fargo - 25 characters
	 * 
	 * Note that we advise you to use 22 characters as the max length as beyond this our experience is that issuers will start to truncate. We currently also only allow per API call overrides for AIB and Barclays

	 * For alternative payment products the maximum allowed length varies per payment product:
	 * 402 e-Przelewy - 30 characters
	 * 
404 INICIS - 80 characters
	 * 
802 Nordea ePayment Finland - 234 characters
	 * 
809 iDeal - 32 characters
	 * 
836 SOFORT - 42 characters
	 * 
840 PayPal - 127 characters
	 * 
841 WebMoney - 175 characters
	 * 
849 Yandex - 64 characters
	 * 
861 Alipay - 256 characters
	 * 
863 WeChat Pay - 32 characters
	 * 
880 BOKU - 20 characters
	 * 
8580 Qiwi - 255 characters
	 * 
1504 Konbini - 80 characters
	 * 
	 * All other payment products don't support a descriptor.
	 */
	public void setDescriptor(String value) {
		this.descriptor = value;
	}

	/**
	 * Object containing additional invoice data
	 */
	public OrderInvoiceData getInvoiceData() {
		return invoiceData;
	}

	/**
	 * Object containing additional invoice data
	 */
	public void setInvoiceData(OrderInvoiceData value) {
		this.invoiceData = value;
	}

	/**
	 * Your order identifier

	 * Note: This does not need to have a unique value for each transaction. This allows your to link multiple transactions to the same logical order in your system.
	 */
	public Long getMerchantOrderId() {
		return merchantOrderId;
	}

	/**
	 * Your order identifier

	 * Note: This does not need to have a unique value for each transaction. This allows your to link multiple transactions to the same logical order in your system.
	 */
	public void setMerchantOrderId(Long value) {
		this.merchantOrderId = value;
	}

	/**
	 * Note that the maximum length of this field for transactions processed on the GlobalCollect platform is 30. Your unique reference of the transaction that is also returned in our report files. This is almost always used for your reconciliation of our report files.
	 */
	public String getMerchantReference() {
		return merchantReference;
	}

	/**
	 * Note that the maximum length of this field for transactions processed on the GlobalCollect platform is 30. Your unique reference of the transaction that is also returned in our report files. This is almost always used for your reconciliation of our report files.
	 */
	public void setMerchantReference(String value) {
		this.merchantReference = value;
	}
}