Class LaybuyOrderStatus

Provides a set of known order 'statuses' as returned when using the GetOrder(OrderRequest) with a merchant reference.

Inheritance
Object
LaybuyOrderStatus
Inherited Members
Namespace: Yort.Laybuy.InStore
Assembly: Yort.Laybuy.InStore.dll
Syntax
public static class LaybuyOrderStatus

Fields

| Improve this Doc View Source

Cancelled

The customer or merchant cancelled the order. This should be treated as a failure case, and a new order placed if payment via Laybuy is still required.

Declaration
public const string Cancelled = "CANCELLED"
Field Value
Type Description
String
| Improve this Doc View Source

Completed

The order has been fully processed and payment approved. This is the ultimate success status for a Laybuy order.

Declaration
public const string Completed = "COMPLETED"
Field Value
Type Description
String
| Improve this Doc View Source

Declined

The order was declined by Laybuy or the payment processor (i.e exceeded credit limit, insufficient funds, expired card etc). This should be treated as a failure case, and a new order placed (with any account/card issue corrected first) if payment via Laybuy is still required.

Declaration
public const string Declined = "DECLINED"
Field Value
Type Description
String
| Improve this Doc View Source

Error

Some kind of error occurred, additional information about the error should be included in the response. This should be treated as a failure case, and a new order placed (with any corrected input if required) if payment via Laybuy is still required.

Declaration
public const string Error = "ERROR"
Field Value
Type Description
String
| Improve this Doc View Source

Expired

The order expired before being completed. Typically orders expire ten minutes after the link is sent to the customer. This should be treated as a failure case, and a new order placed if payment via Laybuy is still required.

Declaration
public const string Expired = "EXPIRED"
Field Value
Type Description
String
| Improve this Doc View Source

Processing

Layby has received order approval from the customer and is processing the payment, no work is required from the merchant/integration except to keep polling. This status should be treating as a 'pending' and the status rechecked in another 5-10 seconds until a non-pending status occurs.

Declaration
public const string Processing = "PROCESSING"
Field Value
Type Description
String
| Improve this Doc View Source

Waiting

Layby is awaiting order approval from the customer. This can take some time, especially if the customer has to sign up to Laybuy first etc. This status should be treating as a 'pending' and the status rechecked in another 5-10 seconds until a non-pending status occurs.

Declaration
public const string Waiting = "WAITING"
Field Value
Type Description
String

Methods

| Improve this Doc View Source

IsApproved(String)

Determines whether the specified status indicates an approved/completed payment/order.

Declaration
public static bool IsApproved(string status)
Parameters
Type Name Description
String status

The status to check.
Returns
Type Description
Boolean

true if status is a case insensitive match to Completed; otherwise, false.
See Also
| Improve this Doc View Source

IsFailed(String)

Determines whether the specified status indicates a final, non-pending state, that has not resulted in successful payment/an order being created.

Declaration
public static bool IsFailed(string status)
Parameters
Type Name Description
String status

The status to check.
Returns
Type Description
Boolean

true if the specified status is not any of the pending or approved statuses; otherwise, false.
See Also
| Improve this Doc View Source

IsPendingStatus(String)

Determines whether if status indicating a pending status and status polling should continue at the next interval.

Declaration
public static bool IsPendingStatus(string status)
Parameters
Type Name Description
String status

The status to check.
Returns
Type Description
Boolean

true if status has a case insensitive match to Processing or Waiting; otherwise, false.
See Also