Show Menu

Digital Gift Cards Details

Fetch Digital Gift Cards Details

This allows to get the list of digital gift cards supported by XTRM. The list has a unique SKU which is used as input to the userwithdrawfund API call. Digital Gift Card is added as an additional withdraw fund method for the user.

post/API/v4/GiftCard/GetDigitalGiftCards

Header Parameters

Authorizationstring

bearer access_token

Content-typestring

application/json

Request Parameters

IssuerAccountNumberstring

String length: inclusive between 1 and 25

SKUstring

String length: 7

Reponse Parameters

Get Gift Card Responsestring

Returned if successful. Allowed parameters are
brandName—Brand name of the digital gift card
imageUrls—Image urls of the digital gift card in 4 different sizes
description— Long description of the digital gift card
disclaimer— Disclaimer
shortDescription— Short description of the digital gift card
terms— Terms and conditions
items— Array of item details
sku— Unique ID of the digial gift card. This will be used in the 'UserWithdrawFund' api call
rewardName— Name of the gift card
currencyCode— Currency of the gift card
status— Status of availability of the gift card
valueType— Values could be FIXED_VALUE or VARIABLE_VALUE
rewardType— Value is Gift Card.
maxValue— Used when the gift card value type is VARIABLE_VALUE
minValue— Used when the gift card value type is VARIABLE_VALUE
faceValue— Used when the gift card value type is FIXED_VALUE
countries— List of supported countries.

OperationStatusstring

Always returned Indicates the status of the operation. Allowed parameters are:
Errors - Displays an error message if the Property name Obligation Definition/value operation was unsuccessful. For more information, see API Error Message Appendix.
Success—Indicates whether the operation was successful. Returns True if the action was successful or False if it was not successful.

Sample Request:

sandbox.xapi.xtrm.com/API/v4/GiftCard/GetDigitalGiftCardsDetails 

{
    "GetGiftCards": {
   "Request": {
       "IssuerAccountNumber": "SPN Issuer Account Number",
       "SKU": "SKU ID"
     }
   }
 }

Sample Response:


{
	"GetGiftCardResponse": {
		"GetGiftCardResult": {
			"GiftCard": [
				{
					"brandName": "1-800-FLOWERS.COM®",
					"imageUrls": [
						{
							"Img80W": "https://dwwvg90koz96l.cloudfront.net/images/brands/b276872-80w-326ppi.png",
							"Img130w": "https://dwwvg90koz96l.cloudfront.net/images/brands/b276872-130w-326ppi.png",
							"Img200W": "https://dwwvg90koz96l.cloudfront.net/images/brands/b276872-200w-326ppi.png",
							"Img300W": "https://dwwvg90koz96l.cloudfront.net/images/brands/b276872-300w-326ppi.png"
						}
					],
					"description": "
Gift-giving has never been easier with the 1-800-FLOWERS.COM® Gift Card! Browse a wide selection of fresh flowers, delicious gourmet treats and desserts, beautiful plants, stunning gift baskets and more – and then choose exactly what you want!

\r\n",
					"disclaimer": "
*1-800-FLOWERS.COM is not a sponsor of the rewards or otherwise affiliated with this company. The logos and other identifying marks attached are trademarks of and owned by each represented company and/or its affiliates.  Please visit each company's website for additional terms and conditions.

\r\n",
					"shortDescription": "
Gift-giving has never been easier with the 1-800-FLOWERS.COM® Gift Card! Browse a wide selection of fresh flowers, delicious gourmet treats and desserts, beautiful plants, stunning gift baskets and more – and then choose exactly what you want!

\r\n",
					"terms": "
You can use your eGift Card at any Cheryls® or Harry & David® retail stores and online at www.1800baskets.com, www.1800flowers.com, www.cheryls.com, www.fruitbouquets.com, www.harryanddavid.com, www.stockyards.com, www.thepopcornfactory.com and www.wolfermans.com. Acceptance of this card constitutes acceptance of these terms and conditions, which may change at any time. To view your eGift Card balance, go to http://freshgift.com/. This eGift Card does not expire.

\r\n",
					"items": [
						{
							"sku": "U935268",
							"rewardName": "1-800-FLOWERS.COM® Gift Card $10.00",
							"currencyCode": "USD",
							"status": "active",
							"valueType": "FIXED_VALUE",
							"rewardType": "gift card",
							"maxValue": 0,
							"minValue": 0,
							"faceValue": 10,
							"countries": [
								"US"
							]
						},
						{
							"sku": "U683701",
							"rewardName": "1-800-FLOWERS.COM® Gift Card $25.00",
							"currencyCode": "USD",
							"status": "active",
							"valueType": "FIXED_VALUE",
							"rewardType": "gift card",
							"maxValue": 0,
							"minValue": 0,
							"faceValue": 25,
							"countries": [
								"US"
							]
						},
						{
							"sku": "U106098",
							"rewardName": "1-800-FLOWERS.COM® Gift Card $50.00",
							"currencyCode": "USD",
							"status": "active",
							"valueType": "FIXED_VALUE",
							"rewardType": "gift card",
							"maxValue": 0,
							"minValue": 0,
							"faceValue": 50,
							"countries": [
								"US"
							]
						}
					]
				}
            ],
                                        
			"OperationStatus": {
				"Success": true,
				"Errors": null
			}
		}
	}
}

Why

Products

Developers

How It Works

Resources

Payment and foreign exchange transactions are powered and provided by Corpay. “Corpay” is the marketing trade name for the International Payment Solutions and Risk Management Solutions provided by certain subsidiaries of FleetCor Technologies, Inc. Use of this service is governed by Corpay’s Terms and Conditions.

➤