{ "opencollection": "1.0.0", "info": { "name": "Square ApplePay Transactions API", "version": "2.0" }, "items": [ { "info": { "name": "Transactions", "type": "folder" }, "items": [ { "info": { "name": "Square List Transactions", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/locations/:location_id/transactions", "params": [ { "name": "location_id", "value": "", "type": "path", "description": "The ID of the location to list transactions for." }, { "name": "begin_time", "value": "", "type": "query", "description": "The beginning of the requested reporting period, in RFC 3339 format.\n\nSee [Date ranges](https://developer.squareup.com/docs/build-basics/working-with-dates) for details on date inclusivity/exclusivity.\n\nDefault value: The current time minus one year." }, { "name": "end_time", "value": "", "type": "query", "description": "The end of the requested reporting period, in RFC 3339 format.\n\nSee [Date ranges](https://developer.squareup.com/docs/build-basics/working-with-dates) for details on date inclusivity/exclusivity.\n\nDefault value: The current time." }, { "name": "sort_order", "value": "", "type": "query", "description": "The order in which results are listed in the response (`ASC` for\noldest first, `DESC` for newest first).\n\nDefault value: `DESC`" }, { "name": "cursor", "value": "", "type": "query", "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this to retrieve the next set of results for your original query.\n\nSee [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information." } ], "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": "Lists transactions for a particular location.\n\nTransactions include payment information from sales and exchanges and refund\ninformation from returns and exchanges.\n\nMax results per [page](https://developer.squareup.com/docs/working-with-apis/pagination): 50" }, { "info": { "name": "Square Retrieve Transaction", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/locations/:location_id/transactions/:transaction_id", "params": [ { "name": "location_id", "value": "", "type": "path", "description": "The ID of the transaction's associated location." }, { "name": "transaction_id", "value": "", "type": "path", "description": "The ID of the transaction to retrieve." } ], "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 details for a single transaction." }, { "info": { "name": "Square Capture Transaction", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/locations/:location_id/transactions/:transaction_id/capture", "params": [ { "name": "location_id", "value": "", "type": "path" }, { "name": "transaction_id", "value": "", "type": "path" } ], "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": "Captures a transaction that was created with the [Charge](api-endpoint:Transactions-Charge)\nendpoint with a `delay_capture` value of `true`.\n\n\nSee [Delayed capture transactions](https://developer.squareup.com/docs/payments/transactions/overview#delayed-capture)\nfor more information." }, { "info": { "name": "Square Void Transaction", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/locations/:location_id/transactions/:transaction_id/void", "params": [ { "name": "location_id", "value": "", "type": "path" }, { "name": "transaction_id", "value": "", "type": "path" } ], "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 transaction that was created with the [Charge](api-endpoint:Transactions-Charge)\nendpoint with a `delay_capture` value of `true`.\n\n\nSee [Delayed capture transactions](https://developer.squareup.com/docs/payments/transactions/overview#delayed-capture)\nfor more information." } ] } ], "bundled": true }