Account.fetchByVid
Web Session Object
Transaction Object
Token Object
Season Set Object
Refund Object
RatePlan Object
Product Object
Payment Provider Object
Payment Method Object
NameValuePair Object
GiftCard Object
Entitlement Object
Chargeback Object
Campaign Object
BillingPlan Object
AutoBill Object
Address Object
Activity Object
Account Object
Account.fetchByVid
The fetchByVid method returns an Account object whose VID matches the input. When you first create an Account object with the update method, leave the VID field empty; Vindicia Subscribe automatically assigns the object a VID. For convenience, store the VID in your application so that you can retrieve or refer to that object with its VID later. If you do not assign unique account IDs (merchantAccountId) yourself, you may identify Account objects with their VIDs.
Input
srd: sparse response description, a SOAP string (which must be a JSON object), in which you specify the elements you want returned.This parameter enables the calling system to constrain a method call to return only components you specify. This gives you greater control over returned content, and improves response time within the Vindicia platform by reducing the processing needed for the call.
Some fields are required, either practically or in the WSDL, and will be returned regardless of the srd. A null srd returns the complete response.
vid: the Account object’s Vindicia identifier, which serves as the search criterion.
Output
return: an object of type Return that indicates the success or failure of the call.
account: the Account object whose VID matches the input.
Returns
In addition to those listed in Standard Return Codes, this call returns:
Return Code |
Return String |
400 |
One of the following:
|
Example
$accountVid = 'MyVindiciaAccountVid';
// Create a SOAP caller object
$account = new Account();
$accountVID = "36c8de2cb74b2c2b08b259cf231ac8d90d1bb3b8";
// now load a customer account into the account object by VID
$response = $account->fetchByVid($accountVid);
if($response['returnCode'] == 200) {
$fetchedAccount = $response['data']->account;
}
else {
// The call was unsuccessful
print "Return code: " . $response['returnCode'] . "\n";
print "Return string: " . $response['returnString'] . "\n";
}
For Users
Learn More