Magento API

SOAP

About Magento API

Module: Customer Balance API

Resource: enterprise_customerbalance

Aliases: storecredit
Method:
  • enterprise_customerbalance.balance (SOAP V1)
  • enterpriseCustomerbalanceBalance (SOAP V2)

Allows you to retrieve the customer store credit balance amount.

Arguments:

Type Name Description
string sessionId Session ID
string customerId Customer ID
string websiteId Website ID

Return:

Type Description
string/float Virtual balance amount

Faults:

Fault Code Fault Message
100 Provided data is invalid.
101 No balance found with requested parameters.

Examples

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

$balanceAmount = $proxy->call($sessionId, 'storecredit.balance', array($customerId, $websiteId));
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->enterpriseCustomerbalanceBalance($sessionId, '4', '2');
var_dump($result);
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->enterpriseCustomerbalanceBalance((object)array('sessionId' => $sessionId->result, 'customerId' => '4', 'websiteId' => '2'));   
var_dump($result->result);