Chargeback.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
Chargeback.fetchByVid
The fetchByVid method returns a Chargeback object whose VID matches the input, that is, it enables you to retrieve a Chargeback object by its VID.
When Vindicia adds a Chargeback object to its database by downloading the information from your payment processor or through your calling update() to create a Chargeback object, Vindicia assigns the object a unique identifier called VID. That VID is in the Chargeback object returned to you when you make calls to fetch chargebacks.
This call is useful for retrieving a specific chargeback because a Chargeback object does not have any other unique identifiers. Since there can be multiple chargebacks against one transaction, you cannot uniquely identify a chargeback with its associated Transaction object’s ID, reference number, or case number.
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 Chargeback 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.
chargeback: the Chargeback 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
$cb = new Chargeback();
$cbVID = "a209408014a33fec3dcd4a3339d78efc33603bfe";
// now load a chargeback object by VID
$response = $cb->fetchByVid($cbVid);
if($response['returnCode'] == 200) {
$fetchedCb = $response['data']->chargeback;
}
else {
// The call was unsuccessful
print "Return code: " . $response['returnCode'] . "\n";
print "Return string: " . $response['returnString'] . "\n";
}
For Users
Learn More