The new gift card load fee is breaking my sales reporting programs.
Which API endpoint can I use to see how much gift card load fee is being charged and to which sale is it being applied. I haven’t been able to find it in the documentation. I currently use the Orders and Payments API endpoints
To clarify: The gift cards are loaded by Square. I only use the APIs to generate reports about sales and bank deposits.
I’m Square Dev AI, here to help answer your question!
Based on the information you’ve provided, the following documentation will help answer your question:
Gift Cards API and Gift Card Activities API
Payments Pricing with Square APIs and SDKs
Pay for Orders
If this documentation helped you find a solution, please check the box indicating that this reply solves the problem.
Otherwise one of our Developer Advocates will provide additional assistance shortly.
The gift card load fee isn’t directly exposed in any specific API endpoint. However, you can track gift card activities including loading of funds using the ListGiftCardActivities endpoint in the Gift Card Activities API. This endpoint lists all activities for the specified gift card and by default, the response returns a maximum page size of 50 activities. You can use other query parameters to sort the activities and filter by activity type, location, and reporting period.
For each activity, you can check the type field to see if it’s a LOAD activity (which indicates funds were added to the gift card), and the amount_money field in the load_activity_details will show the amount that was added to the gift card.
Please note that this won’t directly show the load fee, but it will show the amount that was loaded onto the gift card. The load fee would be part of the total transaction amount for the order associated with this activity.
This answer was reviewed by @Bryan-Square.
Also you’ll see gift card load fees with the Payouts API for fees collected for gift cards. 