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.

Overview

Poli payments follow a two-step process:

  1. Request a payment
  2. Redirect the customer

Request a payment 

The POST request

Endpoints

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

Header parameters

HeaderValue

Authorization

REQUIRED

secret key

Use the valid secret key of your Checkout.com account. You can find this in the Hub.

Content-Type

REQUIRED

application/json

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.

Field nameDescription

source

OBJECT

REQUIRED

Details about the payment source.

source.type

STRING

REQUIRED

The type of payment source. Set this to poli.

amount

INTEGER

OPTIONAL

The payment amount.

currency

STRING

REQUIRED

The currency in which the payment is being made (three-letter ISO 4217 code).

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

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.

The GET request 

Endpoints

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

Header and path parameters

HeaderValue

Authorization

REQUIRED

secret key

Use the valid secret key of your Checkout.com account. You can find this in the Hub.

Content-Type

REQUIRED

application/json
PathValue

payment_id

REQUIRED

The payment ID found in the response of the initial payment.

The GET 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 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. You should then be redirected to your predefined success page.

Can we help?

Thanks for using Checkout.com. If you need help or have a question, message our Support team at support@checkout.com.