App API
Orders and refunds
Send each paid order so the member earns points and any held reward is used. Send refunds so points and rewards are given back or taken back correctly.
Available at launch
Orders come from your server only, with a secret key, once payment is captured. The examples follow the order from Checkouts and redemptions: Maya has 420 Beans, pays for a $12.50 pickup order in the brand's app and uses her "Fall pastry on us" wallet item. Every endpoint can also return the common errors listed on Errors.
Order statuses#
status | Meaning |
|---|---|
credited | Recorded, points earned, redemptions captured. |
partially_refunded | One or more partial refunds. More refunds can follow. |
refunded | Fully refunded. Final. |
credited moves to partially_refunded or refunded; partially_refunded moves to refunded. An order.refunded webhook fires on each refund.
For more information, see the following guide: