Order API
TypeOrderGiftCardUse1
Represents one gift-card payment transaction on an order.
Most API integrations should omit this type. Use it only when your commerce platform can report gift-card payment transactions for an order.
Treat rows as a payment ledger. Capture rows have positive amounts; refund rows have negative amounts.
| Kind | Type |
|---|---|
| Used in | EstimateAccrual1, UpdateOrders4 |
Properties
-
stringstring optionalGift-card identifier from the commerce platform
This field is optional for payment-only rows, but providing it lets Bubblehouse connect the payment row to a Bubblehouse gift-card redemption when applicable.
-
abbrev_codestring optionalShort display code for the gift card
-
Gift-card payment amount for this transaction
Use a positive amount for captures and a negative amount for refunds.
-
Payment transaction kind for this row
Defaults to
unknown, which Bubblehouse treats as a capture for backwards compatibility with older integrations.