Poli

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.

Process a Poli payment

Poli payments follow a two-step process:

1. Request a Poli payment
2. Redirect the customer

Step 1: Request a Poli payment

The request

Use the details below to set up your request.

Endpoints

Live

POSThttps://api.checkout.com/payments

Sandbox

POSThttps://api.sandbox.checkout.com/payments

Header parameters

Body parameters

📘

The table below describes the minimum recommended fields. You can find the full list, as well as complete request and response examples, in our API reference.

Request example

{
  "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.

The response

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

Response example

{
  "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"
    }
  }
}

Step 2: Redirect the customer

Redirect your customer to the redirect link’s href in the response to Step 1. 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 Poli payment

You can retrieve details about an existing Poli payment.

The request

Use the details below to set up your request.

Endpoints

Live

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

Sandbox

GEThttps://api.sandbox.checkout.com/payments/{payment_id}

Header and path parameters

The response

Response example

{
  "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 Poli 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 click Continue.

3. Log in with the following details:
     -   Username: DemoShopper
     -   Password: DemoShopper

4. Select Savings (123456) 98742364 from the dropdown menu and click Continue.

5. Click Confirm to complete the payment.

6. You should then be redirected to your predefined success page.

Can we help?

Thanks for using Checkout.com. If you need any help or support, then message our support team at [email protected].