Skip to main content
Vindicia Knowledge Center

Account.grantEntitlement

Account.grantEntitlement

Account.grantEntitlement

The grantEntitlement method grants entitlements to an Account.

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.

account: the Account to which this grant applies.

entitlement: the Entitlement being granted.

note: an optional memo regarding the entitlement grant.

Output

return: an object of type Return that indicates the success or failure of the call.

account: the Account with new entitlements.

Returns

In addition to those listed in Standard Return Codes, this call returns:

Return Code

Return String

400

One of the following:

  • Entitlement not specified.
  • Base Account not specified.
  • Account not found.
  • Entitlement grant failed: error-description.
  • Failed to save Account after entitlement extension: error-description.
  • Failed to reload account after entitlement extension: error-description.

Example

$acct = new Account();
$acct->setMerchantAccountId('xyz123');

$entitle = new Entitlement();
$entitle->setDescription('For playing Scrabble');
$entitle->setStartTimestamp($today);
$entitle->setEndTimestamp($tomorrow);
$entitle->setMerchantEntitlementId('bac');

$response = $acct->grantEntitlement($entitle);

// check $response

For Users

Learn More
For Users

Cashbox Features

Learn More
Cashbox Features
Back to Top