Class LatitudePayCreateRefundRequest

Represents a request to refund some or all of an accepted payment plan.

Inheritance

Object

LatitudePayCreateRefundRequest

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: Yort.LatitudePay.InStore

Assembly: Yort.LatitudePay.InStore.dll

Syntax

public class LatitudePayCreateRefundRequest

Properties

Amount

Gets or sets the amount of this refund. Must be a positive non-zero value.

Declaration

[Required]
[JsonProperty("amount")]
public LatitudePayMoney Amount { get; set; }

Property Value

Type	Description
LatitudePayMoney	The amount.

IdempotencyKey

A value unique to this refund, but common to all CreateRefundRequest sent for this payment, to ensure the refund is created only once.

Declaration

[JsonIgnore]
public string IdempotencyKey { get; set; }

Property Value

Type	Description
String

Remarks

This value is optional but highly recommended as without using it you cannot guarantee network problems and other issues won't lead to duplicate refunds.

Set this property to a value that is unique for this *refund* but the same for each call to CreateRefundAsync(LatitudePayCreateRefundRequest) for that refund. Any repeat requests using the same idempotency key value will return the original response without creating a second refund. If the original request never got processed (due to power failure, network outage etc) then the next request will be treated as the first one. This guarantees one and only one refund is created.

PaymentPlanToken

Gets or sets the token of the payment plan to refund against. Required.

Declaration

[Required]
[JsonIgnore]
public string PaymentPlanToken { get; set; }

Property Value

Type	Description
String	The payment plan token.

Reason

Gets or sets a descriptive reason for the refund.

Declaration

[JsonProperty("reason")]
public string Reason { get; set; }

Property Value

Type	Description
String	The reason.

Reference

Gets or sets the merchants unique reference for this refund. Required.

Declaration

[JsonProperty("reference")]
public string Reference { get; set; }

Property Value

Type	Description
String	The reference.

See Also

LatitudePayCreateRefundResponse

CreateRefundAsync(LatitudePayCreateRefundRequest)