Skip to content

CardReadersApi.md

Latest commit

 

History

History
843 lines (631 loc) · 25.1 KB

CardReadersApi.md

File metadata and controls

843 lines (631 loc) · 25.1 KB

Flipdish.Api.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

void CancelCurrentlyInitiatedBluetoothDeviceUpdate (string appId, string deviceId, string terminalType)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class CancelCurrentlyInitiatedBluetoothDeviceUpdateExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CardReadersApi();
            var appId = appId_example;  // string | 
            var deviceId = deviceId_example;  // string | 
            var terminalType = terminalType_example;  // string | 

            try
            {
                apiInstance.CancelCurrentlyInitiatedBluetoothDeviceUpdate(appId, deviceId, terminalType);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CardReadersApi.CancelCurrentlyInitiatedBluetoothDeviceUpdate: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
deviceId string
terminalType string

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CancelReaderAction

RestApiResultCardReader CancelReaderAction (string readerId, string appId)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class CancelReaderActionExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CardReadersApi();
            var readerId = readerId_example;  // string | 
            var appId = appId_example;  // string | 

            try
            {
                RestApiResultCardReader result = apiInstance.CancelReaderAction(readerId, appId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CardReadersApi.CancelReaderAction: " + e.Message );
            }
        }
    }
}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CardReadersGetReader

RestApiResultCardReader CardReadersGetReader (string readerId, string appId)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class CardReadersGetReaderExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CardReadersApi();
            var readerId = readerId_example;  // string | 
            var appId = appId_example;  // string | 

            try
            {
                RestApiResultCardReader result = apiInstance.CardReadersGetReader(readerId, appId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CardReadersApi.CardReadersGetReader: " + e.Message );
            }
        }
    }
}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GenerateStripeTerminalLocation

RestApiResultStripeTerminalLocation GenerateStripeTerminalLocation (GeoPointRequest geoPointRequest, string appId)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GenerateStripeTerminalLocationExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CardReadersApi();
            var geoPointRequest = new GeoPointRequest(); // GeoPointRequest | 
            var appId = appId_example;  // string | 

            try
            {
                RestApiResultStripeTerminalLocation result = apiInstance.GenerateStripeTerminalLocation(geoPointRequest, appId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CardReadersApi.GenerateStripeTerminalLocation: " + e.Message );
            }
        }
    }
}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetBluetoothTerminalStatus

RestApiResultBluetoothTerminalStatus GetBluetoothTerminalStatus (string appId, string deviceId)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GetBluetoothTerminalStatusExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CardReadersApi();
            var appId = appId_example;  // string | 
            var deviceId = deviceId_example;  // string | 

            try
            {
                RestApiResultBluetoothTerminalStatus result = apiInstance.GetBluetoothTerminalStatus(appId, deviceId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CardReadersApi.GetBluetoothTerminalStatus: " + e.Message );
            }
        }
    }
}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetStripeConnectionToken

RestApiResultStripeTerminalConnectionToken GetStripeConnectionToken (string appId)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GetStripeConnectionTokenExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CardReadersApi();
            var appId = appId_example;  // string | 

            try
            {
                RestApiResultStripeTerminalConnectionToken result = apiInstance.GetStripeConnectionToken(appId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CardReadersApi.GetStripeConnectionToken: " + e.Message );
            }
        }
    }
}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

InitiateBluetoothTerminalDeviceUpdateCheck

void InitiateBluetoothTerminalDeviceUpdateCheck (string appId, string deviceId, string terminalType)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class InitiateBluetoothTerminalDeviceUpdateCheckExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CardReadersApi();
            var appId = appId_example;  // string | 
            var deviceId = deviceId_example;  // string | 
            var terminalType = terminalType_example;  // string | 

            try
            {
                apiInstance.InitiateBluetoothTerminalDeviceUpdateCheck(appId, deviceId, terminalType);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CardReadersApi.InitiateBluetoothTerminalDeviceUpdateCheck: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
deviceId string
terminalType string

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

InitiateKioskBluetoothPairingMode

void InitiateKioskBluetoothPairingMode (string appId, string deviceId, string terminalType)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class InitiateKioskBluetoothPairingModeExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CardReadersApi();
            var appId = appId_example;  // string | 
            var deviceId = deviceId_example;  // string | 
            var terminalType = terminalType_example;  // string | 

            try
            {
                apiInstance.InitiateKioskBluetoothPairingMode(appId, deviceId, terminalType);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CardReadersApi.InitiateKioskBluetoothPairingMode: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
deviceId string
terminalType string

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

InitiateKioskBluetoothUpdateInstall

void InitiateKioskBluetoothUpdateInstall (string appId, string deviceId, string terminalType)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class InitiateKioskBluetoothUpdateInstallExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CardReadersApi();
            var appId = appId_example;  // string | 
            var deviceId = deviceId_example;  // string | 
            var terminalType = terminalType_example;  // string | 

            try
            {
                apiInstance.InitiateKioskBluetoothUpdateInstall(appId, deviceId, terminalType);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CardReadersApi.InitiateKioskBluetoothUpdateInstall: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
deviceId string
terminalType string

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

InitiateReaderProcessPaymentIntent

RestApiResultCardReader InitiateReaderProcessPaymentIntent (ProcessPaymentIntentRequest request, string readerId, string appId)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class InitiateReaderProcessPaymentIntentExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CardReadersApi();
            var request = new ProcessPaymentIntentRequest(); // ProcessPaymentIntentRequest | 
            var readerId = readerId_example;  // string | 
            var appId = appId_example;  // string | 

            try
            {
                RestApiResultCardReader result = apiInstance.InitiateReaderProcessPaymentIntent(request, readerId, appId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CardReadersApi.InitiateReaderProcessPaymentIntent: " + e.Message );
            }
        }
    }
}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RegisterStripeTerminal

RestApiResultCardReader RegisterStripeTerminal (CardReaderRegistrationRequest request, string appId)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class RegisterStripeTerminalExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CardReadersApi();
            var request = new CardReaderRegistrationRequest(); // CardReaderRegistrationRequest | 
            var appId = appId_example;  // string | 

            try
            {
                RestApiResultCardReader result = apiInstance.RegisterStripeTerminal(request, appId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CardReadersApi.RegisterStripeTerminal: " + e.Message );
            }
        }
    }
}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UnRegisterTerminal

RestApiResultCardReader UnRegisterTerminal (UnRegisterCardReaderRequest request, string appId)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class UnRegisterTerminalExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CardReadersApi();
            var request = new UnRegisterCardReaderRequest(); // UnRegisterCardReaderRequest | 
            var appId = appId_example;  // string | 

            try
            {
                RestApiResultCardReader result = apiInstance.UnRegisterTerminal(request, appId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CardReadersApi.UnRegisterTerminal: " + e.Message );
            }
        }
    }
}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UnpairCurrentlyPairedBluetoothDevice

void UnpairCurrentlyPairedBluetoothDevice (string appId, string deviceId)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class UnpairCurrentlyPairedBluetoothDeviceExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CardReadersApi();
            var appId = appId_example;  // string | 
            var deviceId = deviceId_example;  // string | 

            try
            {
                apiInstance.UnpairCurrentlyPairedBluetoothDevice(appId, deviceId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CardReadersApi.UnpairCurrentlyPairedBluetoothDevice: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
deviceId string

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]