Skip to content

Poli

Last updated: 13th January 2022

Start accepting payments using Poli, a favorite payment method in Australia and New Zealand.

To start accepting Poli payments, please contact your Customer Success Manager.

Model

Collecting

Payment flow

Bank transfer

Payment method type

Online banking

One-step payment

Authorization

Capture

Refund

Partial refund

Chargeback

Recurring payment


Overview

Poli payments follow a two-step process:


Request a payment

Endpoints

You can find the full list, as well as complete request and response examples, in our API reference.

    post

    https://api.checkout.com/payments

    Request example

    1
    2
    3
    4
    5
    6
    7
    {
    "source": {
    "type": "poli"
    },
    "amount": 111,
    "currency": "AUD"
    }

    If a customer ID or email is not provided in the request, then we automatically create a customer profile and return the customer id in the response.

    Response example

    If a payment id is returned, then your request was successful.

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    {
    "id": "pay_nlj7cdwepelutidihyaeexyzae",
    "status": "Pending",
    "customer": {
    "id": "cus_qsbi7c2lnkbu5dhkkaci76xdh4"
    },
    "_links": {
    "self": {
    "href": "https://api.sandbox.checkout.com/payments/pay_nlj7cdwepelutidihyaeexyzae"
    },
    "redirect": {
    "href": "https://sandbox.checkout.com/LP.Core/api/payment/109457"
    }
    }
    }

    Redirect the customer

    Redirect your customer to the redirect link’s href in the above response. The redirect transfers the customer to their bank's website where they are required to enter their authorization details; if successful, the payment can be approved.

    Once completed, the customer is transferred to your predefined success or failure URL. Confirmation of a Poli payment is communicated only through webhooks. When you receive a payment_captured webhook notification, the transaction has been completed successfully. Until the payment_captured webhook is received (response code 10000), all payments are labeled as Pending.


    Get details about a payment

    You can retrieve details about an existing Poli payment with the following endpoint.

    Endpoints

    You can find the full list, as well as complete request and response examples, in our API reference.

      get

      https://api.checkout.com/payments/{payment_id}

      Response example

      1
      2
      3
      4
      5
      6
      7
      8
      9
      10
      11
      12
      13
      14
      15
      16
      17
      18
      19
      20
      21
      22
      {
      "id": "pay_nlj7cdwepelutidihyaeexyzae",
      "requested_on": "2018-12-14T11:43:41Z",
      "source": {
      "type": "poli"
      },
      "amount": 111,
      "currency": "AUD",
      "payment_type": "Regular",
      "status": "Pending",
      "risk": {
      "flagged": false
      },
      "customer": {
      "id": "cus_qsbi7c2lnkbu5dhkkaci76xdh4"
      },
      "_links": {
      "self": {
      "href": "https://api.sandbox.checkout.com/payments/pay_nlj7cdwepelutidihyaeexyzae"
      }
      }
      }

      Cancel a payment

      If the customer cancels or fails to complete the transaction at any point after the payment is created, it will automatically be voided, and we'll send you a payment_voided webhook.


      Testing Poli

      To start testing, you'll need to:

      • create a test account, and
      • contact your Customer Success Manager or Integrations engineer to activate Poli payments in the sandbox environment.
      1. Create a Poli transaction as above, following the redirect link in the response to Poli's website.
      2. Select iBank AU 01 from the dropdown menu and select Continue.
      3. Log in with the following details:
      • Username: DemoShopper
      • Password: DemoShopper
      1. Select Savings (123456) 98742364 from the dropdown menu and select Continue.
      2. Select Confirm to complete the payment. You should then be redirected to your predefined success page.