forage-android/com.joinforage.forage.android.core.services.forageapi.payment/Payment

Payment

data class Payment(val amount: String, val created: String, val deliveryAddress: Address, val description: String, val fundingType: String, val isDelivery: Boolean, val merchant: String, val metadata: Map<String, String>?, val paymentMethodRef: String, val receipt: Receipt?, val ref: String, val refunds: List<String>, val status: String, val successDate: String?, val updated: String)

Constructors

Payment

constructor(amount: String, created: String, deliveryAddress: Address, description: String, fundingType: String, isDelivery: Boolean, merchant: String, metadata: Map<String, String>?, paymentMethodRef: String, receipt: Receipt?, ref: String, refunds: List<String>, status: String, successDate: String?, updated: 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.

deliveryAddress

val deliveryAddress: Address

The address for delivery or pickup of the Order.

description

val description: String

A human-readable description of the Payment.

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.

isDelivery

val isDelivery: Boolean

A boolean that indicates whether the Payment is for delivery (true) or pickup (false).

merchant

val merchant: String

A string that represents a unique merchant ID that Forage provides during onboarding.

metadata

val metadata: Map<String, String>?

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

paymentMethodRef

val paymentMethodRef: String

The unique reference hash for the existing Forage PaymentMethod that was charged in this transaction.

receipt

val receipt: Receipt?

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.

refunds

val refunds: List<String>

A list of unique reference hashes for the Refund objects that were created for this Payment.

status

val status: String

The status of the Payment. Learn more

successDate

val successDate: String?

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

updated

val updated: String

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