v1

latestOpenAPI 3.1.02026-07-24260142.2 KB

Create a checkout

The first API call you will make in processing a Zip payment is a call to our /checkouts endpoint. This request is made once a customer chooses to use Zip as their payment method at checkout and will contain all order and customer information. The Zip API will then provide a response that includes a redirect url, allowing you to point the customer to the Zip checkout flow where they will complete their application or log in to their Zip account to confirm the payment.

post/checkouts

Headers

Authorizationstring required

Bearer {{API Key}}

Zip-Versionstring date required

Request body

metadataobject

Object containing name value pairs of meta data to be returned whenever recalling this checkout object.

Response

200

idstring

uristring

typestring

createdstring

statestring

Example response

{
  "shopper": {
    "title": "Mr",
    "first_name": "Test",
    "last_name": "Tester",
    "email": "firstname.lastname+1646067679@domain.com",
    "phone": "4154154455",
    "billing_address": {
      "first_name": "Test",
      "last_name": "Tester",
      "line1": "10 Spring St",
      "city": "New york",
      "state": "New york",
      "postal_code": "1000",
      "country": "US"
    }
  },
  "order": {
    "reference": "ref_1646067679",
    "amount": 200,
    "currency": "USD",
    "items": [
      {
        "name": "Awesome shoes",
        "amount": 60,
        "quantity": 1,
        "type": "sku",
        "reference": "001",
        "image_uri": "https://yourimage.com/shoes_image_url",
        "item_uri": "https://youritem.com/shoes_item_url"
      }
    ]
  },
  "config": {
    "redirect_uri": "https://localhost/zip_order_complete"
  },
  "id": "us-00d11005-d30f-405d-b8d5-917a8ab78ba0",
  "uri": "https://gateway.sand.us.zip.co/orders/authorize?orderId=00d11005-d30f-405d-b8d5-917a8ab78ba0&merchantId=5901c42b-f41f-476b-a2d4-7d4bc383f7db&merchantReference=ref_1646067679&order.orderNumber=220228-254656&order.firstName=Test&order.lastName=Tester&order.email=firstname.lastname%2b1646067679%40domain.com&order.phone=4154154455&order.billingAddress.line1=10+Spring+St&order.billingAddress.city=New+york&order.billingAddress.state=New+york&order.billingAddress.postalCode=1000&order.billingAddress.country=US&order.amount=200&capture=False&callbackUrl=https%3a%2f%2fapi-ut.quadpay.com%2forder%2fcomplete&redirectCancelUrl=https%3a%2f%2fapi-ut.quadpay.com%3a443%2forder%2fcancel%3forderId%3d00d11005-d30f-405d-b8d5-917a8ab78ba0&redirectConfirmUrl=https%3a%2f%2fapi-ut.quadpay.com%2forder%2fcomplete&metadata.confirmUrl=https%3a%2f%2fglobal-api.sand.au.edge.zip.co%3a443%2fmerchant%2fcallback%3fredirect%3dhttps%253A%252F%252Flocalhost%252Fzip_order_complete%26region%3dus%26ppStatus%3dsuccess%26token%3d00d11005-d30f-405d-b8d5-917a8ab78ba0%26OrderStatus%3dApproved&metadata.cancelUrl=https%3a%2f%2fglobal-api.sand.au.edge.zip.co%3a443%2fmerchant%2fcallback%3fredirect%3dhttps%253A%252F%252Flocalhost%252Fzip_order_complete%26region%3dus%26ppStatus%3dcancelled%26token%3d00d11005-d30f-405d-b8d5-917a8ab78ba0%26OrderStatus%3dAbandoned&X-QP-Signature=OO2OzWfV6EU1sRxNH%2bPFoCHEfZNLEq5SUwkvQvehTlU%3d",
  "type": "standard",
  "created": "2022-02-28T17:01:22.699Z",
  "state": "created"
}