PHP Class Omnipay\PayPal\Message\RestSearchTransactionRequest

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 ' ### Response Sample This is from the PayPal web site: { "agreement_transaction_list": [ { "transaction_id": "I-0LN988D3JACS", "status": "Created", "transaction_type": "Recurring Payment", "payer_email": "[email protected]", "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": "[email protected]", "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": "[email protected]", "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": "[email protected]", "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
Inheritance: extends AbstractRestRequest
Mostra file Open project: omnipay/paypal Class Usage Examples

Public Methods

Method Description
getAgreementId ( ) : string Get the agreement ID
getData ( )
getEndDate ( ) : string Get the request endDate
getEndpoint ( )
getStartDate ( ) : string Get the request startDate
setAgreementId ( string $value ) : RestSearchTransactionRequest Set the agreement ID
setEndDate ( string | DateTime $value ) : RestSearchTransactionRequest Set the request endDate
setStartDate ( string | DateTime $value ) : RestSearchTransactionRequest Set the request startDate

Protected Methods

Method Description
getHttpMethod ( ) : string Get HTTP Method.

Method Details

getAgreementId() public method

Get the agreement ID
public getAgreementId ( ) : string
return string

getData() public method

public getData ( )

getEndDate() public method

Get the request endDate
public getEndDate ( ) : string
return string

getEndpoint() public method

public getEndpoint ( )

getHttpMethod() protected method

The HTTP method for searchTransaction requests must be GET.
protected getHttpMethod ( ) : string
return string

getStartDate() public method

Get the request startDate
public getStartDate ( ) : string
return string

setAgreementId() public method

Set the agreement ID
public setAgreementId ( string $value ) : RestSearchTransactionRequest
$value string
return RestSearchTransactionRequest provides a fluent interface.

setEndDate() public method

Set the request endDate
public setEndDate ( string | DateTime $value ) : RestSearchTransactionRequest
$value string | DateTime
return RestSearchTransactionRequest provides a fluent interface.

setStartDate() public method

Set the request startDate
public setStartDate ( string | DateTime $value ) : RestSearchTransactionRequest
$value string | DateTime
return RestSearchTransactionRequest provides a fluent interface.