Magento 1.x Software Support Notice

For Magento Commerce 1, Magento is providing software support through June 2020. Depending on your Magento Commerce 1 version, software support may include both quality fixes and security patches. Please review our Magento Software Lifecycle Policy to see how your version of Magento Commerce 1 is supported.

For Magento Open Source 1.5 to 1.9, Magento is providing software security patches through June 2020 to ensure those sites remain secure and compliant. Visit our information page for more details about our software maintenance policy and other considerations for your business.

Customer Info

Edit this page on GitHub

Module: GiftCard API

Resource: giftcard_customer


Allows you to receive information about the gift card for a selected customer.


Type Name Description
string sessionId Session ID
string code Gift card code


Type Name Description
array result Array of giftcardCustomerEntity

The giftcardCustomerEntity content is as follows:

Type Name Description
double balance
Gift card balance
string expire_date
Gift card expiration date in the YYYY-MM-DD format


Fault Code Fault Message
100 Gift card does not exists.
101 Gift card is not valid.


Request Example SOAP V1
$proxy = new SoapClient('http://magentohost/api/soap/?wsdl');
$sessionId = $proxy->login('apiUser', 'apiKey');

$code = "code";

$giftcardInfo = $proxy->call(
Request Example SOAP V2
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary

$result = $proxy->giftcardCustomerInfo($sessionId, 'code');
Request Example SOAP V2 (WS-I Compliance Mode)
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl');

$sessionId = $proxy->login((object)array('username' => 'apiUser', 'apiKey' => 'apiKey'));

$result = $proxy->giftcardCustomerInfo((object)array('sessionId' => $sessionId->result, 'code' => 'code'));

Response Example SOAP V1
  'balance' => string '500.0000' (length=8)
  'expire_date' => string '2012-04-25' (length=10)