{ "opencollection": "1.0.0", "info": { "name": "Flipdish API - Apps Accounts CardReaders API", "version": "v1.0" }, "request": { "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "items": [ { "info": { "name": "CardReaders", "type": "folder" }, "items": [ { "info": { "name": "Flipdish Get Stripe Connection Token", "type": "http" }, "http": { "method": "GET", "url": "https://api.flipdish.co/api/v1.0/:appId/stripeterminal/connectiontoken", "params": [ { "name": "appId", "value": "500123", "type": "path", "description": "The app id path parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get Stripe Connection Token via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/stripeterminal/connectiontoken)." }, { "info": { "name": "Flipdish Card Readers_Get Reader", "type": "http" }, "http": { "method": "GET", "url": "https://api.flipdish.co/api/v1.0/:appId/payments/terminals/stripe/:readerId", "params": [ { "name": "readerId", "value": "500123", "type": "path", "description": "The reader id path parameter." }, { "name": "appId", "value": "500123", "type": "path", "description": "The app id path parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Card Readers_Get Reader via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/payments/terminals/stripe/{readerId})." }, { "info": { "name": "Flipdish Get Bluetooth Terminal Status", "type": "http" }, "http": { "method": "GET", "url": "https://api.flipdish.co/api/v1.0/:appId/cardreaders/kiosk/:deviceId/bluetooth/status", "params": [ { "name": "appId", "value": "500123", "type": "path", "description": "The app id path parameter." }, { "name": "deviceId", "value": "500123", "type": "path", "description": "The device id path parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get Bluetooth Terminal Status via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/cardreaders/kiosk/{deviceId}/bluetooth/status)." }, { "info": { "name": "Flipdish Generate Stripe Terminal Location", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/:appId/stripeterminal/location", "params": [ { "name": "appId", "value": "500123", "type": "path", "description": "The app id path parameter." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Generate Stripe Terminal Location via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/stripeterminal/location)." }, { "info": { "name": "Flipdish Register Stripe Terminal", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/:appId/payments/terminals/stripe/register", "params": [ { "name": "appId", "value": "500123", "type": "path", "description": "The app id path parameter." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Register Stripe Terminal via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/payments/terminals/stripe/register)." }, { "info": { "name": "Flipdish Cancel Reader Action", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/:appId/payments/terminals/stripe/:readerId/cancel_action", "params": [ { "name": "readerId", "value": "500123", "type": "path", "description": "The reader id path parameter." }, { "name": "appId", "value": "500123", "type": "path", "description": "The app id path parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Cancel Reader Action via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/payments/terminals/stripe/{readerId}/cancel_action)." }, { "info": { "name": "Flipdish Initiate Reader Process Payment Intent", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/:appId/payments/terminals/stripe/:readerId/processPaymentIntent", "params": [ { "name": "readerId", "value": "500123", "type": "path", "description": "The reader id path parameter." }, { "name": "appId", "value": "500123", "type": "path", "description": "The app id path parameter." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Initiate Reader Process Payment Intent via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/payments/terminals/stripe/{readerId}/processPaymentIntent)." }, { "info": { "name": "Flipdish Initiate Kiosk Bluetooth Pairing Mode", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/:appId/cardreaders/kiosk/:deviceId/bluetooth/:terminalType/pair", "params": [ { "name": "appId", "value": "500123", "type": "path", "description": "The app id path parameter." }, { "name": "deviceId", "value": "500123", "type": "path", "description": "The device id path parameter." }, { "name": "terminalType", "value": "CHIPPER_2X", "type": "path", "description": "The terminal type path parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Initiate Kiosk Bluetooth Pairing Mode via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/cardreaders/kiosk/{deviceId}/bluetooth/{terminalType}/pair)." }, { "info": { "name": "Flipdish Cancel Currently Initiated Bluetooth Device Update", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/:appId/cardreaders/kiosk/:deviceId/bluetooth/:terminalType/cancelUpdate", "params": [ { "name": "appId", "value": "500123", "type": "path", "description": "The app id path parameter." }, { "name": "deviceId", "value": "500123", "type": "path", "description": "The device id path parameter." }, { "name": "terminalType", "value": "CHIPPER_2X", "type": "path", "description": "The terminal type path parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Cancel Currently Initiated Bluetooth Device Update via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/cardreaders/kiosk/{deviceId}/bluetooth/{terminalType}/cancelUpdate)." }, { "info": { "name": "Flipdish Initiate Kiosk Bluetooth Update Install", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/:appId/cardreaders/kiosk/:deviceId/bluetooth/:terminalType/installUpdate", "params": [ { "name": "appId", "value": "500123", "type": "path", "description": "The app id path parameter." }, { "name": "deviceId", "value": "500123", "type": "path", "description": "The device id path parameter." }, { "name": "terminalType", "value": "CHIPPER_2X", "type": "path", "description": "The terminal type path parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Initiate Kiosk Bluetooth Update Install via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/cardreaders/kiosk/{deviceId}/bluetooth/{terminalType}/installUpdate)." }, { "info": { "name": "Flipdish Initiate Bluetooth Terminal Device Update Check", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/:appId/cardreaders/kiosk/:deviceId/bluetooth/:terminalType/checkForUpdate", "params": [ { "name": "appId", "value": "500123", "type": "path", "description": "The app id path parameter." }, { "name": "deviceId", "value": "500123", "type": "path", "description": "The device id path parameter." }, { "name": "terminalType", "value": "string", "type": "path", "description": "The terminal type path parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Initiate Bluetooth Terminal Device Update Check via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/cardreaders/kiosk/{deviceId}/bluetooth/{terminalType}/checkForUpdate)." }, { "info": { "name": "Flipdish Un Register Terminal", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.flipdish.co/api/v1.0/:appId/payments/terminals/stripe/unregister", "params": [ { "name": "appId", "value": "500123", "type": "path", "description": "The app id path parameter." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Un Register Terminal via the Flipdish Open API v1.0 (DELETE /api/v1.0/{appId}/payments/terminals/stripe/unregister)." }, { "info": { "name": "Flipdish Unpair Currently Paired Bluetooth Device", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.flipdish.co/api/v1.0/:appId/cardreaders/kiosk/:deviceId/bluetooth/unpair", "params": [ { "name": "appId", "value": "500123", "type": "path", "description": "The app id path parameter." }, { "name": "deviceId", "value": "500123", "type": "path", "description": "The device id path parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Unpair Currently Paired Bluetooth Device via the Flipdish Open API v1.0 (DELETE /api/v1.0/{appId}/cardreaders/kiosk/{deviceId}/bluetooth/unpair)." } ] } ], "bundled": true }