PHP Класс 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.
Показать файл
Открыть проект
Примеры использования класса
Открытые методы
Защищенные методы
Описание методов
getAgreementId()
публичный Метод
getData()
публичный Метод
getEndDate()
публичный Метод
getEndpoint()
публичный Метод
getHttpMethod()
защищенный Метод
The HTTP method for searchTransaction requests must be GET.
getStartDate()
публичный Метод
Get the request startDate
setAgreementId()
публичный Метод
public setAgreementId ( string $value ) : RestSearchTransactionRequest |
$value |
string |
|
Результат |
RestSearchTransactionRequest |
provides a fluent interface. |
setEndDate()
публичный Метод
public setEndDate ( string | DateTime $value ) : RestSearchTransactionRequest |
$value |
string | DateTime |
|
Результат |
RestSearchTransactionRequest |
provides a fluent interface. |
setStartDate()
публичный Метод
Set the request startDate
public setStartDate ( string | DateTime $value ) : RestSearchTransactionRequest |
$value |
string | DateTime |
|
Результат |
RestSearchTransactionRequest |
provides a fluent interface. |