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

import com.ingenico.connect.gateway.sdk.java.domain.payment.definitions.Payment;
import com.ingenico.connect.gateway.sdk.java.domain.payment.definitions.PaymentCreationReferences;

/**
 * This object is used when a payment was created during a HostedCheckout. It is part of the response of a GET HostedCheckout object and contains the details of the created payment object.
 */
public class CreatedPaymentOutput {

	private DisplayedData displayedData = null;

	private Payment payment = null;

	private PaymentCreationReferences paymentCreationReferences = null;

	private String paymentStatusCategory = null;

	private Boolean tokenizationSucceeded = null;

	private String tokens = null;

	/**
	 * Object that contains the action, including the needed data, that you should perform next, like showing instruction, showing the transaction results or redirect to a third party to complete the payment
	 */
	public DisplayedData getDisplayedData() {
		return displayedData;
	}

	/**
	 * Object that contains the action, including the needed data, that you should perform next, like showing instruction, showing the transaction results or redirect to a third party to complete the payment
	 */
	public void setDisplayedData(DisplayedData value) {
		this.displayedData = value;
	}

	/**
	 * Object that holds the payment data
	 */
	public Payment getPayment() {
		return payment;
	}

	/**
	 * Object that holds the payment data
	 */
	public void setPayment(Payment value) {
		this.payment = value;
	}

	/**
	 * Object containing the created references
	 */
	public PaymentCreationReferences getPaymentCreationReferences() {
		return paymentCreationReferences;
	}

	/**
	 * Object containing the created references
	 */
	public void setPaymentCreationReferences(PaymentCreationReferences value) {
		this.paymentCreationReferences = value;
	}

	/**
	 * Highlevel indication of the payment status with the following possible values:
	 * REJECTED - The payment has been rejected or is in such a state that it will never become successful. This category groups the following statuses:
	 * CREATED
	 * 
REJECTED
	 * 
REJECTED CAPTURE
	 * 
REJECTED REFUND
	 * 
REJECTED PAYOUT
	 * 
CANCELLED
	 * 
SUCCESSFUL - The payment was not (yet) rejected. Use the payment statuses to determine if it was completed, see Statuses. This category groups the following statuses:
	 * PENDING PAYMENT
	 * 
ACCOUNT VERIFIED
	 * 
PENDING FRAUD APPROVAL
	 * 
PENDING APPROVAL
	 * 
AUTHORIZATION REQUESTED
	 * 
CAPTURE REQUESTED
	 * 
REFUND REQUESTED
	 * 
PAYOUT REQUESTED
	 * 
CAPTURED
	 * 
PAID
	 * 
ACCOUNT CREDITED
	 * 
REVERSED
	 * 
CHARGEBACK_NOTIFICATION
	 * 
CHARGEBACKED
	 * 
REFUNDED
	 * 
	 * 
STATUS_UNKNOWN - The status of the payment is unknown at this moment. This category groups the following statuses:
	 * REDIRECTED
	 * 
	 * 


	 * Please see Statuses for a full overview of possible values.
	 *
	 * @deprecated Use Payment.statusOutput.statusCategory instead
	 */
	@Deprecated
	public String getPaymentStatusCategory() {
		return paymentStatusCategory;
	}

	/**
	 * Highlevel indication of the payment status with the following possible values:
	 * REJECTED - The payment has been rejected or is in such a state that it will never become successful. This category groups the following statuses:
	 * CREATED
	 * 
REJECTED
	 * 
REJECTED CAPTURE
	 * 
REJECTED REFUND
	 * 
REJECTED PAYOUT
	 * 
CANCELLED
	 * 
SUCCESSFUL - The payment was not (yet) rejected. Use the payment statuses to determine if it was completed, see Statuses. This category groups the following statuses:
	 * PENDING PAYMENT
	 * 
ACCOUNT VERIFIED
	 * 
PENDING FRAUD APPROVAL
	 * 
PENDING APPROVAL
	 * 
AUTHORIZATION REQUESTED
	 * 
CAPTURE REQUESTED
	 * 
REFUND REQUESTED
	 * 
PAYOUT REQUESTED
	 * 
CAPTURED
	 * 
PAID
	 * 
ACCOUNT CREDITED
	 * 
REVERSED
	 * 
CHARGEBACK_NOTIFICATION
	 * 
CHARGEBACKED
	 * 
REFUNDED
	 * 
	 * 
STATUS_UNKNOWN - The status of the payment is unknown at this moment. This category groups the following statuses:
	 * REDIRECTED
	 * 
	 * 


	 * Please see Statuses for a full overview of possible values.
	 *
	 * @deprecated Use Payment.statusOutput.statusCategory instead
	 */
	@Deprecated
	public void setPaymentStatusCategory(String value) {
		this.paymentStatusCategory = value;
	}

	/**
	 * If the payment was attempted to be tokenized, indicates if tokenization was successful or not.
	 */
	public Boolean getTokenizationSucceeded() {
		return tokenizationSucceeded;
	}

	/**
	 * If the payment was attempted to be tokenized, indicates if tokenization was successful or not.
	 */
	public void setTokenizationSucceeded(Boolean value) {
		this.tokenizationSucceeded = value;
	}

	/**
	 * This property contains the tokens that are associated with the hosted checkout session/customer. You can use the tokens listed in this list for a future checkout of the same customer.
	 */
	public String getTokens() {
		return tokens;
	}

	/**
	 * This property contains the tokens that are associated with the hosted checkout session/customer. You can use the tokens listed in this list for a future checkout of the same customer.
	 */
	public void setTokens(String value) {
		this.tokens = value;
	}
}