forage-android/com.joinforage.forage.android.pos.services.forageapi.refund/Refund

Refund

data class Refund(val amount: String, val created: String, val fundingType: String, val metadata: Map<String, String>?, val receipt: RefundReceipt?, val ref: String, val status: String, val updated: String, val paymentRef: String, val reason: String, val posTerminal: PosTerminal, val sequenceNumber: String, val externalOrderId: String?)

Constructors

Refund

constructor(amount: String, created: String, fundingType: String, metadata: Map<String, String>?, receipt: RefundReceipt?, ref: String, status: String, updated: String, paymentRef: String, reason: String, posTerminal: PosTerminal, sequenceNumber: String, externalOrderId: String?)

Properties

amount

val amount: String

A positive decimal number that represents how much the PaymentMethod was charged in USD. Precision to the penny is supported. The minimum amount that can be charged is 0.01. To differentiate between a SNAP and an EBT Cash charge on the same EBT Card, use fundingType.

created

val created: String

A UTC-8 timestamp of when the Payment was created, represented as an ISO 8601 date-time string.

externalOrderId

val externalOrderId: String?

fundingType

val fundingType: String

The payment instrument type. Use fundingType to differentiate between a SNAP (ebt_snap) and an EBT Cash (ebt_cash) charge on the same EBT Card.

metadata

val metadata: Map<String, String>?

A map of key-value pairs that you can use to store additional information about the Payment.

paymentRef

val paymentRef: String

posTerminal

val posTerminal: PosTerminal

reason

val reason: String

receipt

val receipt: RefundReceipt?

Most of the information that you're required to display to the customer, according to FNS regulations. receipt is null if the data that populates the receipt is not yet available.

ref

val ref: String

A string identifier that refers to an instance in Forage's database of a Payment object, which is a one-time charge to a previously created PaymentMethod.

sequenceNumber

val sequenceNumber: String

status

val status: String

The status of the Payment. Learn more

updated

val updated: String

A UTC-8 timestamp of when the Payment was last updated, represented as an ISO 8601 date-time string.