This walkthrough shows how to redeem and reload a gift card when your application uses a custom order and payment processing system. The walkthrough assumes that you completed Walkthrough 1: Sell a Gift Card and have an activated gift card.
Note
To learn how to redeem or reload a gift card when your application integrates with the Orders API and Payments API, see Redeem and Reload a Gift Card When Using Orders API and Payments API Integration.
The following procedure shows a typical application flow for accepting a payment when your application uses a custom payment processing system. If your application supports gift card on file payments, first list the gift cards on file. Gift cards on file are made available by linking customer profiles to gift cards, which requires integration with the Customers API. After creating and processing the order and payment, you must call CreateGiftCardActivity in the Gift Card Activities API and create a REDEEM activity.
List gift cards on file
Before you begin, make sure that you linked a customer to the gift card.
Note
Linking a customer profile to a gift card is only required to follow the steps in this walkthrough that take a payment from a gift card on file.
Alternatively, to get the gift card ID to use for your custom payment processing, your application can collect the gift card account number (GAN) from the buyer and call RetrieveGiftCardFromGAN.
-
If needed, call SearchCustomers to find the customer profile for the buyer. You can search by phone number, email address, and other supported attributes. For example, if the buyer signs in to your application using an email address, you can use the following request:
{ "authentication": { "accessToken": "{ACCESS_TOKEN}" },