'Paypal REST API: How to retrieve payment ID after user has approved the payment.

By following the guide on https://developer.paypal.com/webapps/developer/docs/integration/web/accept-paypal-payment/ , I have successfully created a payment and redirect the user to approve it.

The created payment is something look like bellow, and I save it in user's session for further reference. 

{
  "id": "PAY-6RV70583SB702805EKEYSZ6Y",
  "create_time": "2013-03-01T22:34:35Z",
  "update_time": "2013-03-01T22:34:36Z",
  "state": "created",
  "intent": "sale",
  "payer": {
    "payment_method": "paypal"
  },
  "transactions": [
    {
      "amount": {
        "total": "7.47",
        "currency": "USD",
        "details": {
          "subtotal": "7.47"
        }
      },
      "description": "This is the payment transaction description."
    }
  ],
  "links": [
    {
      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-6RV70583SB702805EKEYSZ6Y",
      "rel": "self",
      "method": "GET"
    },
    {
      "href": "https://www.sandbox.paypal.com/webscr?cmd=_express-checkout&token=EC-60U79048BN7719609",
      "rel": "approval_url",
      "method": "REDIRECT"
    },
    {
      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-6RV70583SB702805EKEYSZ6Y/execute",
      "rel": "execute",
      "method": "POST"
    }
  ]
}

After user approved the payment, Paypal will redirect the user to the return_url. For example, http://<return_url>?token=EC-60U79048BN7719609&PayerID=7E7MGXCWTTKK2.

In order to execute the payment, a POST request has to made to https://api.sandbox.paypal.com/v1/payments/payment/{payment_id}/execute/.

Question

The only two pieces of information provided from Paypal in the URL is token and PayerID. How can I find the corresponding payment_id?

Possible Solution

The token is part of the approval_url, parse the URL and store the token -> payment relationship can solve the problem. But I'm looking for a better solution that doesn't require parsing.

paypal


Solution 1:[1]

You would have to remember the Payment ID on your side (typically attached with your user session - shopping cart or order or as a session cookie) before redirecting the user to PayPal approval url. Once the is redirected back to your return Url along with the PayerID - you would need to extract the PaymentID from your user session and execute the Payment.

Solution 2:[2]

The Payment Id can be obtained in PHP by using the following method after the first API request has returned a successful response:

$payment->getId();

The online code sample (http://paypal.github.io/PayPal-PHP-SDK/sample/doc/payments/CreatePaymentUsingPayPal.html) shows how to send the request, however it does not include the getId() method.

To find this out I had to look in the downloaded SDK files at the file sample\payments\CreatePayment.php which has the following example code showing the use of this method:

ResultPrinter::printResult('Create Payment Using Credit Card', 'Payment', $payment->getId(), $request, $payment);

Solution 3:[3]

I found this link to be extremely helpful, in case anyone wants to check it out: https://github.com/paypal/PayPal-NET-SDK/issues/79

Solution 4:[4]

Since the v1/payments API has been deprecated for some time now, the best solution is to use the current v2/checkout/orders API for all new integrations. The order ID is returned in the URL.

However, redirects are an old integration method, for old websites. It is preferred to not use any redirects, at all, and keep your site loaded at ALL times. Instead use this approval flow: https://developer.paypal.com/demo/checkout/#/pattern/server

Solution 5:[5]

  1. paymentid:

After you created the payment, in return json, you can get paymentid. like this: "id":"PAY-01K00482KX842131HKORKVKY"

  1. payerid:

you can use API:GET /v1/payments/payment/{paymentId} to get payer id after user approved the payment,and you will find payerid in return json,like this:

{
    "id":"PAY-01K00482KX842131HKORKVKY",
    "create_time":"2014-06-19T09:17:31Z",
    "update_time":"2014-06-19T09:17:31Z",
    "state":"created",
    "intent":"sale",
    "payer":{
            "payment_method":"paypal",
            "payer_info":{
                    "email":"[email protected]",
                    "first_name":"buyer",
                    "last_name":"samsung",
                    "payer_id":"H2DKRTTYWW8HS",
                    "shipping_address":{                                              "line1":"Lushan Road Num.188",                                              "line2":"JianYe",
                                              "city":"Tucson",
                                                   "state":"AZ",   
                                                   "postal_code":"85715", 
                                                   "country_code":"US",
                                                    "recipientName":"buyer samsung"}}},
    "transactions":[{
                           "amount":{
                                        "total":"12.00",
                                        "currency":"USD",
                                        "details"{"subtotal":"12.00"}},
                 "description":"creating a payment"}],
    "links":[
                   {"href":"xxxxxxx","rel":"self","method":"GET"},
              {"href":"xxxxxxx","rel":"approval_url","method":"REDIRECT"},
              {"href":"xxxxxxx","rel":"execute","method":"POST"}]}

Sources

This article follows the attribution requirements of Stack Overflow and is licensed under CC BY-SA 3.0.

Source: Stack Overflow

Solution Source
Solution 1 Praveen
Solution 2 Andrew Van Duivenbode
Solution 3 Codet
Solution 4 Preston PHX
Solution 5 Shevliaskovic

Related Questions