Class VerifyWebhookSignature

Class VerifyWebhookSignature

Verify webhook signature.

PayPal\Common\PayPalModel

Extended by

PayPal\Common\PayPalResourceModel implements PayPal\Rest\IResource

Extended by

PayPal\Api\VerifyWebhookSignature

Namespace: PayPal\Api
Package: PayPal\Api
Located at PayPal/Api/VerifyWebhookSignature.php

Methods summary

`public`	# `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. 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. Parameters `$auth_algo` Returns $this
`public string`	# `getAuthAlgo( )` 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. 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. Returns string
`public`	# `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. 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. Parameters `$cert_url` Returns $this Throws InvalidArgumentException
`public string`	# `getCertUrl( )` 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. 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. Returns string
`public`	# `setTransmissionId( string $transmission_id )` The ID of the HTTP transmission. Contained in the `PAYPAL-TRANSMISSION-ID` header of the notification message. The ID of the HTTP transmission. Contained in the `PAYPAL-TRANSMISSION-ID` header of the notification message. Parameters `$transmission_id` Returns $this
`public string`	# `getTransmissionId( )` The ID of the HTTP transmission. Contained in the `PAYPAL-TRANSMISSION-ID` header of the notification message. The ID of the HTTP transmission. Contained in the `PAYPAL-TRANSMISSION-ID` header of the notification message. Returns string
`public`	# `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. The PayPal-generated asymmetric signature. Extract this value from the `PAYPAL-TRANSMISSION-SIG` response header, which is received with the webhook notification. Parameters `$transmission_sig` Returns $this
`public string`	# `getTransmissionSig( )` The PayPal-generated asymmetric signature. Extract this value from the `PAYPAL-TRANSMISSION-SIG` response header, which is received with the webhook notification. The PayPal-generated asymmetric signature. Extract this value from the `PAYPAL-TRANSMISSION-SIG` response header, which is received with the webhook notification. Returns string
`public`	# `setTransmissionTime( string $transmission_time )` The date and time of the HTTP transmission. Contained in the `PAYPAL-TRANSMISSION-TIME` header of the notification message. The date and time of the HTTP transmission. Contained in the `PAYPAL-TRANSMISSION-TIME` header of the notification message. Parameters `$transmission_time` Returns $this
`public string`	# `getTransmissionTime( )` The date and time of the HTTP transmission. Contained in the `PAYPAL-TRANSMISSION-TIME` header of the notification message. The date and time of the HTTP transmission. Contained in the `PAYPAL-TRANSMISSION-TIME` header of the notification message. Returns string
`public`	# `setWebhookId( string $webhook_id )` The ID of the webhook as configured in your Developer Portal account. The ID of the webhook as configured in your Developer Portal account. Parameters `$webhook_id` Returns $this
`public string`	# `getWebhookId( )` The ID of the webhook as configured in your Developer Portal account. The ID of the webhook as configured in your Developer Portal account. Returns string
`public`	# `setWebhookEvent( PayPal\Api\WebhookEvent $webhook_event )` The webhook notification, which is the content of the HTTP `POST` request body. The webhook notification, which is the content of the HTTP `POST` request body. Deprecated Please use setRequestBody($request_body) instead. Parameters `$webhook_event` Returns $this
`public PayPal\Api\WebhookEvent`	# `getWebhookEvent( )` The webhook notification, which is the content of the HTTP `POST` request body. The webhook notification, which is the content of the HTTP `POST` request body. Returns `PayPal\Api\WebhookEvent`
`public`	# `setRequestBody( string $request_body )` The content of the HTTP `POST` request body of the webhook notification you received as a string. The content of the HTTP `POST` request body of the webhook notification you received as a string. Parameters `$request_body` Returns $this
`public string`	# `getRequestBody( )` The content of the HTTP `POST` request body of the webhook notification you received as a string. The content of the HTTP `POST` request body of the webhook notification you received as a string. Returns string
`public PayPal\Api\VerifyWebhookSignatureResponse`	# `post( PayPal\Rest\ApiContext $apiContext = null, PayPalRestCall $restCall = null )` Verifies a webhook signature. Verifies a webhook signature. Parameters `$apiContext` is the APIContext for this call. It can be used to pass dynamic configuration and credentials. `$restCall` is the Rest Call Service that is used to make rest calls Returns `PayPal\Api\VerifyWebhookSignatureResponse`
`public string`	# `toJSON( integer $options = 0 )` Returns object JSON representation Returns object JSON representation Parameters `$options` http://php.net/manual/en/json.constants.php Returns string Overrides `PayPal\Common\PayPalModel::toJSON`

Methods inherited from PayPal\Common\PayPalResourceModel

addLink(), executeCall(), getLink(), getLinks(), removeLink(), setLinks(), updateAccessToken()

Methods inherited from PayPal\Common\PayPalModel

__construct(), __get(), __isset(), __set(), __toString(), __unset(), fromArray(), fromJson(), getList(), setCredential(), toArray()

Properties summary

Properties inherited from PayPal\Common\PayPalModel