com.worldline.connect.sdk.java.v1.domain

Class OrderStatusOutput

java.lang.Object

com.worldline.connect.sdk.java.v1.domain.OrderStatusOutput

Direct Known Subclasses:

PaymentStatusOutput

public class OrderStatusOutput
extends Object

Constructor Summary

Constructors

Constructor and Description
OrderStatusOutput()

Method Summary

Modifier and Type	Method and Description
List<APIError>	getErrors() Custom object contains the set of errors
Boolean	getIsCancellable() Flag indicating if the payment can be cancelled true false
Boolean	getIsRetriable() Flag indicating whether a rejected payment may be retried by the merchant without incurring a fee true false
List<KeyValuePair>	getProviderRawOutput() This is the raw response returned by the acquirer.
String	getStatusCategory() Highlevel status of the payment, payout or refund with the following possible values: CREATED - The transaction has been created.
Integer	getStatusCode() Numeric status code of the legacy API.
String	getStatusCodeChangeDateTime() Date and time of payment Format: YYYYMMDDHH24MISS
void	setErrors(List<APIError> value) Custom object contains the set of errors
void	setIsCancellable(Boolean value) Flag indicating if the payment can be cancelled true false
void	setIsRetriable(Boolean value) Flag indicating whether a rejected payment may be retried by the merchant without incurring a fee true false
void	setProviderRawOutput(List<KeyValuePair> value) This is the raw response returned by the acquirer.
void	setStatusCategory(String value) Highlevel status of the payment, payout or refund with the following possible values: CREATED - The transaction has been created.
void	setStatusCode(Integer value) Numeric status code of the legacy API.
void	setStatusCodeChangeDateTime(String value) Date and time of payment Format: YYYYMMDDHH24MISS

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OrderStatusOutput

public OrderStatusOutput()

Method Detail

getErrors

public List<APIError> getErrors()

Custom object contains the set of errors

setErrors

public void setErrors(List<APIError> value)

Custom object contains the set of errors

getIsCancellable

public Boolean getIsCancellable()

Flag indicating if the payment can be cancelled

• true
• false

setIsCancellable

public void setIsCancellable(Boolean value)

Flag indicating if the payment can be cancelled

• true
• false

getIsRetriable

public Boolean getIsRetriable()

Flag indicating whether a rejected payment may be retried by the merchant without incurring a fee

• true
• false

setIsRetriable

public void setIsRetriable(Boolean value)

Flag indicating whether a rejected payment may be retried by the merchant without incurring a fee

• true
• false

getProviderRawOutput

public List<KeyValuePair> getProviderRawOutput()

This is the raw response returned by the acquirer. This property contains unprocessed data directly returned by the acquirer. It's recommended for data analysis only due to its dynamic nature, which may undergo future changes.

setProviderRawOutput

public void setProviderRawOutput(List<KeyValuePair> value)

This is the raw response returned by the acquirer. This property contains unprocessed data directly returned by the acquirer. It's recommended for data analysis only due to its dynamic nature, which may undergo future changes.

getStatusCategory

public String getStatusCategory()

Highlevel status of the payment, payout or refund with the following possible values:

• CREATED - The transaction has been created. This is the initial state once a new payment, payout or refund is created. This category groups the following statuses:
  • CREATED
• PENDING_PAYMENT: The payment is waiting on customer action. This category groups the following statuses:
  • PENDING_PAYMENT
  • REDIRECTED
• ACCOUNT_VERIFIED: The account has been verified. This category groups the following statuses:
  • ACCOUNT_VERIFIED
• PENDING_MERCHANT: The transaction is awaiting approval to proceed with the payment, payout or refund. This category groups the following statuses:
  • PENDING_APPROVAL
  • PENDING_COMPLETION
  • PENDING_CAPTURE
  • PENDING_FRAUD_APPROVAL
• PENDING_CONNECT_OR_3RD_PARTY: The transaction is in the queue to be processed. This category groups the following statuses:
  • AUTHORIZATION_REQUESTED
  • CAPTURE_REQUESTED
  • PAYOUT_REQUESTED
  • REFUND_REQUESTED
• COMPLETED: The transaction has completed. This category groups the following statuses:
  • CAPTURED
  • PAID
  • ACCOUNT_CREDITED
  • CHARGEBACK_NOTIFICATION
• REVERSED: The transaction has been reversed. This category groups the following statuses:
  • CHARGEBACKED
  • REVERSED
• REFUNDED: The transaction has been refunded. This category groups the following statuses:
  • REFUNDED
• UNSUCCESSFUL: The transaction has been rejected or is in such a state that it will never become successful. This category groups the following statuses:
  • CANCELLED
  • REJECTED
  • REJECTED_CAPTURE
  • REJECTED_CREDIT

Please see Statuses for a full overview of possible values.

setStatusCategory

public void setStatusCategory(String value)

Highlevel status of the payment, payout or refund with the following possible values:

• CREATED - The transaction has been created. This is the initial state once a new payment, payout or refund is created. This category groups the following statuses:
  • CREATED
• PENDING_PAYMENT: The payment is waiting on customer action. This category groups the following statuses:
  • PENDING_PAYMENT
  • REDIRECTED
• ACCOUNT_VERIFIED: The account has been verified. This category groups the following statuses:
  • ACCOUNT_VERIFIED
• PENDING_MERCHANT: The transaction is awaiting approval to proceed with the payment, payout or refund. This category groups the following statuses:
  • PENDING_APPROVAL
  • PENDING_COMPLETION
  • PENDING_CAPTURE
  • PENDING_FRAUD_APPROVAL
• PENDING_CONNECT_OR_3RD_PARTY: The transaction is in the queue to be processed. This category groups the following statuses:
  • AUTHORIZATION_REQUESTED
  • CAPTURE_REQUESTED
  • PAYOUT_REQUESTED
  • REFUND_REQUESTED
• COMPLETED: The transaction has completed. This category groups the following statuses:
  • CAPTURED
  • PAID
  • ACCOUNT_CREDITED
  • CHARGEBACK_NOTIFICATION
• REVERSED: The transaction has been reversed. This category groups the following statuses:
  • CHARGEBACKED
  • REVERSED
• REFUNDED: The transaction has been refunded. This category groups the following statuses:
  • REFUNDED
• UNSUCCESSFUL: The transaction has been rejected or is in such a state that it will never become successful. This category groups the following statuses:
  • CANCELLED
  • REJECTED
  • REJECTED_CAPTURE
  • REJECTED_CREDIT

Please see Statuses for a full overview of possible values.

getStatusCode

public Integer getStatusCode()

Numeric status code of the legacy API. It is returned to ease the migration from the legacy APIs to Worldline Connect. You should not write new business logic based on this property as it will be deprecated in a future version of the API. The value can also be found in the GlobalCollect Payment Console, in the Ogone BackOffice and in report files.

setStatusCode

public void setStatusCode(Integer value)

Numeric status code of the legacy API. It is returned to ease the migration from the legacy APIs to Worldline Connect. You should not write new business logic based on this property as it will be deprecated in a future version of the API. The value can also be found in the GlobalCollect Payment Console, in the Ogone BackOffice and in report files.

getStatusCodeChangeDateTime

public String getStatusCodeChangeDateTime()

Date and time of payment
Format: YYYYMMDDHH24MISS

setStatusCodeChangeDateTime

public void setStatusCodeChangeDateTime(String value)

Date and time of payment
Format: YYYYMMDDHH24MISS