PayPal\Service\PayPalAPIInterfaceServiceService::BillAgreementUpdate PHP Method

BillAgreementUpdate() public method

Service Call: BillAgreementUpdate
public BillAgreementUpdate ( BillAgreementUpdateReq $billAgreementUpdateReq, mixed $apiCredential = null ) : BAUpdateResponseType
$billAgreementUpdateReq PayPal\PayPalAPI\BillAgreementUpdateReq
$apiCredential mixed - Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return PayPal\PayPalAPI\BAUpdateResponseType
    public function BillAgreementUpdate($billAgreementUpdateReq, $apiCredential = null)
    {
        $apiContext = new PPApiContext($this->config);
        $handlers = array(new PPMerchantServiceHandler($apiCredential, self::$SDK_NAME, self::$SDK_VERSION));
        $this->setStandardParams($billAgreementUpdateReq->BAUpdateRequest);
        $ret = new BAUpdateResponseType();
        $resp = $this->call('PayPalAPI', 'BillAgreementUpdate', $billAgreementUpdateReq, $apiContext, $handlers);
        $ret->init(PPUtils::xmlToArray($resp));
        return $ret;
    }

Usage Example

use PayPal\PayPalAPI\BillAgreementUpdateReq;
use PayPal\Service\PayPalAPIInterfaceServiceService;
require_once '../PPBootStrap.php';
/*
 * update billing agreement
 */
$BAUpdateRequest = new BAUpdateRequestType($_REQUEST['referenceID']);
$BAUpdateRequest->BillingAgreementStatus = $_REQUEST['billingAgreementStatus'];
$BAUpdateRequest->BillingAgreementDescription = $_REQUEST['billingAgreementDescription'];
$billingAgreementUpdateReq = new BillAgreementUpdateReq();
$billingAgreementUpdateReq->BAUpdateRequest = $BAUpdateRequest;
/*
Configuration::getAcctAndConfig() returns array that contains credential and config parameters
*/
$paypalService = new PayPalAPIInterfaceServiceService(Configuration::getAcctAndConfig());
try {
    /* wrap API method calls on the service object with a try catch */
    $BAUpdatResponse = $paypalService->BillAgreementUpdate($billingAgreementUpdateReq);
} catch (Exception $ex) {
    include_once "../Error.php";
    exit;
}
if (isset($BAUpdatResponse)) {
    echo "<table>";
    echo "<tr><td>Ack :</td><td><div id='Ack'>{$BAUpdatResponse->Ack}</div> </td></tr>";
    echo "</table>";
    echo "<pre>";
    print_r($BAUpdatResponse);
    echo "</pre>";
}
require_once '../Response.php';