Skip to content

Latest commit

 

History

History
713 lines (514 loc) · 22.6 KB

CardReadersApi.md

File metadata and controls

713 lines (514 loc) · 22.6 KB

CardReadersApi

All URIs are relative to https://api.flipdish.co

Method HTTP request Description
cancelCurrentlyInitiatedBluetoothDeviceUpdate POST /api/v1.0/{appId}/cardreaders/kiosk/{deviceId}/bluetooth/{terminalType}/cancelUpdate
cancelReaderAction POST /api/v1.0/{appId}/payments/terminals/stripe/{readerId}/cancel_action
cardReadersGetReader GET /api/v1.0/{appId}/payments/terminals/stripe/{readerId}
generateStripeTerminalLocation POST /api/v1.0/{appId}/stripeterminal/location
getBluetoothTerminalStatus GET /api/v1.0/{appId}/cardreaders/kiosk/{deviceId}/bluetooth/status
getStripeConnectionToken GET /api/v1.0/{appId}/stripeterminal/connectiontoken
initiateBluetoothTerminalDeviceUpdateCheck POST /api/v1.0/{appId}/cardreaders/kiosk/{deviceId}/bluetooth/{terminalType}/checkForUpdate
initiateKioskBluetoothPairingMode POST /api/v1.0/{appId}/cardreaders/kiosk/{deviceId}/bluetooth/{terminalType}/pair
initiateKioskBluetoothUpdateInstall POST /api/v1.0/{appId}/cardreaders/kiosk/{deviceId}/bluetooth/{terminalType}/installUpdate
initiateReaderProcessPaymentIntent POST /api/v1.0/{appId}/payments/terminals/stripe/{readerId}/processPaymentIntent
registerStripeTerminal POST /api/v1.0/{appId}/payments/terminals/stripe/register
unRegisterTerminal DELETE /api/v1.0/{appId}/payments/terminals/stripe/unregister
unpairCurrentlyPairedBluetoothDevice DELETE /api/v1.0/{appId}/cardreaders/kiosk/{deviceId}/bluetooth/unpair

cancelCurrentlyInitiatedBluetoothDeviceUpdate

cancelCurrentlyInitiatedBluetoothDeviceUpdate(appId, deviceId, terminalType)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.CardReadersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

CardReadersApi apiInstance = new CardReadersApi();
String appId = "appId_example"; // String | 
String deviceId = "deviceId_example"; // String | 
String terminalType = "terminalType_example"; // String | 
try {
    apiInstance.cancelCurrentlyInitiatedBluetoothDeviceUpdate(appId, deviceId, terminalType);
} catch (ApiException e) {
    System.err.println("Exception when calling CardReadersApi#cancelCurrentlyInitiatedBluetoothDeviceUpdate");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
deviceId String
terminalType String [enum: CHIPPER_2X, COTS_DEVICE, VERIFONE_P400, WISEPAD_3, WISEPOS_E]

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

cancelReaderAction

RestApiResultCardReader cancelReaderAction(readerId, appId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.CardReadersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

CardReadersApi apiInstance = new CardReadersApi();
String readerId = "readerId_example"; // String | 
String appId = "appId_example"; // String | 
try {
    RestApiResultCardReader result = apiInstance.cancelReaderAction(readerId, appId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CardReadersApi#cancelReaderAction");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
readerId String
appId String

Return type

RestApiResultCardReader

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

cardReadersGetReader

RestApiResultCardReader cardReadersGetReader(readerId, appId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.CardReadersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

CardReadersApi apiInstance = new CardReadersApi();
String readerId = "readerId_example"; // String | 
String appId = "appId_example"; // String | 
try {
    RestApiResultCardReader result = apiInstance.cardReadersGetReader(readerId, appId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CardReadersApi#cardReadersGetReader");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
readerId String
appId String

Return type

RestApiResultCardReader

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

generateStripeTerminalLocation

RestApiResultStripeTerminalLocation generateStripeTerminalLocation(geoPointRequest, appId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.CardReadersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

CardReadersApi apiInstance = new CardReadersApi();
GeoPointRequest geoPointRequest = new GeoPointRequest(); // GeoPointRequest | 
String appId = "appId_example"; // String | 
try {
    RestApiResultStripeTerminalLocation result = apiInstance.generateStripeTerminalLocation(geoPointRequest, appId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CardReadersApi#generateStripeTerminalLocation");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
geoPointRequest GeoPointRequest
appId String

Return type

RestApiResultStripeTerminalLocation

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml

getBluetoothTerminalStatus

RestApiResultBluetoothTerminalStatus getBluetoothTerminalStatus(appId, deviceId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.CardReadersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

CardReadersApi apiInstance = new CardReadersApi();
String appId = "appId_example"; // String | 
String deviceId = "deviceId_example"; // String | 
try {
    RestApiResultBluetoothTerminalStatus result = apiInstance.getBluetoothTerminalStatus(appId, deviceId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CardReadersApi#getBluetoothTerminalStatus");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
deviceId String

Return type

RestApiResultBluetoothTerminalStatus

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

getStripeConnectionToken

RestApiResultStripeTerminalConnectionToken getStripeConnectionToken(appId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.CardReadersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

CardReadersApi apiInstance = new CardReadersApi();
String appId = "appId_example"; // String | 
try {
    RestApiResultStripeTerminalConnectionToken result = apiInstance.getStripeConnectionToken(appId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CardReadersApi#getStripeConnectionToken");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String

Return type

RestApiResultStripeTerminalConnectionToken

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

initiateBluetoothTerminalDeviceUpdateCheck

initiateBluetoothTerminalDeviceUpdateCheck(appId, deviceId, terminalType)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.CardReadersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

CardReadersApi apiInstance = new CardReadersApi();
String appId = "appId_example"; // String | 
String deviceId = "deviceId_example"; // String | 
String terminalType = "terminalType_example"; // String | 
try {
    apiInstance.initiateBluetoothTerminalDeviceUpdateCheck(appId, deviceId, terminalType);
} catch (ApiException e) {
    System.err.println("Exception when calling CardReadersApi#initiateBluetoothTerminalDeviceUpdateCheck");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
deviceId String
terminalType String

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

initiateKioskBluetoothPairingMode

initiateKioskBluetoothPairingMode(appId, deviceId, terminalType)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.CardReadersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

CardReadersApi apiInstance = new CardReadersApi();
String appId = "appId_example"; // String | 
String deviceId = "deviceId_example"; // String | 
String terminalType = "terminalType_example"; // String | 
try {
    apiInstance.initiateKioskBluetoothPairingMode(appId, deviceId, terminalType);
} catch (ApiException e) {
    System.err.println("Exception when calling CardReadersApi#initiateKioskBluetoothPairingMode");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
deviceId String
terminalType String [enum: CHIPPER_2X, COTS_DEVICE, VERIFONE_P400, WISEPAD_3, WISEPOS_E]

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

initiateKioskBluetoothUpdateInstall

initiateKioskBluetoothUpdateInstall(appId, deviceId, terminalType)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.CardReadersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

CardReadersApi apiInstance = new CardReadersApi();
String appId = "appId_example"; // String | 
String deviceId = "deviceId_example"; // String | 
String terminalType = "terminalType_example"; // String | 
try {
    apiInstance.initiateKioskBluetoothUpdateInstall(appId, deviceId, terminalType);
} catch (ApiException e) {
    System.err.println("Exception when calling CardReadersApi#initiateKioskBluetoothUpdateInstall");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
deviceId String
terminalType String [enum: CHIPPER_2X, COTS_DEVICE, VERIFONE_P400, WISEPAD_3, WISEPOS_E]

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

initiateReaderProcessPaymentIntent

RestApiResultCardReader initiateReaderProcessPaymentIntent(request, readerId, appId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.CardReadersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

CardReadersApi apiInstance = new CardReadersApi();
ProcessPaymentIntentRequest request = new ProcessPaymentIntentRequest(); // ProcessPaymentIntentRequest | 
String readerId = "readerId_example"; // String | 
String appId = "appId_example"; // String | 
try {
    RestApiResultCardReader result = apiInstance.initiateReaderProcessPaymentIntent(request, readerId, appId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CardReadersApi#initiateReaderProcessPaymentIntent");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
request ProcessPaymentIntentRequest
readerId String
appId String

Return type

RestApiResultCardReader

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml

registerStripeTerminal

RestApiResultCardReader registerStripeTerminal(request, appId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.CardReadersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

CardReadersApi apiInstance = new CardReadersApi();
CardReaderRegistrationRequest request = new CardReaderRegistrationRequest(); // CardReaderRegistrationRequest | 
String appId = "appId_example"; // String | 
try {
    RestApiResultCardReader result = apiInstance.registerStripeTerminal(request, appId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CardReadersApi#registerStripeTerminal");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
request CardReaderRegistrationRequest
appId String

Return type

RestApiResultCardReader

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml

unRegisterTerminal

RestApiResultCardReader unRegisterTerminal(request, appId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.CardReadersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

CardReadersApi apiInstance = new CardReadersApi();
UnRegisterCardReaderRequest request = new UnRegisterCardReaderRequest(); // UnRegisterCardReaderRequest | 
String appId = "appId_example"; // String | 
try {
    RestApiResultCardReader result = apiInstance.unRegisterTerminal(request, appId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CardReadersApi#unRegisterTerminal");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
request UnRegisterCardReaderRequest
appId String

Return type

RestApiResultCardReader

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml

unpairCurrentlyPairedBluetoothDevice

unpairCurrentlyPairedBluetoothDevice(appId, deviceId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.CardReadersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

CardReadersApi apiInstance = new CardReadersApi();
String appId = "appId_example"; // String | 
String deviceId = "deviceId_example"; // String | 
try {
    apiInstance.unpairCurrentlyPairedBluetoothDevice(appId, deviceId);
} catch (ApiException e) {
    System.err.println("Exception when calling CardReadersApi#unpairCurrentlyPairedBluetoothDevice");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
deviceId String

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml