Poli

Overview

Poli is a payment method that allows customers to perform payments by using online banking of the Australian and New Zealand banks. Purchases are performed by using Payment Page and Gate.

General information

Payment method type Online banking
Countries and regions AU, NZ
Payment currencies AUD, NZD
Currency conversion
Purchases +
Payouts
Stored credentials payments
Full refunds
Partial refunds
Chargebacks
Notes It is necessary to use the Poli Merchant style guide while developing the payment page displayed to customers
Onboarding and access fee Refer to your ECommPay key account manager

Interaction diagram

Payment processing by using the Poli payment method requires merchant's web service, one of ECommPay interfaces, and the ECommPay payment platform, as well as Poli service which is supported interactions with banks.



Operations support

  Interfaces Amounts
Payment Page CMS Plug-ins Gate Dashboard (Old Dashboard) minimum maximum
Purchases + + 1.00 USD 10,000.00 AUD/NZD

Processing scenarios

To perform a purchase operation, you need to redirect a customer to the Poli service.

Figure: Purchase by using Payment Page procedure



Figure: Purchase by using Payment Page procedure



The sections that follow provide detailed information about what you need to perform payments and how you can analyse the information on payments and operations.

Purchase by using Payment Page

General information

In the Poli method, to perform a purchase by using Payment Page, the merchant web service should send a request with all the required parameters and signature to the ECommPay URL and get the callback with the payment result from the payment platform. When opening Payment Page, you can have Payment Page opened with the Poli method selected. For more information about preselecting payment methods, see in Preselecting payment method.

The full sequence and particularities of the purchase process are provided below.



Figure: Purchase sequence by using Payment Page

  1. A customer initiates a purchase on the merchant's web service.
  2. The web service sends the request for Payment Page opening to the specified ECommPay URL.
  3. The request for opening is redirected to the payment platform.
  4. The payment platform performs the initial request processing that involves validation of the required parameters and signature.
  5. Requested Payment Page is generated into the ECommPay payment platform as specified in the project settings and the request parameters.
  6. Payment Page is displayed to the customer.
  7. The customer selects Poli method.
  8. The payment platform receives the purchase request for payment processing.
  9. The payment platform performs the internal purchase request processing and sends it to the Poli service.
  10. The purchase request is processed on the Poli service side.
  11. The service generates the data for redirecting the customer to its payment form and sends it to the payment platform.
  12. The payment platform sends the customer redirection data to Payment Page.
  13. The customer is redirected to the Poli service.
  14. The customer completes all the payment steps required.
  15. The payment is processed on Poli side.
  16. The result is displayed to the customer on the service.
  17. The customer is redirected to Payment Page.
  18. Poli sends the result notification to the payment platform.
  19. The payment platform sends a callback with the payment result to the web service.
  20. The payment platform sends the result to Payment Page.
  21. A page with the payment result information is displayed to the customer on Payment Page.

The sections that follow discuss in more details the request format and the Payment Page parameters to use in the Poli payment method and provide the information on the format of callbacks with payment results. For the general information on how to use the API, see Payment Page API Description.

Request format

There are several things you need to consider when requesting a payment through the Poli method:

  1. You must provide values for the basic minimum of parameters. Listed below are the parameters that are mandatory for any payment method:
    • project_id—the project ID obtained from ECommPay
    • payment_id—payment ID unique within the project
    • payment_currency—payment currency in ISO-4217 alpha-3 format
    • payment_amount—payment amount in minor units
    • customer_id—customer ID unique within the project
  2. The currency of a payment can only be AUD or NZD.
  3. There is one more mandatory parameter customer_email, customer_last_name, customer_first_name—email address, first and last name of the customer within the project. If the parameters are not passed in the request for opening they are requested from customers on Payment Page.
  4. Also pass the merchant_return_url parameter, to allow customers to return in the project at any step before the payment is completed by clicking the return button
  5. If you need to have payment form displayed with the Poli method selected, set the force_payment_method parameter to poli.
  6. If required, you can also add any other additional parameters Payment Page supports.
  7. After you specify all the parameters you need, you must create the signature for the request. For instructions on how to sign a payment request, see Signature generation and verification.

Thus, a correct payment request in the Poli method must include project, customer, and payment IDs, the currency and the amount of a payment in the appropriate currency, as shown in the following example:

EPayWidget.run(
    { payment_id: 'X03936', 
      payment_amount: 100000, 
      payment_currency: 'EUR', 
      project_id: 121,
      customer_id: 'customer1',
      customer_last_name: 'Johnson',
      customer_first_name: 'John',
      customer_email: 'johnson@mail.com',
      signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KURLCvhtT4DqtOcZzUCwX6R\/ekpZhkIQg=="
    }
)

For information about all parameters available in the Poli method , see Payment Page invocation parameters.

Callback format

The Poli 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 successful 10.00 AUD purchase from the 1 customer in the 579 project.

Figure: Example of a successful purchase callback

    {
        "project_id": 579,
        "payment": {
            "id": "TEST_17777",
            "type": "purchase",
            "status": "success",
            "date": "2019-03-25T15:22:19+0000",
            "method": "poli",
            "sum": {
                "amount": 1000,
                "currency": "AUD"
            },
            "description": "TEST_17777"
        },
        "account": {
            "number": "98742364"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 859000000758,
            "type": "sale",
            "status": "success",
            "date": "2019-03-25T15:22:19+0000",
            "created_date": "2019-03-25T15:20:51+0000",
            "request_id": "d8287211",
            "sum_initial": {
                "amount": 1000,
                "currency": "AUD"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "AUD"
            },
            "provider": {
                "id": 1199,
                "payment_id": "996117524182",
                "date": "2019-03-26T02:22:15+0000",
                "auth_code": "",
                "endpoint_id": "iBankAU01"
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "bs1VNy7rlgogc/bi3YNXLut984WlYoQZLjHUs44ZDGyBJX7wECw+tAcgEYAXbo2Q=="
    }

The following is the example of a callback for a purchase declined due to the account owner cancelled operation.

Figure: Example of a declined purchase callback


{
        "project_id": 200,
        "payment": {
            "id": "TEST_156205789689899",
            "type": "purchase",
            "status": "decline",
            "date": "2019-07-02T10:10:58+0000",
            "method": "poli",
            "sum": {
                "amount": 100,
                "currency": "EUR"
            },
            "description": "TEST_156205789689899"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 23132000003336,
            "type": "sale",
            "status": "decline",
            "date": "2019-07-02T10:10:58+0000",
            "created_date": "2019-07-02T09:41:42+0000",
            "request_id": "b8780b6769",
            "sum_initial": {
                "amount": 100,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 100,
                "currency": "EUR"
            },
            "provider": {
                "id": 1243,
                "payment_id": "1111920",
                "date": "2019-07-02T10:10:57+0000",
                "auth_code": ""
            },
            "code": "20000",
            "message": "General decline"
        },
        "signature": "bxyKlCGB82Xs4KI4yeN2av6Kg/+PnNJNWKXImLYPDlm7mOg=="
    }

Related topics

The following topics might be useful when implementing payments through Payment Page:

Purchase by using Gate

General information

In the Poli methods, when processing a purchase by using Gate, the merchant web service is required to do the following:

  1. Send a request with all the required parameters and signature to the ECommPay URL.
  2. Perform the redirection of a customer to the Poli service.
  3. Get the callback with the payment result from the payment platform.

The following diagram provides the detailed picture of the payment processing procedure.



Figure: Purchase by using Gate

  1. A customer initiates a purchase through Poli on the merchant's web service side. It is necessary to use the Poli Merchant style guide while developing the payment page displayed to customers.
  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 for processing the purchase from Gate.
  4. The payment platform performs the initial request processing that includes validation of the required parameters and signature.
  5. The payment platform sends the response with request receipt confirmation and correctness check result to the web service. For more information, see Response format.
  6. The payment platform performs the internal payment request processing and redirects the request to the Poli service.
  7. The request is processed on the Poli side.
  8. The Poli service sends the data for redirecting the customer to the Poli service to the payment platform.
  9. The payment platform sends the callback with the redirection data in the redirect_data object to the web service.
  10. The customer is redirected from the web service to the Poli service.
  11. The customer completes all the payment steps required.
  12. The payment is processed on the Poli side.
  13. The result is displayed to the customer.
  14. The customer is redirected to the merchant's web service.
  15. The Poli service sends the payment result notification to the payment platform.
  16. The payment platform sends a callback to the web service.
  17. The customer receives the payment result on the web service.

The sections that follow discuss in more details the request format and the Gate parameters to use in the Poli payment method and provide the information on the format of callbacks with purchase results.

Request format

There are several things you must consider when using purchase requests in the Poli method:
  1. You perform refunds by sending the /v2/payment/online-banking/poli/sale/ request by using POST (HTTP) method. This is an online banking request group: /v2/payment/online-banking/{payment_method}/sale
  2. The following objects and parameters must be specified in any request:
    • Object general—general purchase information:
      • project_id—project identifier
      • payment_id—unique purchase identifier
      • signature—signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification
    • Object customer—customer information:
      • id—the ID of the customer within the merchant project
      • last_name—last name
      • first_name—first name
      • email—email address
      • ip_address—customer IP address
    • Object payment—purchase information:
      • amount—purchase amount
      • currency—payout currency in the ISO-4217 alpha-3 format.
  3. The currency of a payment can only be AUD or NZD.
  4. If required, you can also add any other additional parameters Gate supports.

Thus, a correct payment request in the Poli method must include project and payment IDs, customer data, currency and amount of the purchase, as shown in the following example:

Figure: Example of a purchase request

{
    "general": {
      "project_id": 2990,
      "payment_id": "payment_id",
      "signature": "PJkV8ej\/UG0Di8NN5e7cV+VHq3LwY3T\/pOMeSaRfBaNIipTv+AWoXW\/9MTO8yJA=="
    },
    "customer": {
      "ip_address": "1.1.1.1",
      "last_name": "Johnson",
      "first_name": "John",
      "email": "johnson@mail.com",
      "id": "123"
    },
    "payment": {
      "amount": 1000,
      "currency": "EUR"
    }
}

Formats of the customer redirection data

To redirect a customer from the web service to the Poli site, you must receive a callback from the payment platform containing the URL for redirection in the redirect_data.url parameter and data to be sent in the request body in the redirect_data.body parameter, and use these parameters when opening the HTML page using the method specified in the redirect_data.method parameter.

The following is the callback fragment containing the redirection data.

   "redirect_data": {
                    "body": [],
                    "method": "GET",
                    "url": "https://txn.uat1.paywithpoli.com/?Token=HLRxSE9VM4zorV%2bA"

Callback format

The Poli 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 successful 10.00 AUD purchase from the 1 customer in the 579 project.

Figure: Example of a successful purchase callback

    {
        "project_id": 579,
        "payment": {
            "id": "TEST_17777",
            "type": "purchase",
            "status": "success",
            "date": "2019-03-25T15:22:19+0000",
            "method": "poli",
            "sum": {
                "amount": 1000,
                "currency": "AUD"
            },
            "description": "TEST_17777"
        },
        "account": {
            "number": "98742364"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 859000000758,
            "type": "sale",
            "status": "success",
            "date": "2019-03-25T15:22:19+0000",
            "created_date": "2019-03-25T15:20:51+0000",
            "request_id": "d8287211",
            "sum_initial": {
                "amount": 1000,
                "currency": "AUD"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "AUD"
            },
            "provider": {
                "id": 1199,
                "payment_id": "996117524182",
                "date": "2019-03-26T02:22:15+0000",
                "auth_code": "",
                "endpoint_id": "iBankAU01"
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "bs1VNy7rlgogc/bi3YNXLut984WlYoQZLjHUs44ZDGyBJX7wECw+tAcgEYAXbo2Q=="
    }

The following is the example of a callback for a purchase declined due to the account owner cancelled operation.

Figure: Example of a declined purchase callback


{
        "project_id": 200,
        "payment": {
            "id": "TEST_156205789689899",
            "type": "purchase",
            "status": "decline",
            "date": "2019-07-02T10:10:58+0000",
            "method": "poli",
            "sum": {
                "amount": 100,
                "currency": "EUR"
            },
            "description": "TEST_156205789689899"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 23132000003336,
            "type": "sale",
            "status": "decline",
            "date": "2019-07-02T10:10:58+0000",
            "created_date": "2019-07-02T09:41:42+0000",
            "request_id": "b8780b6769",
            "sum_initial": {
                "amount": 100,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 100,
                "currency": "EUR"
            },
            "provider": {
                "id": 1243,
                "payment_id": "1111920",
                "date": "2019-07-02T10:10:57+0000",
                "auth_code": ""
            },
            "code": "20000",
            "message": "General decline"
        },
        "signature": "bxyKlCGB82Xs4KI4yeN2av6Kg/+PnNJNWKXImLYPDlm7mOg=="
    }

Related topics

The following topics might be useful when implementing payments through Gate:

Analysis of payments results

As with other payment methods ECommPay offers, when using the Poli method, you have several options to analyse the information about payments and operations performed by using the method—alone or in conjunction with other methods.

You can load and analyse all the necessary information in Dashboard, for instance you can use the analytic panels on the Analytics tab to this end.

Also, you can export the information for further analysis by using third party analytical tools. The following options are available:

  • Dashboard allows you to download reports in CSV and XLS formats—by using the tools on the Payments tab. You can perform export as a one-time download to your local computer or have payment data regularly exported and delivered to email addresses you specify.
  • Data API allows you to have payment information exported in JSON format and delivered to a URL you specify. The payment information is exported by using the /operations/get queries.

If you have any further questions regarding payment data analysis, contact ECommPay technical support.