---
updatedAt: 2026-09-04T11:23:24.000Z
agentTools:
  projectIndex: https://docs.us.zip.co/llms.txt
---

# /orders/{orderId}/status

Sandbox (Testing): https://gateway.sand.us.zip.co/orders/{orderId}/status

Returns an orderStatus field that can be used to confirm payment via Zip.

**orderId** returned should be persisted for successful Zip orders as it will be required to issue refunds in the future.

Possible values for `orderStatus`:

**Created** - Order has been created on Zip, but not yet completed.
**Confirmed** - Payment has been successfully completed on Zip.
**Declined** - Payment was unsuccessful on Zip.
**Abandoned** - Customer exited Zip payment flow before completing payment.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "gateway-api-1",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://gateway.us.zip.co"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://example.com/oauth2/token",
            "scopes": {}
          }
        }
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/orders/{orderId}/status": {
      "get": {
        "summary": "/orders/{orderId}/status",
        "description": "Sandbox (Testing): https://gateway.sand.us.zip.co/orders/{orderId}/status\n\nReturns an orderStatus field that can be used to confirm payment via Zip.",
        "operationId": "ordersorderidstatus",
        "parameters": [
          {
            "name": "merchantId",
            "in": "query",
            "description": "Gets or sets the merchant ID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "QP-Territory",
            "in": "header",
            "description": "Territory of the request (US)",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "X-QP-Signature",
            "in": "query",
            "description": "The signature for merchant validation",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "orderId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "OK": {
                    "value": "{\n    \"orderId\": \"11111111-1111-1111-1111-111111111111\",\n    \"orderStatus\": \"created\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "orderId": {
                      "type": "string",
                      "example": "11111111-1111-1111-1111-111111111111"
                    },
                    "orderStatus": {
                      "type": "string",
                      "example": "created"
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false,
        "security": []
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": false,
    "proxy-enabled": false
  },
  "x-readme-fauxas": true
}
```