{
  "opencollection": "1.0.0",
  "info": {
    "name": "Square ApplePay Terminal API",
    "version": "2.0"
  },
  "items": [
    {
      "info": {
        "name": "Terminal",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Square Create Terminal Action",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://connect.squareup.com/v2/terminals/actions",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://connect.squareup.com/oauth2/authorize",
              "accessTokenUrl": "https://connect.squareup.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Creates a Terminal action request and sends it to the specified device."
        },
        {
          "info": {
            "name": "Square Search Terminal Actions",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://connect.squareup.com/v2/terminals/actions/search",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://connect.squareup.com/oauth2/authorize",
              "accessTokenUrl": "https://connect.squareup.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Retrieves a filtered list of Terminal action requests created by the account making the request. Terminal action requests are available for 30 days."
        },
        {
          "info": {
            "name": "Square Get Terminal Action",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://connect.squareup.com/v2/terminals/actions/:action_id",
            "params": [
              {
                "name": "action_id",
                "value": "",
                "type": "path",
                "description": "Unique ID for the desired `TerminalAction`."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://connect.squareup.com/oauth2/authorize",
              "accessTokenUrl": "https://connect.squareup.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Retrieves a Terminal action request by `action_id`. Terminal action requests are available for 30 days."
        },
        {
          "info": {
            "name": "Square Cancel Terminal Action",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://connect.squareup.com/v2/terminals/actions/:action_id/cancel",
            "params": [
              {
                "name": "action_id",
                "value": "",
                "type": "path",
                "description": "Unique ID for the desired `TerminalAction`."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://connect.squareup.com/oauth2/authorize",
              "accessTokenUrl": "https://connect.squareup.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Cancels a Terminal action request if the status of the request permits it."
        },
        {
          "info": {
            "name": "Square Dismiss Terminal Action",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://connect.squareup.com/v2/terminals/actions/:action_id/dismiss",
            "params": [
              {
                "name": "action_id",
                "value": "",
                "type": "path",
                "description": "Unique ID for the `TerminalAction` associated with the action to be dismissed."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://connect.squareup.com/oauth2/authorize",
              "accessTokenUrl": "https://connect.squareup.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Dismisses a Terminal action request if the status and type of the request permits it.\n\nSee [Link and Dismiss Actions](https://developer.squareup.com/docs/terminal-api/advanced-features/custom-workflows/link-and-dismiss-actions) for more details."
        },
        {
          "info": {
            "name": "Square Create Terminal Checkout",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://connect.squareup.com/v2/terminals/checkouts",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://connect.squareup.com/oauth2/authorize",
              "accessTokenUrl": "https://connect.squareup.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Creates a Terminal checkout request and sends it to the specified device to take a payment\nfor the requested amount."
        },
        {
          "info": {
            "name": "Square Search Terminal Checkouts",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://connect.squareup.com/v2/terminals/checkouts/search",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://connect.squareup.com/oauth2/authorize",
              "accessTokenUrl": "https://connect.squareup.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Returns a filtered list of Terminal checkout requests created by the application making the request. Only Terminal checkout requests created for the merchant scoped to the OAuth token are returned. Terminal checkout requests are available for 30 days."
        },
        {
          "info": {
            "name": "Square Get Terminal Checkout",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://connect.squareup.com/v2/terminals/checkouts/:checkout_id",
            "params": [
              {
                "name": "checkout_id",
                "value": "",
                "type": "path",
                "description": "The unique ID for the desired `TerminalCheckout`."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://connect.squareup.com/oauth2/authorize",
              "accessTokenUrl": "https://connect.squareup.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Retrieves a Terminal checkout request by `checkout_id`. Terminal checkout requests are available for 30 days."
        },
        {
          "info": {
            "name": "Square Cancel Terminal Checkout",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://connect.squareup.com/v2/terminals/checkouts/:checkout_id/cancel",
            "params": [
              {
                "name": "checkout_id",
                "value": "",
                "type": "path",
                "description": "The unique ID for the desired `TerminalCheckout`."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://connect.squareup.com/oauth2/authorize",
              "accessTokenUrl": "https://connect.squareup.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Cancels a Terminal checkout request if the status of the request permits it."
        },
        {
          "info": {
            "name": "Square Dismiss Terminal Checkout",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://connect.squareup.com/v2/terminals/checkouts/:checkout_id/dismiss",
            "params": [
              {
                "name": "checkout_id",
                "value": "",
                "type": "path",
                "description": "Unique ID for the `TerminalCheckout` associated with the checkout to be dismissed."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://connect.squareup.com/oauth2/authorize",
              "accessTokenUrl": "https://connect.squareup.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Dismisses a Terminal checkout request if the status and type of the request permits it."
        },
        {
          "info": {
            "name": "Square Create Terminal Refund",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://connect.squareup.com/v2/terminals/refunds",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://connect.squareup.com/oauth2/authorize",
              "accessTokenUrl": "https://connect.squareup.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Creates a request to refund an Interac payment completed on a Square Terminal. Refunds for Interac payments on a Square Terminal are supported only for Interac debit cards in Canada. Other refunds for Terminal payments should use the Refunds API. For more information, see [Refunds API](api:Refunds)."
        },
        {
          "info": {
            "name": "Square Search Terminal Refunds",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://connect.squareup.com/v2/terminals/refunds/search",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://connect.squareup.com/oauth2/authorize",
              "accessTokenUrl": "https://connect.squareup.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Retrieves a filtered list of Interac Terminal refund requests created by the seller making the request. Terminal refund requests are available for 30 days."
        },
        {
          "info": {
            "name": "Square Get Terminal Refund",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://connect.squareup.com/v2/terminals/refunds/:terminal_refund_id",
            "params": [
              {
                "name": "terminal_refund_id",
                "value": "",
                "type": "path",
                "description": "The unique ID for the desired `TerminalRefund`."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://connect.squareup.com/oauth2/authorize",
              "accessTokenUrl": "https://connect.squareup.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Retrieves an Interac Terminal refund object by ID. Terminal refund objects are available for 30 days."
        },
        {
          "info": {
            "name": "Square Cancel Terminal Refund",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://connect.squareup.com/v2/terminals/refunds/:terminal_refund_id/cancel",
            "params": [
              {
                "name": "terminal_refund_id",
                "value": "",
                "type": "path",
                "description": "The unique ID for the desired `TerminalRefund`."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://connect.squareup.com/oauth2/authorize",
              "accessTokenUrl": "https://connect.squareup.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Cancels an Interac Terminal refund request by refund request ID if the status of the request permits it."
        },
        {
          "info": {
            "name": "Square Dismiss Terminal Refund",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://connect.squareup.com/v2/terminals/refunds/:terminal_refund_id/dismiss",
            "params": [
              {
                "name": "terminal_refund_id",
                "value": "",
                "type": "path",
                "description": "Unique ID for the `TerminalRefund` associated with the refund to be dismissed."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://connect.squareup.com/oauth2/authorize",
              "accessTokenUrl": "https://connect.squareup.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Dismisses a Terminal refund request if the status and type of the request permits it."
        }
      ]
    }
  ],
  "bundled": true
}