• Articles
  • Api Documentation

    Show / Hide Table of Contents
    • Yort.Laybuy.InStore
      • CancelOrderRequest
      • CancelOrderResponse
      • CreateOrderRequest
      • CreateOrderResponse
      • ILaybuyClient
      • LaybuyApiException
      • LaybuyApiResponseBase
      • LaybuyClient
      • LaybuyClientConfiguration
      • LaybuyCredentials
      • LaybuyCustomerAddress
      • LaybuyCustomerBase
      • LaybuyEnvironment
      • LaybuyItem
      • LaybuyOrderRefund
      • LaybuyOrderStatus
      • LaybuyRequestBase
      • LaybuyStatus
      • OrderRequest
      • OrderResponse
      • OrderStatusRequest
      • OrderStatusResponse
      • RefundRequest
      • RefundResponse
      • RequestLaybuyCustomer
      • ResponseLaybuyCustomer
      • StandardOriginData

    Class RefundRequest

    Represents the arguments passed to Refund(RefundRequest).

    Inheritance
    Object
    LaybuyRequestBase
    RefundRequest
    Inherited Members
    LaybuyRequestBase.SetDefaults(LaybuyClientConfiguration)
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Object.ReferenceEquals(Object, Object)
    Object.ToString()
    Namespace: Yort.Laybuy.InStore
    Assembly: Yort.Laybuy.InStore.dll
    Syntax
    public class RefundRequest : LaybuyRequestBase

    Properties

    | Improve this Doc View Source

    Amount

    The amount of the refund.

    Declaration
    [JsonProperty("amount")]
    public decimal Amount { get; set; }
    Property Value
    Type Description
    Decimal
    | Improve this Doc View Source

    Note

    An optional, humand readable note sent to the recipient of the refund.

    Declaration
    [JsonProperty("note")]
    public string Note { get; set; }
    Property Value
    Type Description
    String
    | Improve this Doc View Source

    OrderId

    The unique id of the Laybuy order to refund against.

    Declaration
    [JsonProperty("orderId")]
    public long OrderId { get; set; }
    Property Value
    Type Description
    Int64
    | Improve this Doc View Source

    RefundMerchantReference

    A unique client generated reference for the refund request, used to ensure idempotency.

    Declaration
    [JsonProperty("refundReference")]
    public string RefundMerchantReference { get; set; }
    Property Value
    Type Description
    String

    Methods

    | Improve this Doc View Source

    Validate()

    Validates the properties for this instance are valid before sending the request to the API.

    Declaration
    public override void Validate()
    Overrides
    LaybuyRequestBase.Validate()
    Remarks

    Provides simple client side validation, such as required fields beign provided and fields under maximum lengths etc.

    Exceptions
    Type Condition
    NotImplementedException

    See Also

    RefundResponse
    Refund(RefundRequest)
    • Improve this Doc
    • View Source
    Back to top Copyright (c) 2020 Troy Willmot