PHP Class PayPal\Api\VerifyWebhookSignature

Verify webhook signature.

Inheritance: extends PayPal\Common\PayPalResourceModel

显示文件 Open project: paypal/rest-api-sdk-php Class Usage Examples

Public Methods

Method	Description
getAuthAlgo ( ) : string	The algorithm that PayPal uses to generate the signature and that you can use to verify the signature. Extract this value from the PAYPAL-AUTH-ALGO response header, which is received with the webhook notification.
getCertUrl ( ) : string	The X.509 public key certificate. Download the certificate from this URL and use it to verify the signature. Extract this value from the PAYPAL-CERT-URL response header, which is received with the webhook notification.
getTransmissionId ( ) : string	The ID of the HTTP transmission. Contained in the PAYPAL-TRANSMISSION-ID header of the notification message.
getTransmissionSig ( ) : string	The PayPal-generated asymmetric signature. Extract this value from the PAYPAL-TRANSMISSION-SIG response header, which is received with the webhook notification.
getTransmissionTime ( ) : string	The date and time of the HTTP transmission. Contained in the PAYPAL-TRANSMISSION-TIME header of the notification message.
getWebhookEvent ( ) : WebhookEvent	The webhook notification, which is the content of the HTTP POST request body.
getWebhookId ( ) : string	The ID of the webhook as configured in your Developer Portal account.
post ( ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : VerifyWebhookSignatureResponse	Verifies a webhook signature.
setAuthAlgo ( string $auth_algo )	The algorithm that PayPal uses to generate the signature and that you can use to verify the signature. Extract this value from the PAYPAL-AUTH-ALGO response header, which is received with the webhook notification.
setCertUrl ( string $cert_url )	The X.509 public key certificate. Download the certificate from this URL and use it to verify the signature. Extract this value from the PAYPAL-CERT-URL response header, which is received with the webhook notification.
setTransmissionId ( string $transmission_id )	The ID of the HTTP transmission. Contained in the PAYPAL-TRANSMISSION-ID header of the notification message.
setTransmissionSig ( string $transmission_sig )	The PayPal-generated asymmetric signature. Extract this value from the PAYPAL-TRANSMISSION-SIG response header, which is received with the webhook notification.
setTransmissionTime ( string $transmission_time )	The date and time of the HTTP transmission. Contained in the PAYPAL-TRANSMISSION-TIME header of the notification message.
setWebhookEvent ( WebhookEvent $webhook_event )	The webhook notification, which is the content of the HTTP POST request body.
setWebhookId ( string $webhook_id )	The ID of the webhook as configured in your Developer Portal account.

Method Details

getAuthAlgo() public method

The algorithm that PayPal uses to generate the signature and that you can use to verify the signature. Extract this value from the PAYPAL-AUTH-ALGO response header, which is received with the webhook notification.

public getAuthAlgo ( ) : string
return	string

getCertUrl() public method

The X.509 public key certificate. Download the certificate from this URL and use it to verify the signature. Extract this value from the PAYPAL-CERT-URL response header, which is received with the webhook notification.

public getCertUrl ( ) : string
return	string

getTransmissionId() public method

The ID of the HTTP transmission. Contained in the PAYPAL-TRANSMISSION-ID header of the notification message.

public getTransmissionId ( ) : string
return	string

getTransmissionSig() public method

The PayPal-generated asymmetric signature. Extract this value from the PAYPAL-TRANSMISSION-SIG response header, which is received with the webhook notification.

public getTransmissionSig ( ) : string
return	string

getTransmissionTime() public method

The date and time of the HTTP transmission. Contained in the PAYPAL-TRANSMISSION-TIME header of the notification message.

public getTransmissionTime ( ) : string
return	string

getWebhookEvent() public method

The webhook notification, which is the content of the HTTP POST request body.

public getWebhookEvent ( ) : WebhookEvent
return	WebhookEvent

getWebhookId() public method

The ID of the webhook as configured in your Developer Portal account.

public getWebhookId ( ) : string
return	string

post() public method

Verifies a webhook signature.

public post ( ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : VerifyWebhookSignatureResponse
$apiContext	PayPal\Rest\ApiContext	is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
$restCall	PayPalRestCall	is the Rest Call Service that is used to make rest calls
return	VerifyWebhookSignatureResponse

setAuthAlgo() public method

public setAuthAlgo ( string $auth_algo )
$auth_algo	string

setCertUrl() public method

public setCertUrl ( string $cert_url )
$cert_url	string

setTransmissionId() public method

The ID of the HTTP transmission. Contained in the PAYPAL-TRANSMISSION-ID header of the notification message.

public setTransmissionId ( string $transmission_id )
$transmission_id	string

setTransmissionSig() public method

The PayPal-generated asymmetric signature. Extract this value from the PAYPAL-TRANSMISSION-SIG response header, which is received with the webhook notification.

public setTransmissionSig ( string $transmission_sig )
$transmission_sig	string

setTransmissionTime() public method

The date and time of the HTTP transmission. Contained in the PAYPAL-TRANSMISSION-TIME header of the notification message.

public setTransmissionTime ( string $transmission_time )
$transmission_time	string

setWebhookEvent() public method

The webhook notification, which is the content of the HTTP POST request body.

public setWebhookEvent ( WebhookEvent $webhook_event )
$webhook_event	WebhookEvent

setWebhookId() public method

The ID of the webhook as configured in your Developer Portal account.

public setWebhookId ( string $webhook_id )
$webhook_id	string