The Giftcard Transaction Object

Transaction

id string

Unique ID for the transaction.

retailerId string optional

The unique ID for the retailer that performed this transaction. You can only see this field if this transaction was performed by yourself. Thus, if present, this is always your own retailerId.

confirmedAt string optional

The date at which this transaction was confirmed. If this date is missing then this is a pending transaction reflecting a transaction intent. Pending transactions affect the available balance of a giftcard, but DO NOT have any effect on the balance of a giftcard until they are confirmed.

Dates are strings in ISO-8601 format yyyyMMdd'T'hhmmss'Z' and are always in UTC.

amount int

The (money) amount of this transaction. This is a positive or negative integer describing the effect of this transaction in the giftcard's balances.

statementDescriptor string

A statement descriptor for this transaction. This is mostly information intended for the giftcard customer/owner that you can pass on in case it's helpful.

metadata object optional

The metadata that was attached to this transaction. You can only see this field if this transaction was performed by yourself. Also, this field is only available on confirmed transactions.

Last updated

Was this helpful?