Plugin icon

Web checkout API

Give your shoppers the option to pay with Zip on your web platform with our web checkout solution.

This page will guide you through setting up your Zip account to begin your integration with the Global Online REST API.

Upon completion, you will be ready to begin your development.

Request a test account

You can request a Zip test account by reaching out to our team at [email protected]

A Zip test account will provide you with sandbox API credentials, allowing you to begin interacting with the global API.

Test connectivity

To verify that your account is working correctly, let's make a test checkout for $10 AUD.

  1. In the code below, replace YOUR_API_KEY with your sandbox API key provided by Zip
  2. Copy the resulting code into your command line, and run the command.

curl --request POST \
  --url https://global-api.sand.au.edge.zip.co/merchant/checkouts \
  --header 'authorization: Bearer YOUR_API_KEY' \
  --header 'content-type: application/json' \
  --header 'idempotency-key: 1' \
  --data '{
    "shopper": {
        "title": "Mr",
        "first_name": "John",
        "last_name": "Smith",
        "middle_name": "Joe",
        "phone": "0400000000",
        "email": "[email protected]",
        "birth_date": "2017-10-10",
        "gender": "Male",
        "billing_address": {
            "line1": "10 Test st",
            "city": "Sydney",
            "state": "NSW",
            "postal_code": "2000",
            "country": "AU"
        }
    },
    "order": {
        "reference": "testOrderReference01",
        "amount": 10.0,
        "currency": "AUD",
        "shipping": {
            "pickup": false,
                        "address": {
                                "line1": "10 Test st",
                                "city": "Sydney",
                                "state": "NSW",
                                "postal_code": "2000",
                                "country": "AU"
                        }
        },
        "items": [
            {
                "name": "Nike shoes",
                "amount": 8.0,
                "quantity": 1,
                "type": "sku",
                "reference": "1"
            },
                        {
                                "name": "Order shipping",
                "amount": 2.0,
                "quantity": 1,
                "type": "shipping",
                "reference": "1"
                        }
        ]
    },
    "config": {
        "redirect_uri": "http://www.yoursite.com/zipmoney?yourOrderRef=1234"
    },
     "metadata": {
      "platform": "Example Channel Partner"
  }
}'

If your account is set up correctly, you will receive successful JSON response containing your checkout id and uri.

You have just created your first checkout!


📘

Test as you go

Start by creating some test customer accounts to aid you in development