The Transaction Intent Object

Fields

Transaction Intent

id string Unique ID for the transaction intent.

giftcardId string Unique ID of the giftcard for transaction intent.

retailerId string Unique ID of the retailer that is the initiator of this transaction intent.

createdAt string Date at which this transaction intent was created. Dates are strings in ISO-8601 format yyyyMMdd'T'hhmmss'Z' and are always in UTC.

expiresAt string The date at which this transaction intent expires. Transaction Intents need to be either confirmed or cancelled within before this date. If a transaction intent expires, its funds are release back onto the gift card. Usually we expire transaction intents after 30 minutes. Dates are strings in ISO-8601 format yyyyMMdd'T'hhmmss'Z' and are always in UTC.

amount int The (money) amount of this transaction intent. A positive integer representing a money amount in the smallest currency unit (say 100 cents instead of 1 EUR).

currency string ISO 4217 - Alphabetic code, 3 characters. For example 'EUR' for Euro, 'USD' for U.S. Dollar., etc..

status string The status of this transaction intent. This is any one value of "NEEDS_CONFIRMATION", "SUCCEEDED", "CANCELLED" or "EXPIRED" If the status is "NEEDS_CONFIRMATION" you can still act on this transaction intent by either confirming or cancelling it. All other statuses describe the transaction intent in its final state.

confirmedAt string optional The date at which this transaction was confirmed, if at all. Dates are strings in ISO-8601 format yyyyMMdd'T'hhmmss'Z' and are always in UTC.

statementDescriptor string A statement descriptor for this transaction. This is mostly information intended for the gift card customer/owner that you can pass on in case it's helpful. Depending on how you were involved in this transaction, this statement description might have more or less detailed information.

metadata object optional The metadata that was attached to this transaction.

giftcardTransactionId string optional Unique ID of the transaction. This field is only available when this transaction intent is "SUCCEEDED" and therefore actually ended up as a real transaction.