---
title: Search Order Payments
slug: api-documentation/search-order-payments
docTags: 
createdAt: 2026-08-27T16:57:40.129Z
---

{
  "id": "GFUUkBuJOPK5b-PM7QMTR",
  "type": "api-oas-v2",
  "data": {
    "method": "POST",
    "url": "https://api.upstartcommerce.com/v1/order/payments/search",
    "servers": [
      {
        "url": "https://api.upstartcommerce.com/v1/order/payments/search"
      }
    ],
    "name": "Search Order Payments",
    "description": "<p>Warning: Deprecated\nThis endpoint utilizes the UpStart search to allow administrators to search through all order payments.</p>\n<p>Authorized permissions:</p>\n<ul>\n<li><code>order.read</code></li>\n</ul>",
    "contentType": "application/json",
    "request": {
      "pathParameters": [],
      "headerParameters": [
        {
          "name": "accept",
          "type": "string",
          "kind": "optional",
          "description": "Generated from available response content types",
          "enum": [
            "application/json"
          ],
          "default": "application/json"
        },
        {
          "kind": "required",
          "name": "x-upstart-tenant",
          "type": "string",
          "description": "Tenant identifier associated with the site this call is for."
        }
      ],
      "queryParameters": [],
      "bodyDataParameters": [
        {
          "kind": "required",
          "name": "body",
          "type": "object",
          "description": "",
          "customType": "SearchFilterQuery",
          "schema": [
            {
              "name": "query",
              "kind": "optional",
              "type": "string",
              "description": "Optional query string for searching."
            },
            {
              "name": "filter",
              "kind": "optional",
              "type": "object",
              "description": "Optional filter object.",
              "example": "",
              "schema": []
            },
            {
              "name": "page",
              "kind": "required",
              "type": "integer<int32>",
              "description": "Page number for pagination.",
              "format": "int32"
            },
            {
              "name": "pageSize",
              "kind": "required",
              "type": "integer<int32>",
              "description": "Number of items per page.",
              "format": "int32"
            },
            {
              "name": "orders",
              "kind": "optional",
              "type": "array",
              "description": "List of orders.",
              "modelRef": "#/components/schemas/SearchOrder",
              "customType": "SearchOrder[]",
              "schema": [
                {
                  "name": "property",
                  "kind": "required",
                  "type": "string",
                  "description": ""
                },
                {
                  "name": "asc",
                  "kind": "optional",
                  "type": "boolean",
                  "description": "",
                  "default": true
                }
              ]
            },
            {
              "name": "returnEmptyFacets",
              "kind": "optional",
              "type": "boolean",
              "description": "Whether to return empty facets.",
              "default": false
            }
          ],
          "modelRef": "#/components/schemas/SearchFilterQuery",
          "isExpanded": true
        }
      ],
      "formDataParameters": [],
      "oAuthParameters": [
        {
          "id": "NoChannelPortalAccess",
          "name": "NoChannelPortalAccess",
          "kind": "optional",
          "type": "http",
          "description": "<p>This authentication is required for clients to interact with any of the management APIs. Similar to 'LoggedIn', it indicates that the user has actually logged into the system, but in this case with a management role.</p>",
          "scheme": "bearer"
        },
        {
          "id": "ApiKeyAccess",
          "name": "X-Upstart-Api-Key",
          "kind": "optional",
          "type": "apiKey",
          "description": "Api key based authorization.",
          "in": "header"
        },
        {
          "id": "SessionIdAccess",
          "name": "X-Upstart-Session-Id",
          "kind": "optional",
          "type": "apiKey",
          "description": "<p>Session based authorization. This authentication is required for clients to interact with any of the management APIs. Similar to 'LoggedIn', it indicates that the user has actually logged into the system, but in this case with a management role.</p>",
          "in": "header"
        }
      ],
      "cookieParameters": []
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "<p>Success-payments returned.</p>",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "customType": "PaymentSearchResponse",
            "schema": [
              {
                "name": "page",
                "kind": "required",
                "type": "integer",
                "description": ""
              },
              {
                "name": "pageSize",
                "kind": "required",
                "type": "integer",
                "description": ""
              },
              {
                "name": "count",
                "kind": "required",
                "type": "integer",
                "description": ""
              },
              {
                "name": "facetCounts",
                "kind": "optional",
                "type": "object",
                "description": "",
                "modelRef": "#/components/schemas/SearchFacetCounts",
                "customType": "SearchFacetCounts",
                "schema": [
                  {
                    "name": "properties",
                    "kind": "required",
                    "type": "array",
                    "description": "",
                    "example": "",
                    "itemType": "object",
                    "customType": "object[]",
                    "schema": [
                      {
                        "name": "property",
                        "kind": "required",
                        "type": "string",
                        "description": ""
                      },
                      {
                        "name": "propertyType",
                        "kind": "required",
                        "type": "string",
                        "description": "",
                        "modelRef": "#/components/schemas/SearchPropertyType",
                        "customType": "SearchPropertyType",
                        "schema": []
                      },
                      {
                        "name": "counts",
                        "kind": "required",
                        "type": "array",
                        "description": "",
                        "modelRef": "#/components/schemas/SearchCount",
                        "customType": "SearchCount[]",
                        "schema": [
                          {
                            "name": "value",
                            "kind": "required",
                            "type": "string",
                            "description": ""
                          },
                          {
                            "name": "count",
                            "kind": "required",
                            "type": "integer",
                            "description": ""
                          }
                        ]
                      }
                    ]
                  },
                  {
                    "name": "ranges",
                    "kind": "required",
                    "type": "array",
                    "description": "",
                    "example": "",
                    "itemType": "object",
                    "customType": "object[]",
                    "schema": [
                      {
                        "name": "property",
                        "kind": "required",
                        "type": "string",
                        "description": ""
                      },
                      {
                        "name": "propertyType",
                        "kind": "required",
                        "type": "string",
                        "description": "",
                        "modelRef": "#/components/schemas/SearchPropertyType",
                        "customType": "SearchPropertyType",
                        "schema": []
                      },
                      {
                        "name": "counts",
                        "kind": "required",
                        "type": "array",
                        "description": "",
                        "modelRef": "#/components/schemas/SearchCount",
                        "customType": "SearchCount[]",
                        "schema": [
                          {
                            "name": "value",
                            "kind": "required",
                            "type": "string",
                            "description": ""
                          },
                          {
                            "name": "count",
                            "kind": "required",
                            "type": "integer",
                            "description": ""
                          }
                        ]
                      },
                      {
                        "name": "start",
                        "kind": "required",
                        "type": "string",
                        "description": ""
                      },
                      {
                        "name": "end",
                        "kind": "required",
                        "type": "string",
                        "description": ""
                      },
                      {
                        "name": "gap",
                        "kind": "required",
                        "type": "string",
                        "description": ""
                      }
                    ]
                  }
                ]
              },
              {
                "name": "queryId",
                "kind": "required",
                "type": "string",
                "description": ""
              },
              {
                "name": "redirects",
                "kind": "required",
                "type": "array",
                "description": "",
                "example": "",
                "itemType": "string",
                "customType": "string[]",
                "itemExample": "",
                "itemDefault": ""
              },
              {
                "name": "items",
                "kind": "required",
                "type": "array",
                "description": "",
                "modelRef": "#/components/schemas/PaymentSummary",
                "customType": "PaymentSummary[]",
                "schema": [
                  {
                    "name": "orderId",
                    "kind": "required",
                    "type": "string<uuid>",
                    "description": "The id of the order the payment belongs to.",
                    "format": "uuid"
                  },
                  {
                    "name": "paymentId",
                    "kind": "required",
                    "type": "string<uuid>",
                    "description": "The id of the payment.",
                    "format": "uuid"
                  },
                  {
                    "name": "siteIds",
                    "kind": "required",
                    "type": "array",
                    "description": "",
                    "example": "",
                    "itemType": "string",
                    "customType": "string[]",
                    "itemExample": "",
                    "itemDefault": ""
                  },
                  {
                    "name": "customerId",
                    "kind": "required",
                    "type": "string<uuid>",
                    "description": "The id of the consumer who made this payment.",
                    "format": "uuid"
                  },
                  {
                    "name": "amount",
                    "kind": "optional",
                    "type": "number",
                    "description": "Total value of the payment.",
                    "example": 500
                  },
                  {
                    "name": "currency",
                    "kind": "required",
                    "type": "string",
                    "description": "<p>Payment currency, as <a href=\"https://en.wikipedia.org/wiki/ISO_4217\" target=\"_blank\">3-character ISO code</a>.</p>",
                    "example": "USD"
                  },
                  {
                    "name": "state",
                    "kind": "required",
                    "type": "string<New | Refunded | RefundFailed | ProcessDisabled | Authorized | AuthorizationFailed | CaptureRequested | Captured | CaptureFailed | Reversed | ReverseFailed | Invalid>",
                    "description": "Valid states of a payment.",
                    "example": "Authorized",
                    "enum": [
                      "New",
                      "Refunded",
                      "RefundFailed",
                      "ProcessDisabled",
                      "Authorized",
                      "AuthorizationFailed",
                      "CaptureRequested",
                      "Captured",
                      "CaptureFailed",
                      "Reversed",
                      "ReverseFailed",
                      "Invalid"
                    ]
                  },
                  {
                    "name": "exec",
                    "kind": "required",
                    "type": "object",
                    "description": "Information related to the execution of the payment.",
                    "example": "",
                    "schema": []
                  },
                  {
                    "name": "orderDate",
                    "kind": "required",
                    "type": "string<date-time>",
                    "description": "<p>The date/time when the order was submitted.</p>",
                    "format": "date-time"
                  },
                  {
                    "name": "billingAddress",
                    "kind": "optional",
                    "type": "object",
                    "description": "Standardized format for global addresses.",
                    "modelRef": "#/components/schemas/Address",
                    "customType": "Address",
                    "schema": [
                      {
                        "name": "street1",
                        "kind": "required",
                        "type": "string",
                        "description": ""
                      },
                      {
                        "name": "street2",
                        "kind": "optional",
                        "type": "string",
                        "description": ""
                      },
                      {
                        "name": "city",
                        "kind": "required",
                        "type": "string",
                        "description": ""
                      },
                      {
                        "name": "county",
                        "kind": "optional",
                        "type": "string",
                        "description": ""
                      },
                      {
                        "name": "stateOrRegion",
                        "kind": "required",
                        "type": "string",
                        "description": ""
                      },
                      {
                        "name": "country",
                        "kind": "required",
                        "type": "string",
                        "description": "Defaults to US.",
                        "minLength": 2,
                        "maxLength": 2
                      },
                      {
                        "name": "postalCode",
                        "kind": "required",
                        "type": "string",
                        "description": ""
                      },
                      {
                        "name": "poBox",
                        "kind": "required",
                        "type": "boolean",
                        "description": "",
                        "default": false
                      },
                      {
                        "name": "name",
                        "kind": "optional",
                        "type": "object",
                        "description": "",
                        "modelRef": "#/components/schemas/Name",
                        "customType": "Name",
                        "schema": [
                          {
                            "name": "first",
                            "kind": "required",
                            "type": "string",
                            "description": "The first name of the individual being addressed.",
                            "example": "John"
                          },
                          {
                            "name": "last",
                            "kind": "required",
                            "type": "string",
                            "description": "The last name of the individual being addressed.",
                            "example": "Smith"
                          },
                          {
                            "name": "middleInitial",
                            "kind": "optional",
                            "type": "string",
                            "description": "The middle initial of the individual being addressed.",
                            "example": "D."
                          },
                          {
                            "name": "salutation",
                            "kind": "optional",
                            "type": "string",
                            "description": "The salutation of the individual being addressed.",
                            "example": "Capt."
                          },
                          {
                            "name": "suffix",
                            "kind": "optional",
                            "type": "string",
                            "description": "The optional suffix of the individual being addressed.",
                            "example": "Sr."
                          }
                        ]
                      },
                      {
                        "name": "businessName",
                        "kind": "optional",
                        "type": "string",
                        "description": ""
                      },
                      {
                        "name": "phoneNumber",
                        "kind": "optional",
                        "type": "string",
                        "description": ""
                      }
                    ]
                  },
                  {
                    "name": "shippingAddress",
                    "kind": "optional",
                    "type": "object",
                    "description": "Standardized format for global addresses.",
                    "modelRef": "#/components/schemas/Address",
                    "customType": "Address",
                    "schema": [
                      {
                        "name": "street1",
                        "kind": "required",
                        "type": "string",
                        "description": ""
                      },
                      {
                        "name": "street2",
                        "kind": "optional",
                        "type": "string",
                        "description": ""
                      },
                      {
                        "name": "city",
                        "kind": "required",
                        "type": "string",
                        "description": ""
                      },
                      {
                        "name": "county",
                        "kind": "optional",
                        "type": "string",
                        "description": ""
                      },
                      {
                        "name": "stateOrRegion",
                        "kind": "required",
                        "type": "string",
                        "description": ""
                      },
                      {
                        "name": "country",
                        "kind": "required",
                        "type": "string",
                        "description": "Defaults to US.",
                        "minLength": 2,
                        "maxLength": 2
                      },
                      {
                        "name": "postalCode",
                        "kind": "required",
                        "type": "string",
                        "description": ""
                      },
                      {
                        "name": "poBox",
                        "kind": "required",
                        "type": "boolean",
                        "description": "",
                        "default": false
                      },
                      {
                        "name": "name",
                        "kind": "optional",
                        "type": "object",
                        "description": "",
                        "modelRef": "#/components/schemas/Name",
                        "customType": "Name",
                        "schema": [
                          {
                            "name": "first",
                            "kind": "required",
                            "type": "string",
                            "description": "The first name of the individual being addressed.",
                            "example": "John"
                          },
                          {
                            "name": "last",
                            "kind": "required",
                            "type": "string",
                            "description": "The last name of the individual being addressed.",
                            "example": "Smith"
                          },
                          {
                            "name": "middleInitial",
                            "kind": "optional",
                            "type": "string",
                            "description": "The middle initial of the individual being addressed.",
                            "example": "D."
                          },
                          {
                            "name": "salutation",
                            "kind": "optional",
                            "type": "string",
                            "description": "The salutation of the individual being addressed.",
                            "example": "Capt."
                          },
                          {
                            "name": "suffix",
                            "kind": "optional",
                            "type": "string",
                            "description": "The optional suffix of the individual being addressed.",
                            "example": "Sr."
                          }
                        ]
                      },
                      {
                        "name": "businessName",
                        "kind": "optional",
                        "type": "string",
                        "description": ""
                      },
                      {
                        "name": "phoneNumber",
                        "kind": "optional",
                        "type": "string",
                        "description": ""
                      }
                    ]
                  },
                  {
                    "name": "internalInvoiceId",
                    "kind": "optional",
                    "type": "string",
                    "description": "<p>Used to add an internal reference to an order if there is a mapping between the NoChannel OrderId and a client-specific id.</p>"
                  },
                  {
                    "name": "captureDate",
                    "kind": "optional",
                    "type": "string<date-time>",
                    "description": "<p>Optional date/time when the payment was captured.</p>",
                    "format": "date-time"
                  }
                ]
              }
            ],
            "modelRef": "#/components/schemas/PaymentSearchResponse",
            "complexItems": [
              {
                "name": "object",
                "schema": [
                  {
                    "name": "page",
                    "kind": "required",
                    "type": "integer",
                    "description": ""
                  },
                  {
                    "name": "pageSize",
                    "kind": "required",
                    "type": "integer",
                    "description": ""
                  },
                  {
                    "name": "count",
                    "kind": "required",
                    "type": "integer",
                    "description": ""
                  },
                  {
                    "name": "facetCounts",
                    "kind": "optional",
                    "type": "object",
                    "description": "",
                    "modelRef": "#/components/schemas/SearchFacetCounts",
                    "customType": "SearchFacetCounts",
                    "schema": [
                      {
                        "name": "properties",
                        "kind": "required",
                        "type": "array",
                        "description": "",
                        "example": "",
                        "itemType": "object",
                        "customType": "object[]",
                        "schema": [
                          {
                            "name": "property",
                            "kind": "required",
                            "type": "string",
                            "description": ""
                          },
                          {
                            "name": "propertyType",
                            "kind": "required",
                            "type": "string",
                            "description": "",
                            "modelRef": "#/components/schemas/SearchPropertyType",
                            "customType": "SearchPropertyType",
                            "schema": []
                          },
                          {
                            "name": "counts",
                            "kind": "required",
                            "type": "array",
                            "description": "",
                            "modelRef": "#/components/schemas/SearchCount",
                            "customType": "SearchCount[]",
                            "schema": [
                              {
                                "name": "value",
                                "kind": "required",
                                "type": "string",
                                "description": ""
                              },
                              {
                                "name": "count",
                                "kind": "required",
                                "type": "integer",
                                "description": ""
                              }
                            ]
                          }
                        ]
                      },
                      {
                        "name": "ranges",
                        "kind": "required",
                        "type": "array",
                        "description": "",
                        "example": "",
                        "itemType": "object",
                        "customType": "object[]",
                        "schema": [
                          {
                            "name": "property",
                            "kind": "required",
                            "type": "string",
                            "description": ""
                          },
                          {
                            "name": "propertyType",
                            "kind": "required",
                            "type": "string",
                            "description": "",
                            "modelRef": "#/components/schemas/SearchPropertyType",
                            "customType": "SearchPropertyType",
                            "schema": []
                          },
                          {
                            "name": "counts",
                            "kind": "required",
                            "type": "array",
                            "description": "",
                            "modelRef": "#/components/schemas/SearchCount",
                            "customType": "SearchCount[]",
                            "schema": [
                              {
                                "name": "value",
                                "kind": "required",
                                "type": "string",
                                "description": ""
                              },
                              {
                                "name": "count",
                                "kind": "required",
                                "type": "integer",
                                "description": ""
                              }
                            ]
                          },
                          {
                            "name": "start",
                            "kind": "required",
                            "type": "string",
                            "description": ""
                          },
                          {
                            "name": "end",
                            "kind": "required",
                            "type": "string",
                            "description": ""
                          },
                          {
                            "name": "gap",
                            "kind": "required",
                            "type": "string",
                            "description": ""
                          }
                        ]
                      }
                    ]
                  },
                  {
                    "name": "queryId",
                    "kind": "required",
                    "type": "string",
                    "description": ""
                  },
                  {
                    "name": "redirects",
                    "kind": "required",
                    "type": "array",
                    "description": "",
                    "example": "",
                    "itemType": "string",
                    "customType": "string[]",
                    "itemExample": "",
                    "itemDefault": ""
                  }
                ],
                "modelRef": "#/components/schemas/SearchResponse",
                "customType": "SearchResponse"
              },
              {
                "name": "object",
                "schema": [
                  {
                    "name": "items",
                    "kind": "required",
                    "type": "array",
                    "description": "",
                    "modelRef": "#/components/schemas/PaymentSummary",
                    "customType": "PaymentSummary[]",
                    "schema": [
                      {
                        "name": "orderId",
                        "kind": "required",
                        "type": "string<uuid>",
                        "description": "The id of the order the payment belongs to.",
                        "format": "uuid"
                      },
                      {
                        "name": "paymentId",
                        "kind": "required",
                        "type": "string<uuid>",
                        "description": "The id of the payment.",
                        "format": "uuid"
                      },
                      {
                        "name": "siteIds",
                        "kind": "required",
                        "type": "array",
                        "description": "",
                        "example": "",
                        "itemType": "string",
                        "customType": "string[]",
                        "itemExample": "",
                        "itemDefault": ""
                      },
                      {
                        "name": "customerId",
                        "kind": "required",
                        "type": "string<uuid>",
                        "description": "The id of the consumer who made this payment.",
                        "format": "uuid"
                      },
                      {
                        "name": "amount",
                        "kind": "optional",
                        "type": "number",
                        "description": "Total value of the payment.",
                        "example": 500
                      },
                      {
                        "name": "currency",
                        "kind": "required",
                        "type": "string",
                        "description": "<p>Payment currency, as <a href=\"https://en.wikipedia.org/wiki/ISO_4217\" target=\"_blank\">3-character ISO code</a>.</p>",
                        "example": "USD"
                      },
                      {
                        "name": "state",
                        "kind": "required",
                        "type": "string<New | Refunded | RefundFailed | ProcessDisabled | Authorized | AuthorizationFailed | CaptureRequested | Captured | CaptureFailed | Reversed | ReverseFailed | Invalid>",
                        "description": "Valid states of a payment.",
                        "example": "Authorized",
                        "enum": [
                          "New",
                          "Refunded",
                          "RefundFailed",
                          "ProcessDisabled",
                          "Authorized",
                          "AuthorizationFailed",
                          "CaptureRequested",
                          "Captured",
                          "CaptureFailed",
                          "Reversed",
                          "ReverseFailed",
                          "Invalid"
                        ]
                      },
                      {
                        "name": "exec",
                        "kind": "required",
                        "type": "object",
                        "description": "Information related to the execution of the payment.",
                        "example": "",
                        "schema": []
                      },
                      {
                        "name": "orderDate",
                        "kind": "required",
                        "type": "string<date-time>",
                        "description": "<p>The date/time when the order was submitted.</p>",
                        "format": "date-time"
                      },
                      {
                        "name": "billingAddress",
                        "kind": "optional",
                        "type": "object",
                        "description": "Standardized format for global addresses.",
                        "modelRef": "#/components/schemas/Address",
                        "customType": "Address",
                        "schema": [
                          {
                            "name": "street1",
                            "kind": "required",
                            "type": "string",
                            "description": ""
                          },
                          {
                            "name": "street2",
                            "kind": "optional",
                            "type": "string",
                            "description": ""
                          },
                          {
                            "name": "city",
                            "kind": "required",
                            "type": "string",
                            "description": ""
                          },
                          {
                            "name": "county",
                            "kind": "optional",
                            "type": "string",
                            "description": ""
                          },
                          {
                            "name": "stateOrRegion",
                            "kind": "required",
                            "type": "string",
                            "description": ""
                          },
                          {
                            "name": "country",
                            "kind": "required",
                            "type": "string",
                            "description": "Defaults to US.",
                            "minLength": 2,
                            "maxLength": 2
                          },
                          {
                            "name": "postalCode",
                            "kind": "required",
                            "type": "string",
                            "description": ""
                          },
                          {
                            "name": "poBox",
                            "kind": "required",
                            "type": "boolean",
                            "description": "",
                            "default": false
                          },
                          {
                            "name": "name",
                            "kind": "optional",
                            "type": "object",
                            "description": "",
                            "modelRef": "#/components/schemas/Name",
                            "customType": "Name",
                            "schema": [
                              {
                                "name": "first",
                                "kind": "required",
                                "type": "string",
                                "description": "The first name of the individual being addressed.",
                                "example": "John"
                              },
                              {
                                "name": "last",
                                "kind": "required",
                                "type": "string",
                                "description": "The last name of the individual being addressed.",
                                "example": "Smith"
                              },
                              {
                                "name": "middleInitial",
                                "kind": "optional",
                                "type": "string",
                                "description": "The middle initial of the individual being addressed.",
                                "example": "D."
                              },
                              {
                                "name": "salutation",
                                "kind": "optional",
                                "type": "string",
                                "description": "The salutation of the individual being addressed.",
                                "example": "Capt."
                              },
                              {
                                "name": "suffix",
                                "kind": "optional",
                                "type": "string",
                                "description": "The optional suffix of the individual being addressed.",
                                "example": "Sr."
                              }
                            ]
                          },
                          {
                            "name": "businessName",
                            "kind": "optional",
                            "type": "string",
                            "description": ""
                          },
                          {
                            "name": "phoneNumber",
                            "kind": "optional",
                            "type": "string",
                            "description": ""
                          }
                        ]
                      },
                      {
                        "name": "shippingAddress",
                        "kind": "optional",
                        "type": "object",
                        "description": "Standardized format for global addresses.",
                        "modelRef": "#/components/schemas/Address",
                        "customType": "Address",
                        "schema": [
                          {
                            "name": "street1",
                            "kind": "required",
                            "type": "string",
                            "description": ""
                          },
                          {
                            "name": "street2",
                            "kind": "optional",
                            "type": "string",
                            "description": ""
                          },
                          {
                            "name": "city",
                            "kind": "required",
                            "type": "string",
                            "description": ""
                          },
                          {
                            "name": "county",
                            "kind": "optional",
                            "type": "string",
                            "description": ""
                          },
                          {
                            "name": "stateOrRegion",
                            "kind": "required",
                            "type": "string",
                            "description": ""
                          },
                          {
                            "name": "country",
                            "kind": "required",
                            "type": "string",
                            "description": "Defaults to US.",
                            "minLength": 2,
                            "maxLength": 2
                          },
                          {
                            "name": "postalCode",
                            "kind": "required",
                            "type": "string",
                            "description": ""
                          },
                          {
                            "name": "poBox",
                            "kind": "required",
                            "type": "boolean",
                            "description": "",
                            "default": false
                          },
                          {
                            "name": "name",
                            "kind": "optional",
                            "type": "object",
                            "description": "",
                            "modelRef": "#/components/schemas/Name",
                            "customType": "Name",
                            "schema": [
                              {
                                "name": "first",
                                "kind": "required",
                                "type": "string",
                                "description": "The first name of the individual being addressed.",
                                "example": "John"
                              },
                              {
                                "name": "last",
                                "kind": "required",
                                "type": "string",
                                "description": "The last name of the individual being addressed.",
                                "example": "Smith"
                              },
                              {
                                "name": "middleInitial",
                                "kind": "optional",
                                "type": "string",
                                "description": "The middle initial of the individual being addressed.",
                                "example": "D."
                              },
                              {
                                "name": "salutation",
                                "kind": "optional",
                                "type": "string",
                                "description": "The salutation of the individual being addressed.",
                                "example": "Capt."
                              },
                              {
                                "name": "suffix",
                                "kind": "optional",
                                "type": "string",
                                "description": "The optional suffix of the individual being addressed.",
                                "example": "Sr."
                              }
                            ]
                          },
                          {
                            "name": "businessName",
                            "kind": "optional",
                            "type": "string",
                            "description": ""
                          },
                          {
                            "name": "phoneNumber",
                            "kind": "optional",
                            "type": "string",
                            "description": ""
                          }
                        ]
                      },
                      {
                        "name": "internalInvoiceId",
                        "kind": "optional",
                        "type": "string",
                        "description": "<p>Used to add an internal reference to an order if there is a mapping between the NoChannel OrderId and a client-specific id.</p>"
                      },
                      {
                        "name": "captureDate",
                        "kind": "optional",
                        "type": "string<date-time>",
                        "description": "<p>Optional date/time when the payment was captured.</p>",
                        "format": "date-time"
                      }
                    ]
                  }
                ]
              }
            ],
            "complexType": "allOf",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "400",
        "description": "The request contained information that the server was unable to process. Appropriate errors are provided in the response body.",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "customType": "ValidationErrorResponse",
            "schema": [
              {
                "name": "name",
                "kind": "required",
                "type": "string",
                "description": ""
              },
              {
                "name": "code",
                "kind": "required",
                "type": "string",
                "description": ""
              },
              {
                "name": "detail",
                "kind": "optional",
                "type": "string",
                "description": ""
              }
            ],
            "modelRef": "#/components/schemas/ValidationErrorResponse",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "401",
        "description": "The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "customType": "ErrorResponse",
            "schema": [
              {
                "name": "name",
                "kind": "required",
                "type": "string",
                "description": ""
              },
              {
                "name": "code",
                "kind": "required",
                "type": "string",
                "description": ""
              },
              {
                "name": "detail",
                "kind": "required",
                "type": "string",
                "description": ""
              },
              {
                "name": "reason",
                "kind": "optional",
                "type": "string",
                "description": ""
              }
            ],
            "modelRef": "#/components/schemas/ErrorResponse",
            "isExpanded": true
          }
        ]
      }
    ],
    "hasXCodeSamples": false,
    "deprecated": true,
    "examples": {
      "languages": [
        {
          "id": "Wlx18IKoRJ56gbafsz1wM",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request POST \\\n     --url https://api.upstartcommerce.com/v1/order/payments/search \\\n     --header 'accept: application/json' \\\n     --header 'content-type: application/json' \\\n     --header 'x-upstart-tenant: string' \\\n     --data '{\n     \"page\": \"\",\n     \"pageSize\": \"\",\n     \"orders\": [\n     {\n     \"property\": \"\",\n     \"asc\": true\n     }\n     ]\n     }'"
        },
        {
          "id": "igsg6FmY_ftTKXQxln6pY",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\nmyHeaders.append(\"x-upstart-tenant\", \"string\");\n\nvar raw = JSON.stringify({\n   \"page\": \"\",\n   \"pageSize\": \"\",\n   \"orders\": [\n      {\n         \"property\": \"\",\n         \"asc\": true\n      }\n   ]\n});\n\nvar requestOptions = {\n   method: 'POST',\n   headers: myHeaders,\n   body: raw,\n   redirect: 'follow'\n};\n\nfetch(\"https://api.upstartcommerce.com/v1/order/payments/search\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "sMIqC5DCdvZIXEfPYp1XK",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.upstartcommerce.com/v1/order/payments/search\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"x-upstart-tenant\"] = \"string\"\nrequest.body = JSON.dump({\n   \"page\": \"\",\n   \"pageSize\": \"\",\n   \"orders\": [\n      {\n         \"property\": \"\",\n         \"asc\": true\n      }\n   ]\n})\n\nresponse = https.request(request)\nputs response.read_body\n"
        },
        {
          "id": "cVvk2mwvB2cLw1bY2i7Re",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"https://api.upstartcommerce.com/v1/order/payments/search\"\n\npayload = json.dumps({\n   \"page\": \"\",\n   \"pageSize\": \"\",\n   \"orders\": [\n      {\n         \"property\": \"\",\n         \"asc\": True\n      }\n   ]\n})\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json',\n   'x-upstart-tenant': 'string'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "Wlx18IKoRJ56gbafsz1wM"
    },
    "results": {
      "languages": [
        {
          "id": "yVAzUDM9qBo_ZU0Je5Oze",
          "language": "200",
          "code": "// Success-payments returned.\n{\n  \"page\": 0,\n  \"pageSize\": 0,\n  \"count\": 0,\n  \"facetCounts\": {\n    \"properties\": [\n      {\n        \"property\": \"\",\n        \"propertyType\": \"\",\n        \"counts\": [\n          {\n            \"value\": \"\",\n            \"count\": 0\n          }\n        ]\n      }\n    ],\n    \"ranges\": [\n      {\n        \"property\": \"\",\n        \"propertyType\": \"\",\n        \"counts\": [\n          {\n            \"value\": \"\",\n            \"count\": 0\n          }\n        ],\n        \"start\": \"\",\n        \"end\": \"\",\n        \"gap\": \"\"\n      }\n    ]\n  },\n  \"queryId\": \"\",\n  \"redirects\": [\n    \"\"\n  ],\n  \"items\": [\n    {\n      \"orderId\": \"\",\n      \"paymentId\": \"\",\n      \"siteIds\": [\n        \"\"\n      ],\n      \"customerId\": \"\",\n      \"amount\": 500,\n      \"currency\": \"USD\",\n      \"state\": \"Authorized\",\n      \"exec\": {},\n      \"orderDate\": \"\",\n      \"billingAddress\": {\n        \"street1\": \"\",\n        \"street2\": \"\",\n        \"city\": \"\",\n        \"county\": \"\",\n        \"stateOrRegion\": \"\",\n        \"country\": \"\",\n        \"postalCode\": \"\",\n        \"poBox\": false,\n        \"name\": {\n          \"first\": \"John\",\n          \"last\": \"Smith\",\n          \"middleInitial\": \"D.\",\n          \"salutation\": \"Capt.\",\n          \"suffix\": \"Sr.\"\n        },\n        \"businessName\": \"\",\n        \"phoneNumber\": \"\"\n      },\n      \"shippingAddress\": {\n        \"street1\": \"\",\n        \"street2\": \"\",\n        \"city\": \"\",\n        \"county\": \"\",\n        \"stateOrRegion\": \"\",\n        \"country\": \"\",\n        \"postalCode\": \"\",\n        \"poBox\": false,\n        \"name\": {\n          \"first\": \"John\",\n          \"last\": \"Smith\",\n          \"middleInitial\": \"D.\",\n          \"salutation\": \"Capt.\",\n          \"suffix\": \"Sr.\"\n        },\n        \"businessName\": \"\",\n        \"phoneNumber\": \"\"\n      },\n      \"internalInvoiceId\": \"\",\n      \"captureDate\": \"\"\n    }\n  ]\n}"
        },
        {
          "id": "V11n_CTiDBY-xgRRWMeuD",
          "language": "400",
          "code": "// The request contained information that the server was unable to process. Appropriate errors are provided in the response body.\n{\n  \"name\": \"\",\n  \"code\": \"\",\n  \"detail\": \"\"\n}"
        },
        {
          "id": "3iAAekkt0iwc0B0Itk4c7",
          "language": "401",
          "code": "// The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.\n{\n  \"name\": \"\",\n  \"code\": \"\",\n  \"detail\": \"\",\n  \"reason\": \"\"\n}"
        }
      ],
      "selectedLanguageId": "yVAzUDM9qBo_ZU0Je5Oze"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}