{ "info": { "_postman_id": "0fd84e82-e643-46ff-ac97-261372356621", "name": "Square ApplePay CashDrawers API", "description": "Supercharge Square for sellers of every size. Our entire connected commerce platform from elegant hardware to a rich suite of Square APIs is yours to build with. Whether youre developing an app or composing a bespoke solution, this is the place to make it happen. \n\nContact Support:\n Name: Square Developer Platform\n Email: developers@squareup.com", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T03:01:54.000Z", "updatedAt": "2026-07-28T03:01:54.000Z", "lastUpdatedBy": "35240", "uid": "35240-0fd84e82-e643-46ff-ac97-261372356621" }, "item": [ { "name": "v2", "item": [ { "name": "cash-drawers", "item": [ { "name": "shifts", "item": [ { "name": "{shift_id}", "item": [ { "name": "events", "item": [ { "name": "Square List Cash Drawer Shift Events", "id": "fe9192ae-5a67-43ba-8155-0b3b463699a1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/cash-drawers/shifts/:shift_id/events?location_id=&limit=&cursor=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "cash-drawers", "shifts", ":shift_id", "events" ], "query": [ { "description": "(Required) The ID of the location to list cash drawer shifts for.", "key": "location_id", "value": "" }, { "description": "Number of resources to be returned in a page of results (200 by\ndefault, 1000 max).", "key": "limit", "value": "" }, { "description": "Opaque cursor for fetching the next page of results.", "key": "cursor", "value": "" } ], "variable": [ { "id": "59ad2760-fccd-42f5-b1b1-addf6d4ea3fb", "key": "shift_id", "value": "", "description": "(Required) The shift ID." } ] }, "description": "Provides a paginated list of events for a single cash drawer shift." }, "response": [ { "id": "25a7d27f-d3f3-4c42-9db5-a9bd143745c2", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/cash-drawers/shifts/:shift_id/events?location_id=&limit=&cursor=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "cash-drawers", "shifts", ":shift_id", "events" ], "query": [ { "description": "(Required) The ID of the location to list cash drawer shifts for.", "key": "location_id", "value": "" }, { "description": "Number of resources to be returned in a page of results (200 by\ndefault, 1000 max).", "key": "limit", "value": "" }, { "description": "Opaque cursor for fetching the next page of results.", "key": "cursor", "value": "" } ], "variable": [ { "key": "shift_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"cursor\": \"\",\n \"errors\": [\n {\n \"category\": \"MERCHANT_SUBSCRIPTION_ERROR\",\n \"code\": \"GONE\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"AUTHENTICATION_ERROR\",\n \"code\": \"REQUEST_TIMEOUT\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"cash_drawer_shift_events\": [\n {\n \"id\": \"\",\n \"event_type\": \"OTHER_TENDER_REFUND\",\n \"event_money\": {\n \"amount\": \"\",\n \"currency\": \"GYD\"\n },\n \"created_at\": \"\",\n \"description\": \"\",\n \"team_member_id\": \"\"\n },\n {\n \"id\": \"\",\n \"event_type\": \"OTHER_TENDER_PAYMENT\",\n \"event_money\": {\n \"amount\": \"\",\n \"currency\": \"USD\"\n },\n \"created_at\": \"\",\n \"description\": \"\",\n \"team_member_id\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:01:54.000Z", "updatedAt": "2026-07-28T03:01:54.000Z", "uid": "35240-25a7d27f-d3f3-4c42-9db5-a9bd143745c2" } ], "createdAt": "2026-07-28T03:01:54.000Z", "updatedAt": "2026-07-28T03:01:54.000Z", "uid": "35240-fe9192ae-5a67-43ba-8155-0b3b463699a1" } ], "id": "f919867b-4149-46f0-8491-e1e5f891ae23", "createdAt": "2026-07-28T03:01:54.000Z", "updatedAt": "2026-07-28T03:01:54.000Z", "uid": "35240-f919867b-4149-46f0-8491-e1e5f891ae23" }, { "name": "Square Retrieve Cash Drawer Shift", "id": "e5f59aaf-faba-4863-958a-4702da201b7a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/cash-drawers/shifts/:shift_id?location_id=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "cash-drawers", "shifts", ":shift_id" ], "query": [ { "description": "(Required) The ID of the location to retrieve cash drawer shifts from.", "key": "location_id", "value": "" } ], "variable": [ { "id": "a3ab5720-d69a-4d08-93de-bcf5ac82f634", "key": "shift_id", "value": "", "description": "(Required) The shift ID." } ] }, "description": "Provides the summary details for a single cash drawer shift. See\n[ListCashDrawerShiftEvents](api-endpoint:CashDrawers-ListCashDrawerShiftEvents) for a list of cash drawer shift events." }, "response": [ { "id": "f53e68b0-5ffb-4fc9-a8a3-e1e4253e65e9", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/cash-drawers/shifts/:shift_id?location_id=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "cash-drawers", "shifts", ":shift_id" ], "query": [ { "description": "(Required) The ID of the location to retrieve cash drawer shifts from.", "key": "location_id", "value": "" } ], "variable": [ { "key": "shift_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"cash_drawer_shift\": {\n \"id\": \"\",\n \"state\": \"ENDED\",\n \"opened_at\": \"\",\n \"ended_at\": \"\",\n \"closed_at\": \"\",\n \"description\": \"\",\n \"opened_cash_money\": {\n \"amount\": \"\",\n \"currency\": \"COU\"\n },\n \"cash_payment_money\": {\n \"amount\": \"\",\n \"currency\": \"XCD\"\n },\n \"cash_refunds_money\": {\n \"amount\": \"\",\n \"currency\": \"TTD\"\n },\n \"cash_paid_in_money\": {\n \"amount\": \"\",\n \"currency\": \"LKR\"\n },\n \"cash_paid_out_money\": {\n \"amount\": \"\",\n \"currency\": \"GIP\"\n },\n \"expected_cash_money\": {\n \"amount\": \"\",\n \"currency\": \"BIF\"\n },\n \"closed_cash_money\": {\n \"amount\": \"\",\n \"currency\": \"SLL\"\n },\n \"device\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"location_id\": \"\",\n \"team_member_ids\": [\n \"\"\n ],\n \"opening_team_member_id\": \"\",\n \"ending_team_member_id\": \"\",\n \"closing_team_member_id\": \"\"\n },\n \"errors\": [\n {\n \"category\": \"EXTERNAL_VENDOR_ERROR\",\n \"code\": \"INVALID_CONTENT_TYPE\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:01:54.000Z", "updatedAt": "2026-07-28T03:01:54.000Z", "uid": "35240-f53e68b0-5ffb-4fc9-a8a3-e1e4253e65e9" } ], "createdAt": "2026-07-28T03:01:54.000Z", "updatedAt": "2026-07-28T03:01:54.000Z", "uid": "35240-e5f59aaf-faba-4863-958a-4702da201b7a" } ], "id": "e7e2c08a-6845-422b-ac97-b41ec6e24936", "createdAt": "2026-07-28T03:01:54.000Z", "updatedAt": "2026-07-28T03:01:54.000Z", "uid": "35240-e7e2c08a-6845-422b-ac97-b41ec6e24936" }, { "name": "Square List Cash Drawer Shifts", "id": "36050232-d12a-409e-89cc-e4fe7dcd9462", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/cash-drawers/shifts?location_id=&sort_order=DESC&begin_time=&end_time=&limit=&cursor=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "cash-drawers", "shifts" ], "query": [ { "description": "(Required) The ID of the location to query for a list of cash drawer shifts.", "key": "location_id", "value": "" }, { "description": "The order in which cash drawer shifts are listed in the response,\nbased on their opened_at field. Default value: ASC", "key": "sort_order", "value": "DESC" }, { "description": "The inclusive start time of the query on opened_at, in ISO 8601 format.", "key": "begin_time", "value": "" }, { "description": "The exclusive end date of the query on opened_at, in ISO 8601 format.", "key": "end_time", "value": "" }, { "description": "Number of cash drawer shift events in a page of results (200 by\ndefault, 1000 max).", "key": "limit", "value": "" }, { "description": "Opaque cursor for fetching the next page of results.", "key": "cursor", "value": "" } ] }, "description": "Provides the details for all of the cash drawer shifts for a location\nin a date range." }, "response": [ { "id": "96bfb1ed-8e09-4cf1-964b-679edb93fa3b", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/cash-drawers/shifts?location_id=&sort_order=DESC&begin_time=&end_time=&limit=&cursor=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "cash-drawers", "shifts" ], "query": [ { "description": "(Required) The ID of the location to query for a list of cash drawer shifts.", "key": "location_id", "value": "" }, { "description": "The order in which cash drawer shifts are listed in the response,\nbased on their opened_at field. Default value: ASC", "key": "sort_order", "value": "DESC" }, { "description": "The inclusive start time of the query on opened_at, in ISO 8601 format.", "key": "begin_time", "value": "" }, { "description": "The exclusive end date of the query on opened_at, in ISO 8601 format.", "key": "end_time", "value": "" }, { "description": "Number of cash drawer shift events in a page of results (200 by\ndefault, 1000 max).", "key": "limit", "value": "" }, { "description": "Opaque cursor for fetching the next page of results.", "key": "cursor", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"cursor\": \"\",\n \"errors\": [\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"PLAID_ERROR_RATE_LIMIT\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"cash_drawer_shifts\": [\n {\n \"id\": \"\",\n \"state\": \"OPEN\",\n \"opened_at\": \"\",\n \"ended_at\": \"\",\n \"closed_at\": \"\",\n \"description\": \"\",\n \"opened_cash_money\": {\n \"amount\": \"\",\n \"currency\": \"BAM\"\n },\n \"expected_cash_money\": {\n \"amount\": \"\",\n \"currency\": \"NAD\"\n },\n \"closed_cash_money\": {\n \"amount\": \"\",\n \"currency\": \"XAG\"\n },\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"location_id\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:01:54.000Z", "updatedAt": "2026-07-28T03:01:54.000Z", "uid": "35240-96bfb1ed-8e09-4cf1-964b-679edb93fa3b" } ], "createdAt": "2026-07-28T03:01:54.000Z", "updatedAt": "2026-07-28T03:01:54.000Z", "uid": "35240-36050232-d12a-409e-89cc-e4fe7dcd9462" } ], "id": "f6342c25-45e9-4a82-9ebc-ff75ad1c53cb", "createdAt": "2026-07-28T03:01:54.000Z", "updatedAt": "2026-07-28T03:01:54.000Z", "uid": "35240-f6342c25-45e9-4a82-9ebc-ff75ad1c53cb" } ], "id": "30e4b8ce-5ffe-4c93-ae08-00b65c482409", "createdAt": "2026-07-28T03:01:54.000Z", "updatedAt": "2026-07-28T03:01:54.000Z", "uid": "35240-30e4b8ce-5ffe-4c93-ae08-00b65c482409" } ], "id": "6bca610d-fedb-413c-8936-b5d06feca0f4", "createdAt": "2026-07-28T03:01:54.000Z", "updatedAt": "2026-07-28T03:01:54.000Z", "uid": "35240-6bca610d-fedb-413c-8936-b5d06feca0f4" } ], "variable": [ { "key": "baseUrl", "value": "https://connect.squareup.com" } ] }