PayPal\Service\AdaptivePaymentsService::CancelPreapproval PHP Méthode

CancelPreapproval() public méthode

Service Call: CancelPreapproval
public CancelPreapproval ( CancelPreapprovalRequest $cancelPreapprovalRequest, mixed $apiCredential = NULL ) : Types\AP\CancelPreapprovalResponse
$cancelPreapprovalRequest CancelPreapprovalRequest
$apiCredential mixed - Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
Résultat Types\AP\CancelPreapprovalResponse
    public function CancelPreapproval($cancelPreapprovalRequest, $apiCredential = NULL)
    {
        $ret = new CancelPreapprovalResponse();
        $apiContext = new PPApiContext($this->config);
        $handlers = array(new PPPlatformServiceHandler($apiCredential, self::$SDK_NAME, self::$SDK_VERSION));
        $resp = $this->call('AdaptivePayments', 'CancelPreapproval', $cancelPreapprovalRequest, $apiContext, $handlers);
        $ret->init(PPUtils::nvpToMap($resp));
        return $ret;
    }

Usage Example

 * (Required) Information common to each API operation, such as the language in which an error message is returned.
 */
$requestEnvelope = new RequestEnvelope("en_US");
/*
 * (Required) The preapproval key that identifies the preapproval to be canceled. 
 */
$cancelPreapprovalReq = new CancelPreapprovalRequest($requestEnvelope, $_POST['preapprovalKey']);
/*
* 	 ## Creating service wrapper object
Creating service wrapper object to make API call and loading
Configuration::getAcctAndConfig() returns array that contains credential and config parameters
*/
$service = new AdaptivePaymentsService(Configuration::getAcctAndConfig());
try {
    /* wrap API method calls on the service object with a try catch */
    $response = $service->CancelPreapproval($cancelPreapprovalReq);
} catch (Exception $ex) {
    require_once 'Common/Error.php';
    exit;
}
?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head>
<title>PayPal Adaptive Payments - Cancel Preapproval</title>
<link href="Common/sdk.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="Common/sdk_functions.js"></script>
</head>

<body>
<div id="wrapper">