Zip offers flexible buy now, pay later services in both Australia and the US, with a range of products tailored to each market. In Australia, consumers can choose from Zip Pay, Zip Plus, and Zip Money, allowing them to customise their repayment schedule with weekly, two-weekly, or monthly options. In the US, Zip is available as Zip Pay in 4, which offers consumers the ability to pay in four interest-free instalments, with the first payment made upfront and the remaining spread over six weeks. Learn more about Zip.

Payment method properties

Make a Zip payment

Zip is available through our standardized REDIRECT flow. We recommend including all relevant settings for any authentication methods you support.
To create a Zip payment, you'll need to provide the following data at minimum when calling our payment charges API:

📘

To optimise the consumer experience with Zip, we recommend including the following parameters. For more information, see the API Reference.

consumer.phone
consumer.billingAddress
order.shippingAddress
order.orderItems

Request

POST /v1/payment-charges

{
  "paymentMethod": "ZIP",
  "amount": {
    "value": 1000,
    "currency": "USD"
  },
  "consumer": {
    "country": "US"
  },
  "authenticationSettings": [
    {
      "type": "REDIRECT",
      "settings": {
        "returnUrl": "https://www.webshop.com/order-results-page"
      }
    }
  ]
}

Response

You'll receive our standard payment charge response with the available authentication methods:

{
  "id": "charge_Y3JVzvEaJpvG53xd2R2Zt",
  "paymentMethod": "ZIP",
  "paymentMedium": "ECOMMERCE",
  "scheduleType": "UNSCHEDULED",
  "instrumentId": "instr_Asu0ig2PXXZSiNrhY44A5",
  "currency": "USD",
  "country": "US",
  "status": "AUTHENTICATION_PENDING",
  "consumer": {
    "country": "US"
  },
  "authenticationMethods": [
    {
      "details": {
        "requestUrl": "https://redirection-target.ppro.com",
        "requestMethod": "GET"
      },
      "type": "REDIRECT"
    }
  ],
  "authorizations": [
    {
      "id": "authz_aPobet0FNZNU1bYqfexFd",
      "amount": 1000,
      "status": "AUTHENTICATION_PENDING",
      "createdAt": "2025-06-21T08:34:20.766Z",
      "updatedAt": "2025-06-21T08:34:20.766Z"
    }
  ],
  "captures": [],
  "refunds": [],
  "voids": [],
  "createdAt": "2025-06-21T08:34:20.114Z",
  "updatedAt": "2025-06-21T08:34:20.766Z",
  "_links": {
    "authorizations": {
      "href": "/v1/payment-charges/charge_Y3JVzvEaJpvG53xd2R2Zt/authorizations"
    },
    "captures": {
      "href": "/v1/payment-charges/charge_Y3JVzvEaJpvG53xd2R2Zt/captures"
    },
    "refunds": {
      "href": "/v1/payment-charges/charge_Y3JVzvEaJpvG53xd2R2Zt/refunds"
    },
    "voids": {
      "href": "/v1/payment-charges/charge_Y3JVzvEaJpvG53xd2R2Zt/voids"
    }
  }
}

Pick the desired authentication method

REDIRECT

1. Redirect your consumer to the returned $.authenticationMethods[?(@.type == "REDIRECT")].details.requestUrl.
   For example, with the value of https://redirection-target.ppro.com/ using the returned $.authenticationMethods[?(@.type == "REDIRECT")].details.requestMethod HTTP method.
2. The consumer will be presented with the reference number and instructions to complete the payment.

Handling the payment result

REDIRECT

1. After the consumer completes the payment, they are redirected to the returnUrl specified in the payment charge creation request.
2. Upon redirect back to your site, retrieve the latest payment status by performing a GET /v1/payment-charges/{paymentChargeId}. Use the returned status field to determine and display the final payment outcome to the consumer.
3. Additionally, webhooks are triggered to notify you of the payment result. This ensures you receive the outcome even if the consumer closes their browser or fails to return to your website.

Payment instrument

A PASSTHROUGH_WALLET instrument will be created for Zip, with no additional data provided.

Request

GET /v1/payment-instruments/{instrument-id}

Response

{
    "id": "instr_Asu0ig2PXXZSiNrhY44A5",
    "type": "PASSTHROUGH_WALLET"
}

Sandbox testing