PayPal Pay Later

Overview

Introduction

PayPal Pay Later is a payment method which allows to process payments in euros, pounds, US and Australian dollars by using the PayPal e-wallet in Australia, USA and several European countries. Customers can pay for orders in installments and on credit, the terms of installments and credit are determined as a result of interaction between the customer and PayPal. This method supports purchases and refunds.

This article provides information about working with the PayPal Pay Later method: general insights are presented in the Overview section, while information about the actions required to process payments and perform other actions is presented in the sections that follow.

General information

Payment method type digital wallet payments
Payment instruments digital wallets
Countries and regions AU, DE, ES, FR, IT, GB, US
Payment currencies AUD, EUR, GBP, USD
Currency conversion on the ecommpay side
One-time purchases +
Credential-on-file purchases
Full refunds +
Partial refunds +
Payouts
Chargebacks +
Notes for merchants registered in the USA there are limitations regarding regions available for payment processing (for more information refer to your ecommpay key account manager)
Onboarding and access fee refer to your ecommpay key account manager

Onboarding

To enable this payment method the merchant needs to grant ecommpay the rights to process payments in the PayPal service (onboarding). Such rights include the right to process purchases and refunds. To grant any of these rights the merchant is required to do the following:

  1. Inform the ecommpay key account manager about the readiness to enable the PayPal Pay Later payment method.
  2. Receive the email with the link to PayPal website from ecommpay.
  3. Follow the link and grant ecommpay the right to process payments. An existing PayPal business account can be used or a new one can be registered.
  4. Receive the email from ecommpay which confirms the right to process payments with the specified PayPal merchant identifier. After that, the technical setup on the ecommpay side must be performed. Usually the setup is complete within three days.
  5. Receive the email from ecommpay which confirms the readiness to process payments by using the PayPal Pay Later method. After that, the onboarding is complete and the payment method is ready to be used.

If necessary, any of the granted rights may be revoked by the merchant on the side of the PayPal service upon confirmation with the ecommpay key account manager.

Interaction diagram

Payment processing by using the PayPal Pay Later payment method involves the merchant's web service, one of ecommpay interfaces, and the ecommpay payment platform,and technical facilities of the PayPal service.

Operations support

Various platform interfaces can be used to process payments and perform operations using the PayPal Pay Later method. Purchases can be processed by using Payment Page, Gate and Dashboard (using payment links), refunds—by using Gate and Dashboard. At the same time, regardless of the interfaces used, the following properties and limitations are applicable.

When working with the PayPal Pay Later the following amount limits are applicable.

Amounts, USD ¹ Times ²
minimum maximum basic threshold
Purchases 30.00 10,000.00 * 1 minute 3 days
Refunds 35 days
Note:
  1. For more information refer to your ecommpay key account manager.
  2. The base and threshold times are defined as follows:
    • The base time is the average estimated time between the moment a payment is initiated in the payment platform to the moment the payment result is sent to the web service. The base time evaluation is made on the assumption of normal operation of all technical facilities and communication channels and typical customer behaviour (if any input from the customer is required). Use the base time to estimate when to react to the absence of payment result callbacks or when to check payment status (details).
    • The threshold time is the maximum possible time between the moment a payment is initiated in the payment platform to the moment the web service receives the callback with the payment result. A payment is automatically assigned the decline status if it wasn't processed within the threshold time. For individual customisation of the threshold time limit, contact ecommpay technical support.

Processing scenarios

To perform a purchase operation, you need to redirect a customer to the PayPal service, while to make a refund, you need to receive a request from the customer and notify the customer about the result of the refund via the web service.

Scenarios for performing operations via the main interfaces of the payment platform correspond to those presented in the diagrams. Similarly, when additional features (such as payment links) are used, scenarios for performing operations also correspond to the specifics of those features.

Purchases by using Payment Page

General information

To process a purchase through Payment Page by using the PayPal Pay Later method, the merchant's web service is required to send a request with all required parameters and signature to the ecommpay URL and receive a callback with the result. The full sequence and special aspects of purchase processing are provided below.



Figure 5. Purchase processing by using Payment Page: step-by-step description
  1. A customer initiates a purchase in the web service.
  2. The web service sends the request for opening Payment Page to the specified ecommpay URL.
  3. The request for opening Payment Page is sent to the payment platform.
  4. The payment platform receives the request and validates the required parameters and signature.
  5. Payment Page is generated based on the project and request parameters.
  6. Payment Page is displayed to the customer.
  7. The customer selects the PayPal Pay Later method.
  8. The payment platform receives the request for processing the payment by using the PayPal Pay Later method.
  9. The payment platform processes the request and sends it to the PayPal service.
  10. The request is processed on the PayPal service side.
  11. The data for redirecting the customer to the PayPal service is sent from the PayPal service to the payment platform.
  12. The data for redirecting the customer is sent from the payment platform to Payment Page.
  13. The customer is redirected to the PayPal service.
  14. The customer completes all required payment steps.
  15. The purchase is processed on the in the PayPal service.
  16. The customer is redirected to Payment Page.
  17. The PayPal service sends a notification about the result to the payment platform.
  18. The payment platform sends the payment result callback to the web service.
  19. The payment platform sends the result information to Payment Page.
  20. The result information is displayed to the customer on Payment Page.

Information about the formats of requests and callbacks used for processing payments by using the PayPal Pay Later method via Payment Page is presented further in this section; general information about working with the Payment Page API is presented in Interaction concepts.

Request format

There are several things you need to consider when sending purchase requests by using the PayPal Pay Later method:

  1. The following parameters required for any payment must be specified:
    • project_id—project identifier obtained from ecommpay during integration
    • payment_id—payment identifier unique within the project
    • payment_currency—payment currency code in the ISO-4217 alpha-3 format
    • payment_amount—payment amount in the smallest currency unit
    • customer_id—customer identifier unique within the project
  2. The following parameters required for any payment must be specified: project_id, payment_id, payment_currency, payment_amount, customer_id.
  3. If you need to have the payment form displayed with the PayPal Pay Later method selected, set the force_payment_method parameter to paypal-wallet and specify the "{\"submethod_code\": \"paylater\"}" value in the payment_methods_options parameter:
    "payment_methods_options": "{\"submethod_code\": \"paylater\"}"
  4. Additionally, any other parameters available for working with Payment Page can be used (details).
  5. After all target parameters are specified, generate a signature (details).

Thus, a correct request for opening the payment form using the PayPal Pay Later method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer identifier and signature.

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 1000,
   "payment_currency": "USD",
   "customer_id": "customer1",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}
Figure 6. Example of sufficient data in a purchase request
{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 1000,
   "payment_currency": "USD",
   "customer_id": "customer1",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

Callback format

The PayPal Pay Later method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks.

The following is the example of a callback with an information about a 10.00 USD purchase in the 210 project.

Figure 7. Example of callback data indicating that the purchase has been processed
{
        "project_id": 210,
        "payment": {
            "id": "test_payment_1",
            "type": "purchase",
            "status": "success",
            "date": "2019-12-25T09:48:29+0000",
            "method": "PayPal Wallet",
            "sum": {
                "amount": 1000,
                "currency": "USD"
            },
            "description": ""
        },
        "account": {
            "number": "VSAFYPWDD123"
        },
        "customer": {
            "id": "7895623"
        },
        "operation": {
            "id": 63460000012251,
            "type": "sale",
            "status": "success",
            "date": "2019-12-25T09:48:29+0000",
            "created_date": "2019-12-25T09:47:54+0000",
            "request_id": "55aa73dcab3dd0a37f3a4eeb72f7-00063461",
            "sum_initial": {
                "amount": 1000,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "USD"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 1556,
                "payment_id": "14C27062M77937123",
                "auth_code": "",
                "date": "2019-12-25T09:48:27+0000"
            }
        },
        "signature": "bLraFo85nfQ+kMyaximHVkuL3THI1oHRkukafnk3A=="
    }

The following is the example of a callback with information about a declined purchase.

Figure 8. Example of callback data indicating that the purchase has been declined
{
        "project_id": 210,
        "payment": {
            "id": "test_payment_2",
            "type": "purchase",
            "status": "decline",
            "date": "2019-12-18T09:00:07+0000",
            "method": "PayPal Wallet",
            "sum": {
                "amount": 900,
                "currency": "USD"
            },
            "description": "test_paypal"
        },
        "customer": {
            "id": "156787"
        },
        "operation": {
            "id": 55628000009581,
            "type": "sale",
            "status": "decline",
            "date": "2019-12-18T09:00:07+0000",
            "created_date": "2019-12-18T08:59:30+0000",
            "request_id": "b8d98d70def1760df9f52dc00ffb6-00055629",
            "sum_initial": {
                "amount": 900,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 900,
                "currency": "USD"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 1556,
                "payment_id": "",
                "auth_code": ""
            }
        },
        "signature": "OEDB1Gox..TOaeB+W8q64WLUnsj6gsW5qen7MrDC2o3Rg=="
    }

Useful links

The following articles can be useful when implementing purchases via Payment Page:

Purchases by using Gate

General information

Overview

Payments via Gate by using the PayPal Pay Later method can be processed in two ways: directly through the Gate API, and also by using the PayPal SDK and Gate API. On the web service side, the differences between the processing ways concern sending requests and redirecting customers, the choice of a specific way remains with the merchant.

Setup of payment processing by using the PayPal SDK and Gate API

Before processing payments via the PayPal SDK and Gate API by using the PayPal Pay Later method, the merchant's web service is required to do the following:

  1. Set up the PayPal SDK in accordance with the official documentation (https://developer.paypal.com/sdk/js/)
  2. Set up the display of the button for selecting this payment method on the web service side, also in accordance with the official documentation (https://developer.paypal.com/docs/checkout/standard/customize/standalone-buttons/, https://developer.paypal.com/demo/checkout/#/pattern/server)
  3. Reference the PayPal JavaScript library on the client side of the web service using the following link.
    <script src="https://www.paypal.com/sdk/js?client-id=<CLIENT_ID>&merchant-id=<MERCHANT_ID>&currency=USD"></script>

    This link uses the variables <CLIENT_ID>—the identifier of the payment platform in the PayPal service, which is determined after granting ecommpay the rights to make payments on behalf of the merchant, and <MERCHANT_ID>—the identifier of the merchant in the PayPal service.

Payment processing by using the PayPal SDK and Gate API

After setting up to process payments through the PayPal SDK and Gate API by using the PayPal Pay Later method, to process each payment the merchant's web service is required to do the following:

  1. Send a request with all the required parameters and signature to the ecommpay URL.
  2. Receive an intermediate callback from the payment platform and redirect the customer to the PayPal service.
  3. Receive the final callback from the payment platform.

The full sequence and special aspects of purchase processing are provided below.



Figure 9. Purchase processing by using the SDK
  1. A customer initiates a purchase by using the PayPal Pay Later method in the web service.
  2. The web service sends the data for generating the purchase request to the PayPal SDK.
  3. The PayPal SDK sends the request for processing the purchase by using Gate to the specified ecommpay URL.
  4. The payment platform receives the request.
  5. The payment platform validates the required parameters and signature in the request.
  6. The payment platform sends the response to the web service with information about the receipt of the request and its validity (details).
  7. The payment platform performs further processing of the request (with parameter consistency check) and sends it to the PayPal service.
  8. The request is processed on the PayPal service side.
  9. The PayPal service sends the redirection data to the payment platform.
  10. The payment platform sends the callback with the redirection data to the web service.
  11. The web service sends the redirection data to the PayPal SDK.
  12. The customer is redirected to the PayPal service by the PayPal SDK.
  13. The customer completes all required payment steps.
  14. The purchase is processed on the side of the PayPal service.
  15. The PayPal service sends the payment result notification to the payment platform.
  16. The payment platform sends the payment result callback to the web service.
  17. The customer receives the payment result information from the web service.

Information about the formats of requests and callbacks used for processing payments by using the PayPal Pay Later method via the PayPal SDK and Gate API is presented further in this section. General information about working with the Gate API is presented in Interaction concepts.

Payment processing by using the Gate API directly

To process payments through Gate directly by using the PayPal Pay Later method, the merchant's web service is required to do the following:

  1. Send a request with all the required parameters and signature to the ecommpay URL.
  2. Receive an intermediate callback from the payment platform and redirect the customer to the PayPal service.
  3. Receive the final callback from the payment platform.

The full sequence and special aspects of purchase processing are provided below.



Figure 10. Purchase processing by using the API directly: step-by-step description
  1. A customer initiates a purchase by using the PayPal Pay Later method in the web service.
  2. The web service sends the request for processing the purchase by using Gate to the specified ecommpay URL.
  3. The payment platform receives the request.
  4. The payment platform validates the required parameters and signature in the request.
  5. The payment platform sends the response to the web service with information about the receipt of the request and its validity (details).
  6. The payment platform performs further processing of the request (with parameter consistency check) and sends it to the PayPal service.
  7. The request is processed on the PayPal service side.
  8. The PayPal service sends the redirection data to the payment platform.
  9. The payment platform sends the callback with the redirection data to the web service.
  10. The customer is redirected to the PayPal service.
  11. The customer completes all required payment steps.
  12. The purchase is processed on the side of the PayPal service.
  13. The customer is redirected to the web service.
  14. The PayPal service sends the payment result notification to the payment platform.
  15. The payment platform sends the payment result callback to the web service.
  16. The customer receives the payment result information from the web service.

Information about the formats of requests and callbacks used for processing payments by using the PayPal Pay Later method via Gate directly is presented further in this section. General information about working with the Gate API is presented in Interaction concepts.

Request format

Parameters to be specified

There are several things you need to consider when sending purchase requests by using the PayPal Pay Later method (regardless of the chosen processing way):

  1. Each request must include the following objects and parameters:
    • Object general—general purchase information:
      • project_id—project identifier obtained from ecommpay during integration
      • payment_id—payment identifier unique within the project
      • signature—request signature generated after all required parameters are specified (details—in the Signature generation and verification) (details)
    • Object payment—payment information:
      • amount—payment amount in the smallest currency unit
      • currency—payment currency code in the ISO-4217 alpha-3 format
      • extra_param—method identifier in the payment platform (the value must be paylater)
    • Object customer—customer information:
      • id—customer identifier unique within the project
      • ip_address—customer IP address relevant for the initiated payment
    • Object return_url—the URLs to which customer is redirected while or after payment processing:
      • success—URL to redirect the customer to the web service after the customer completes all the required actions on the PayPal service side
      • decline—URL to redirect the customer to the web service after the customer doesn't complete all the required actions on the PayPal service side
  2. Additionally, any other parameters included in the specification can be used.

Thus, a correct payment request by using the PayPal Pay Later method must include project and payment IDs, currency and amount of the purchase, customer IP address and URLs for redirection, payment method identifier, as well as signature.

{
  "general": {
    "project_id": 210,
    "payment_id": "test_payment",
    "signature": "PJkV8ej\/UG0Di8hTng6JvC7vQs+AWoXW\/9MTO8yJA=="
  },
  "payment": {
    "amount": 1000,
    "currency": "USD",
    "extra_param": "paylater"
  },
  "customer": {
    "ip_address": "192.0.2.0",
    "id": "customer123"
  },
  "return_url": {
    "success": "http://example.com/success",
    "decline": "http://example.com/decline"
  }
}
Figure 11. Example of sufficient data in a purchase request
{
  "general": {
    "project_id": 210,
    "payment_id": "test_payment",
    "signature": "PJkV8ej\/UG0Di8hTng6JvC7vQs+AWoXW\/9MTO8yJA=="
  },
  "payment": {
    "amount": 1000,
    "currency": "USD",
    "extra_param": "paylater"
  },
  "customer": {
    "ip_address": "192.0.2.0",
    "id": "customer123"
  },
  "return_url": {
    "success": "http://example.com/success",
    "decline": "http://example.com/decline"
  }
}

Sending requests by using the PayPal SDK and Gate API

When sending requests by using the PayPal SDK and Gate API it is necessary that these requests correspond to the format supported by the PayPal SDK. To initiate each purchase send a separate POST request to the /v2/payment/wallet/paypal/sale endpoint.

As an example, the implementation of the request sending function may look like the following.

 const test = {
      createOrder: function (data) {
        return fetch('https://api.ecommpay.com/v2/payment/wallet/paypal/sale', {
          method: 'POST',
          body: JSON.stringify(data),
          });
      },
    };
    test.createOrder({ project_id: 123, payment_amount: '10000', ... })

Sending requests by using the Gate API directly

To initiate each purchase, send a separate POST request to the /v2/payment/wallet/paypal/sale endpoint. This endpoint belongs to the group /v2/payment/wallet/{payment_method}/sale.

Formats of intermediate callbacks for customer redirection

Data format when using the PayPal SDK and Gate API

Each payment made with the PayPal Pay Later method requires redirection of customers from the merchant's web service to the PayPal service. To redirect a customer it is necessary to receive an intermediate callback from the payment platform and use the order identifier on the PayPal service side (orderID) in accordance with the official documentation. This identifier is specified in the payment_id parameter of the provider object included in the operation object. The format of intermediate callbacks is standard (details).

Figure 12. examples of the operation object and the payment_id parameter
"operation": {
            "sum_initial": {
                "amount": 50000,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 50000,
                "currency": "USD"
            },
            "code": "9999",
            "message": "Awaiting processing",
            "provider": {
                "id": 1556,
                "payment_id": "14C27062M77937123",
                "auth_code": ""
            }

Data format when using the Gate API directly

Each payment made with the PayPal Pay Later method requires redirection of customers from the merchant's web service to the PayPal service. To redirect a customer it is necessary to receive an intermediate callback from the payment platform and use the information included in the redirect_data object. The format of such callbacks is standard (details), and the following objects and parameters are included in the redirect_data object:

  • body—object with data to be sent in the request body
  • method—parameter specifying the HTTP method for sending the request (GET or POST)
  • url—parameter containing a link for redirection
Figure 13. redirect_data example
  "redirect_data": {
    "body": {},
    "method": "GET",
    "url": "https://www.example.com/pay"
  }

Final callback format

The PayPal Pay Later method uses the standard format for callbacks to deliver purchase results (regardless of the chosen processing way). For more information, see Callbacks.

The following is the example of a callback with an information about a 10.00 USD one-step purchase in the 210 project.

Figure 14. Example of callback data indicating that the purchase has been processed
{
        "project_id": 210,
        "payment": {
            "id": "test_payment_1",
            "type": "purchase",
            "status": "success",
            "date": "2019-12-25T09:48:29+0000",
            "method": "PayPal Wallet",
            "sum": {
                "amount": 1000,
                "currency": "USD"
            },
            "description": ""
        },
        "account": {
            "number": "VSAFYPWDD123"
        },
        "customer": {
            "id": "7895623"
        },
        "operation": {
            "id": 63460000012251,
            "type": "sale",
            "status": "success",
            "date": "2019-12-25T09:48:29+0000",
            "created_date": "2019-12-25T09:47:54+0000",
            "request_id": "55aa73dcab3dd00c23956537f3a4eeb72f7-00063461",
            "sum_initial": {
                "amount": 1000,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "USD"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 1556,
                "payment_id": "14C27062M77937123",
                "auth_code": "",
                "date": "2019-12-25T09:48:27+0000"
            }
        },
        "signature": "bLraFo85nfQ+ozqLbMjCyaximHVkuL3THI1oHRkukafnk3A=="
    }

The following is the example of a callback with information about a declined purchase.

Figure 15. Example of callback data indicating that the purchase has been declined
{
        "project_id": 210,
        "payment": {
            "id": "test_payment_2",
            "type": "purchase",
            "status": "decline",
            "date": "2019-12-18T09:00:07+0000",
            "method": "PayPal Wallet",
            "sum": {
                "amount": 900,
                "currency": "USD"
            },
            "description": "test_paypal"
        },
        "customer": {
            "id": "156787"
        },
        "operation": {
            "id": 55628000009581,
            "type": "sale",
            "status": "decline",
            "date": "2019-12-18T09:00:07+0000",
            "created_date": "2019-12-18T08:59:30+0000",
            "request_id": "b8d98d70def1762cf5fc59f52dc00ffb6-00055629",
            "sum_initial": {
                "amount": 900,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 900,
                "currency": "USD"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 1556,
                "payment_id": "",
                "auth_code": ""
            }
        },
        "signature": "OEDB1GoxL9wsMnrPmuJsj6gsW5qen7MrDC2o3Rg=="
    }

Refunds by using Gate

General information

To perform a refund through Gate by using the PayPal Pay Later method, send a request with all required parameters and signature to the ecommpay URL and receive a callback with the result. The full sequence and special aspects of refund performing are provided below.



Figure 16. Refund performing by using Gate: step-by-step description
  1. A customer initiates a refund.
  2. The web service sends the request for performing the refund by using Gate to the specified ecommpay URL.
  3. The payment platform receives the request.
  4. The payment platform validates the required parameters and signature in the request.
  5. The payment platform sends the response to the web service with information about the receipt of the request and its validity (details).
  6. The payment platform performs further processing of the request (with parameter consistency check) and sends it to the PayPal service.
  7. The refund is processed on the side of the PayPal service.
  8. The PayPal service sends the result notification to the payment platform.
  9. The payment platform sends the result callback to the web service.
  10. The customer receives the refund result information from the web service.

Information about the formats of requests and callbacks used for performing refunds by using the PayPal Pay Later method via Gate is presented further in this section. General information about working with the Gate API is presented in Interaction concepts.

Request format

There are several things you need to consider when sending refund requests by using the PayPal Pay Later method:

  1. To initiate each refund, send a separate POST request to the /v2/payment/wallet/paypal/refund endpoint, which belongs to the group /v2/payment/wallet/{payment_method}/refund.
  2. Each request must include the following objects and parameters:
    • Object general—general refund information:
      • project_id—project identifier obtained from ecommpay during integration
      • payment_ididentifier of the payment that needs to be refundedpayment identifier
      • signature—request signature generated after all required parameters are specified (details—in the Signature generation and verification)
    • Object payment—refund information:
      • description—refund description or comment
      • amount—refund amount in the smallest currency unit (required for a partial refund)
      • currency—refund currency code in the ISO-4217 alpha-3 format (required for a partial refund)
  3. Additionally, any other parameters included in the specification can be used.

Thus, a correct refund request by using the PayPal Pay Later method must contain the project and payment identifiers, description of the refund, signature, and, if necessary, currency code and refund amount.

{
    "general": {
        "project_id": 210,
        "payment_id": "test_refund_1",
        "signature": "U5LCm6489ly9cXCKIVBNqEdHHdA3D19Qg=="
    },
    "payment": {
        "amount": 1000,
        "currency": "USD",
        "description": "Test refund"
    }
}
Figure 17. Example of sufficient data in a refund request
{
    "general": {
        "project_id": 210,
        "payment_id": "test_refund_1",
        "signature": "U5LCm6489ly9cXCKIVBNqEdHHdA3D19Qg=="
    },
    "payment": {
        "amount": 1000,
        "currency": "USD",
        "description": "Test refund"
    }
}

Callback format

The PayPal Pay Later method uses the standard format for callbacks to deliver refund results. For more information, see Callbacks.

The following is the example of a callback with an information about a 10.00 USD refund for the customer account 2626324568 in the 239 project.

Figure 18. Example of callback data indicating that the refund has been processed
{
        "customer": {
            "id": "7895623"
        },
        "account": {
            "number": "VSAFYPWDD35123"
        },
        "project_id": 210,
        "payment": {
            "id": "test_refund_1",
            "type": "purchase",
            "status": "refunded",
            "date": "2019-12-25T09:52:32+0000",
            "method": "PayPal Wallet",
            "sum": {
                "amount": 0,
                "currency": "USD"
            },
            "description": ""
        },
        "operation": {
            "id": 63460000005982,
            "type": "refund",
            "status": "success",
            "date": "2019-12-25T09:52:33+0000",
            "created_date": "2019-12-25T09:52:08+0000",
            "request_id": "ce8a135fe3ca7a7000ad948284c-00063461",
            "sum_initial": {
                "amount": 1000,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "USD"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 1556,
                "payment_id": "8YC17810N19968319",
                "auth_code": "",
                "date": "2019-12-25T09:52:11+0000"
            }
        },
        "signature": "TPqAIy7FQxJ2MTxuNofnt4or7LdABIrH6JGMGw=="
    }

The following is the example of a callback with information about a declined refund.

Figure 19. Example of callback data indicating that the refund has been declined
{
        "customer": {
            "id": "7895623"
        },
        "account": {
            "number": "VSAFYPWDD35123"
        },
        "project_id": 210,
        "payment": {
            "id": "test_refund_2",
            "type": "purchase",
            "status": "success",
            "date": "2019-12-25T09:52:32+0000",
            "method": "PayPal Wallet",
            "sum": {
                "amount": 1000,
                "currency": "USD"
            },
            "description": ""
        },
        "operation": {
            "id": 63460000005982,
            "type": "refund",
            "status": "decline",
            "date": "2019-12-25T09:52:33+0000",
            "created_date": "2019-12-25T09:52:08+0000",
            "request_id": "ce8a135fe3c28ad280ad948284c-00063461",
            "sum_initial": {
                "amount": 1000,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "USD"
            },
            "code": "20100",
            "message": "Decline",
            "provider": {
                "id": 1556,
                "payment_id": "8YC17810N19968319",
                "auth_code": "",
                "date": "2019-12-25T09:52:11+0000"
            }
        },
        "signature": "TPqAIy7sn5i2MTdxuNofnt4or7LdABIrH6JGMGw=="
    }

Useful links

The following articles can be useful when implementing refunds via Gate:

Analysis of payments results

To analyse information about payments made with the PayPal Pay Later method and other methods, you can use:

  • Dashboard interface toolkit with various lists and analytic panels.
  • Reports in CSV file format, available via the Reports section (one-time and periodically).
  • Data in JSON format, sent by program requests to a specified URL available by using the Data API interface.

If you have any questions, refer to the documentation (Dashboard and Using Data API) and ecommpay technical support.