Inheritance diagram for Omnipay\PayPal\Message\RestSearchTransactionRequest:

Public Member Functions
	getAgreementId ()

	getAgreementId ()

	getData ()

	getData ()

	getEndDate ()

	getEndDate ()

	getEndpoint ()

	getEndpoint ()

	getStartDate ()

	getStartDate ()

	setAgreementId ($value)

	setAgreementId ($value)

	setEndDate ($value)

	setEndDate ($value)

	setStartDate ($value)

	setStartDate ($value)

Public Member Functions inherited from Omnipay\PayPal\Message\AbstractRestRequest
	getClientId ()

	getClientId ()

	getPayerId ()

	getPayerId ()

	getSecret ()

	getSecret ()

	getToken ()

	getToken ()

	sendData ($data)

	sendData ($data)

	setClientId ($value)

	setClientId ($value)

	setPayerId ($value)

	setPayerId ($value)

	setSecret ($value)

	setSecret ($value)

	setToken ($value)

	setToken ($value)

	toJSON ($data, $options=0)

	toJSON ($data, $options=0)

Public Member Functions inherited from Omnipay\Common\Message\AbstractRequest
	__construct (ClientInterface $httpClient, HttpRequest $httpRequest)

	__construct (ClientInterface $httpClient, HttpRequest $httpRequest)

	formatCurrency ($amount)

	formatCurrency ($amount)

	getAmount ()

	getAmount ()

	getAmountInteger ()

	getAmountInteger ()

	getCancelUrl ()

	getCancelUrl ()

	getCard ()

	getCard ()

	getCardReference ()

	getCardReference ()

	getClientIp ()

	getClientIp ()

	getCurrency ()

	getCurrency ()

	getCurrencyDecimalPlaces ()

	getCurrencyDecimalPlaces ()

	getCurrencyNumeric ()

	getCurrencyNumeric ()

	getDescription ()

	getDescription ()

	getIssuer ()

	getIssuer ()

	getItems ()

	getItems ()

	getNotifyUrl ()

	getNotifyUrl ()

	getParameters ()

	getPaymentMethod ()

	getPaymentMethod ()

	getResponse ()

	getResponse ()

	getReturnUrl ()

	getReturnUrl ()

	getTestMode ()

	getTestMode ()

	getTransactionId ()

	getTransactionId ()

	getTransactionReference ()

	getTransactionReference ()

	initialize (array $parameters=array())

	initialize (array $parameters=array())

	send ()

	send ()

	setAmount ($value)

	setAmount ($value)

	setAmountInteger ($value)

	setCancelUrl ($value)

	setCancelUrl ($value)

	setCard ($value)

	setCard ($value)

	setCardReference ($value)

	setCardReference ($value)

	setClientIp ($value)

	setClientIp ($value)

	setCurrency ($value)

	setCurrency ($value)

	setDescription ($value)

	setDescription ($value)

	setIssuer ($value)

	setIssuer ($value)

	setItems ($items)

	setItems ($items)

	setMoney (Money $value)

	setNotifyUrl ($value)

	setNotifyUrl ($value)

	setPaymentMethod ($value)

	setPaymentMethod ($value)

	setReturnUrl ($value)

	setReturnUrl ($value)

	setTestMode ($value)

	setTestMode ($value)

	setTransactionId ($value)

	setTransactionId ($value)

	setTransactionReference ($value)

	setTransactionReference ($value)

	toFloat ($value)

	validate ()

Protected Member Functions
	getHttpMethod ()

	getHttpMethod ()

Protected Member Functions inherited from Omnipay\PayPal\Message\AbstractRestRequest
	createResponse ($data, $statusCode)

	createResponse ($data, $statusCode)

Protected Member Functions inherited from Omnipay\Common\Message\AbstractRequest
	getCurrencies ()

	getParameter ($key)

	setParameter ($key, $value)

	setParameter ($key, $value)

Additional Inherited Members
Data Fields inherited from Omnipay\PayPal\Message\AbstractRestRequest
const	API_VERSION = 'v1'

Protected Attributes inherited from Omnipay\PayPal\Message\AbstractRestRequest
	$liveEndpoint = 'https://api.paypal.com'

	$payerId = null

	$testEndpoint = 'https://api.sandbox.paypal.com'

Protected Attributes inherited from Omnipay\Common\Message\AbstractRequest
	$currencies

	$httpClient

	$httpRequest

	$negativeAmountAllowed = false

	$parameters

	$response

	$zeroAmountAllowed = true

Detailed Description

PayPal REST Search Transaction Request

Use this call to search for the transactions within a billing agreement. Note that this is not a generic transaction search function – for that see RestListPurchaseRequest. It only searches for transactions within a billing agreement.

This should be used on a regular basis to determine the success / failure state of transactions on active billing agreements.

Example

// List the transactions for a billing agreement. $transaction = $gateway->listPurchase(); $response = $transaction->send(); $data = $response->getData(); echo "Gateway listPurchase response data == " . print_r($data, true) . "\n";

Request Sample

This is from the PayPal web site:

curl -v GET https://api.sandbox.paypal.com/v1/payments/billing-agreements/I-0LN988D3JACS/transactions \ -H 'Content-Type:application/json' \ -H 'Authorization: Bearer <Access-Token>'

Response Sample

This is from the PayPal web site:

{ "agreement_transaction_list": [ { "transaction_id": "I-0LN988D3JACS", "status": "Created", "transaction_type": "Recurring Payment", "payer_email": "bbuyer@example.com", "payer_name": "Betsy Buyer", "time_stamp": "2014-06-09T09:29:36Z", "time_zone": "GMT" }, { "transaction_id": "928415314Y5640008", "status": "Completed", "transaction_type": "Recurring Payment", "amount": { "currency": "USD", "value": "1.00" }, "fee_amount": { "currency": "USD", "value": "-0.33" }, "net_amount": { "currency": "USD", "value": "0.67" }, "payer_email": "bbuyer@example.com", "payer_name": "Betsy Buyer", "time_stamp": "2014-06-09T09:42:47Z", "time_zone": "GMT" }, { "transaction_id": "I-0LN988D3JACS", "status": "Suspended", "transaction_type": "Recurring Payment", "payer_email": "bbuyer@example.com", "payer_name": "Betsy Buyer", "time_stamp": "2014-06-09T11:18:34Z", "time_zone": "GMT" }, { "transaction_id": "I-0LN988D3JACS", "status": "Reactivated", "transaction_type": "Recurring Payment", "payer_email": "bbuyer@example.com", "payer_name": "Betsy Buyer", "time_stamp": "2014-06-09T11:18:48Z", "time_zone": "GMT" } ] }

Known Issues

PayPal subscription payments cannot be refunded. PayPal is working on this functionality for their future API release. In order to refund a PayPal subscription payment, you will need to use the PayPal web interface to refund it manually.

See also: RestCreateSubscriptionRequest PayPal REST Search Transaction Request Use this call to search for the transactions within a billing agreement. Note that this is not a generic transaction search function – for that see RestListPurchaseRequest. It only searches for transactions within a billing agreement. This should be used on a regular basis to determine the success / failure state of transactions on active billing agreements. autotoc_md108 Example // List the transactions for a billing agreement. $transaction = $gateway->listPurchase(); $response = $transaction->send(); $data = $response->getData(); echo "Gateway listPurchase response data == " . print_r($data, true) . "\n"; autotoc_md109 Request Sample This is from the PayPal web site: curl -v GET https://api.sandbox.paypal.com/v1/payments/billing-agreements/I-0LN988D3JACS/transactions \ -H 'Content-Type:application/json' \ -H 'Authorization: Bearer <Access-Token>' autotoc_md110 Response Sample This is from the PayPal web site: { "agreement_transaction_list": [ { "transaction_id": "I-0LN988D3JACS", "status": "Created", "transaction_type": "Recurring Payment", "payer_email": "bbuyer@example.com", "payer_name": "Betsy Buyer", "time_stamp": "2014-06-09T09:29:36Z", "time_zone": "GMT" }, { "transaction_id": "928415314Y5640008", "status": "Completed", "transaction_type": "Recurring Payment", "amount": { "currency": "USD", "value": "1.00" }, "fee_amount": { "currency": "USD", "value": "-0.33" }, "net_amount": { "currency": "USD", "value": "0.67" }, "payer_email": "bbuyer@example.com", "payer_name": "Betsy Buyer", "time_stamp": "2014-06-09T09:42:47Z", "time_zone": "GMT" }, { "transaction_id": "I-0LN988D3JACS", "status": "Suspended", "transaction_type": "Recurring Payment", "payer_email": "bbuyer@example.com", "payer_name": "Betsy Buyer", "time_stamp": "2014-06-09T11:18:34Z", "time_zone": "GMT" }, { "transaction_id": "I-0LN988D3JACS", "status": "Reactivated", "transaction_type": "Recurring Payment", "payer_email": "bbuyer@example.com", "payer_name": "Betsy Buyer", "time_stamp": "2014-06-09T11:18:48Z", "time_zone": "GMT" } ] } autotoc_md111 Known Issues PayPal subscription payments cannot be refunded. PayPal is working on this functionality for their future API release. In order to refund a PayPal subscription payment, you will need to use the PayPal web interface to refund it manually. RestCreateSubscriptionRequest https://developer.paypal.com/docs/api/#search-for-transactions

Definition at line 107 of file lib/vendor/omnipay/paypal/src/Message/RestSearchTransactionRequest.php.

Member Function Documentation

◆ getAgreementId() [1/2]

Omnipay\PayPal\Message\RestSearchTransactionRequest::getAgreementId ( )

Get the agreement ID

Returns: string

Definition at line 114 of file lib/vendor/omnipay/paypal/src/Message/RestSearchTransactionRequest.php.

References Omnipay\Common\Message\AbstractRequest\getParameter().

Referenced by Omnipay\PayPal\Message\RestSearchTransactionRequest\getEndpoint().

◆ getAgreementId() [2/2]

Omnipay\PayPal\Message\RestSearchTransactionRequest::getAgreementId ( )

Get the agreement ID

Returns: string

Definition at line 114 of file vendor/omnipay/paypal/src/Message/RestSearchTransactionRequest.php.

References Omnipay\Common\Message\AbstractRequest\getParameter().

◆ getData() [1/2]

Omnipay\PayPal\Message\RestSearchTransactionRequest::getData ( )

Get the raw data array for this message. The format of this varies from gateway to gateway, but will usually be either an associative array, or a SimpleXMLElement.

Returns: mixed

Implements Omnipay\Common\Message\MessageInterface.

Definition at line 172 of file vendor/omnipay/paypal/src/Message/RestSearchTransactionRequest.php.

References Omnipay\PayPal\Message\RestSearchTransactionRequest\getEndDate(), Omnipay\PayPal\Message\RestSearchTransactionRequest\getStartDate(), and Omnipay\Common\Message\AbstractRequest\validate().

◆ getData() [2/2]

Omnipay\PayPal\Message\RestSearchTransactionRequest::getData ( )

Get the raw data array for this message. The format of this varies from gateway to gateway, but will usually be either an associative array, or a SimpleXMLElement.