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

# /payments/{merchantId}/json

Sandbox (Testing): https://gateway.sand.us.zip.co/payments/{merchantId}/json

An abbreviated list of payments in JSON format.

# 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": {
    "/payments/{merchantId}/json": {
      "get": {
        "summary": "/payments/{merchantId}/json",
        "description": "Sandbox (Testing): https://gateway.sand.us.zip.co/payments/{merchantId}/json\n\nAn abbreviated list of payments in JSON format.",
        "operationId": "merchantidjson",
        "parameters": [
          {
            "name": "merchantId",
            "in": "path",
            "description": "The unique Zip Merchant ID",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "MinimumCreateDateTime",
            "in": "query",
            "description": "The begin created date of the query search",
            "required": true,
            "schema": {
              "type": "string",
              "format": "date"
            }
          },
          {
            "name": "MaximumCreateDateTime",
            "in": "query",
            "description": "The end created date of the query search",
            "required": true,
            "schema": {
              "type": "string",
              "format": "date"
            }
          },
          {
            "name": "OrderBy",
            "in": "query",
            "description": "The order sort of the result set",
            "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": "X-QP-Signature",
            "in": "header",
            "description": "The signature for merchant validation",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "MerchantId",
            "in": "query",
            "description": "The unique Zip Merchant ID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"value\": [\n        {\n            \"transferId\": \"tr_1IobRYD4siJYPQuYs9O2QEZ6\",\n            \"date\": \"2021-05-07T21:42:44Z\",\n            \"amount\": 843.1000\n        }\n    ],\n    \"total\": 6\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "value": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "transferId": {
                            "type": "string",
                            "example": "tr_1IobRYD4siJYPQuYs9O2QEZ6"
                          },
                          "date": {
                            "type": "string",
                            "example": "2021-05-07T21:42:44Z"
                          },
                          "amount": {
                            "type": "number",
                            "example": 843.1,
                            "default": 0
                          }
                        }
                      }
                    },
                    "total": {
                      "type": "integer",
                      "example": 6,
                      "default": 0
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false,
        "security": []
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": false,
    "proxy-enabled": false
  },
  "x-readme-fauxas": true
}
```