ch.postfinance.sdk.service

Class PaymentTerminalService

java.lang.Object

ch.postfinance.sdk.service.PaymentTerminalService

public class PaymentTerminalService
extends Object

Constructor Summary

Constructors

Constructor and Description
PaymentTerminalService(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
Long	count(EntityQueryFilter filter, Long spaceId, Map<String,Object> params) Count Counts the number of items in the database as restricted by the given filter.
Long	count(Long spaceId, EntityQueryFilter filter) Count Counts the number of items in the database as restricted by the given filter.
com.google.api.client.http.HttpResponse	countForHttpResponse(EntityQueryFilter filter, Long spaceId, Map<String,Object> params)
com.google.api.client.http.HttpResponse	countForHttpResponse(Long spaceId, EntityQueryFilter filter)
com.google.api.client.http.HttpResponse	countForHttpResponse(Long spaceId, InputStream filter, String mediaType)
ApiClient	getApiClient()
void	link(Long spaceId, Long terminalId, String serialNumber) Link Device With Terminal Links the device with given serial number with terminal.
void	link(Long spaceId, Long terminalId, String serialNumber, Map<String,Object> params) Link Device With Terminal Links the device with given serial number with terminal.
com.google.api.client.http.HttpResponse	linkForHttpResponse(Long spaceId, Long terminalId, String serialNumber)
com.google.api.client.http.HttpResponse	linkForHttpResponse(Long spaceId, Long terminalId, String serialNumber, Map<String,Object> params)
PaymentTerminal	read(Long spaceId, Long id) Read Reads the entity with the given 'id' and returns it.
PaymentTerminal	read(Long spaceId, Long id, Map<String,Object> params) Read Reads the entity with the given 'id' and returns it.
com.google.api.client.http.HttpResponse	readForHttpResponse(Long spaceId, Long id)
com.google.api.client.http.HttpResponse	readForHttpResponse(Long spaceId, Long id, Map<String,Object> params)
List<PaymentTerminal>	search(Long spaceId, EntityQuery query) Search Searches for the entities as specified by the given query.
List<PaymentTerminal>	search(Long spaceId, EntityQuery query, Map<String,Object> params) Search Searches for the entities as specified by the given query.
com.google.api.client.http.HttpResponse	searchForHttpResponse(Long spaceId, EntityQuery query)
com.google.api.client.http.HttpResponse	searchForHttpResponse(Long spaceId, EntityQuery query, Map<String,Object> params)
com.google.api.client.http.HttpResponse	searchForHttpResponse(Long spaceId, InputStream query, String mediaType)
void	setApiClient(ApiClient apiClient)
void	triggerFinalBalance(Long spaceId, Long terminalId) Remotely Trigger Final Balance Remotely triggers the final balance receipt on the terminal.
void	triggerFinalBalance(Long spaceId, Long terminalId, Map<String,Object> params) Remotely Trigger Final Balance Remotely triggers the final balance receipt on the terminal.
void	triggerFinalBalanceByIdentifier(Long spaceId, String terminalIdentifier) Remotely Trigger Final Balance By Identifier Remotely triggers the final balance receipt on the terminal by terminal identifier.
void	triggerFinalBalanceByIdentifier(Long spaceId, String terminalIdentifier, Map<String,Object> params) Remotely Trigger Final Balance By Identifier Remotely triggers the final balance receipt on the terminal by terminal identifier.
com.google.api.client.http.HttpResponse	triggerFinalBalanceByIdentifierForHttpResponse(Long spaceId, String terminalIdentifier)
com.google.api.client.http.HttpResponse	triggerFinalBalanceByIdentifierForHttpResponse(Long spaceId, String terminalIdentifier, Map<String,Object> params)
com.google.api.client.http.HttpResponse	triggerFinalBalanceForHttpResponse(Long spaceId, Long terminalId)
com.google.api.client.http.HttpResponse	triggerFinalBalanceForHttpResponse(Long spaceId, Long terminalId, Map<String,Object> params)
void	unlink(Long spaceId, Long terminalId) Unlink Device With Terminal Unlinks the device from terminal.
void	unlink(Long spaceId, Long terminalId, Map<String,Object> params) Unlink Device With Terminal Unlinks the device from terminal.
com.google.api.client.http.HttpResponse	unlinkForHttpResponse(Long spaceId, Long terminalId)
com.google.api.client.http.HttpResponse	unlinkForHttpResponse(Long spaceId, Long terminalId, Map<String,Object> params)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PaymentTerminalService

public PaymentTerminalService(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

count

public Long count(Long spaceId,
                  EntityQueryFilter filter)
           throws IOException

Count Counts the number of items in the database as restricted by the given filter.

200 - This status code indicates that a client request was successfully received, understood, and accepted.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

spaceId -

filter - The filter which restricts the entities which are used to calculate the count.

Returns:

Long

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

Count Documentation

count

public Long count(EntityQueryFilter filter,
                  Long spaceId,
                  Map<String,Object> params)
           throws IOException

Count Counts the number of items in the database as restricted by the given filter.

200 - This status code indicates that a client request was successfully received, understood, and accepted.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

spaceId -

params - Map of query params. A collection will be interpreted as passing in multiple instances of the same query param.

Returns:

Long

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

Count Documentation

countForHttpResponse

public com.google.api.client.http.HttpResponse countForHttpResponse(Long spaceId,
                                                                    EntityQueryFilter filter)
                                                             throws IOException

Throws:

IOException

countForHttpResponse

public com.google.api.client.http.HttpResponse countForHttpResponse(Long spaceId,
                                                                    InputStream filter,
                                                                    String mediaType)
                                                             throws IOException

Throws:

IOException

countForHttpResponse

public com.google.api.client.http.HttpResponse countForHttpResponse(EntityQueryFilter filter,
                                                                    Long spaceId,
                                                                    Map<String,Object> params)
                                                             throws IOException

Throws:

IOException

link

public void link(Long spaceId,
                 Long terminalId,
                 String serialNumber)
          throws IOException

Link Device With Terminal Links the device with given serial number with terminal.

409 - This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

spaceId -

terminalId -

serialNumber -

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

Link Device With Terminal Documentation

link

public void link(Long spaceId,
                 Long terminalId,
                 String serialNumber,
                 Map<String,Object> params)
          throws IOException

Link Device With Terminal Links the device with given serial number with terminal.

409 - This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

spaceId -

terminalId -

serialNumber -

params - Map of query params. A collection will be interpreted as passing in multiple instances of the same query param.

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

Link Device With Terminal Documentation

linkForHttpResponse

public com.google.api.client.http.HttpResponse linkForHttpResponse(Long spaceId,
                                                                   Long terminalId,
                                                                   String serialNumber)
                                                            throws IOException

Throws:

IOException

linkForHttpResponse

public com.google.api.client.http.HttpResponse linkForHttpResponse(Long spaceId,
                                                                   Long terminalId,
                                                                   String serialNumber,
                                                                   Map<String,Object> params)
                                                            throws IOException

Throws:

IOException

read

public PaymentTerminal read(Long spaceId,
                            Long id)
                     throws IOException

Read Reads the entity with the given 'id' and returns it.

200 - This status code indicates that a client request was successfully received, understood, and accepted.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

spaceId -

id - The id of the payment terminal which should be returned.

Returns:

PaymentTerminal

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

Read Documentation

read

public PaymentTerminal read(Long spaceId,
                            Long id,
                            Map<String,Object> params)
                     throws IOException

Read Reads the entity with the given 'id' and returns it.

200 - This status code indicates that a client request was successfully received, understood, and accepted.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

spaceId -

id - The id of the payment terminal which should be returned.

params - Map of query params. A collection will be interpreted as passing in multiple instances of the same query param.

Returns:

PaymentTerminal

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

Read Documentation

readForHttpResponse

public com.google.api.client.http.HttpResponse readForHttpResponse(Long spaceId,
                                                                   Long id)
                                                            throws IOException

Throws:

IOException

readForHttpResponse

public com.google.api.client.http.HttpResponse readForHttpResponse(Long spaceId,
                                                                   Long id,
                                                                   Map<String,Object> params)
                                                            throws IOException

Throws:

IOException

search

public List<PaymentTerminal> search(Long spaceId,
                                    EntityQuery query)
                             throws IOException

Search Searches for the entities as specified by the given query.

200 - This status code indicates that a client request was successfully received, understood, and accepted.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

spaceId -

query - The query restricts the payment terminals which are returned by the search.

Returns:

List<PaymentTerminal>

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

Search Documentation

search

public List<PaymentTerminal> search(Long spaceId,
                                    EntityQuery query,
                                    Map<String,Object> params)
                             throws IOException

Search Searches for the entities as specified by the given query.

200 - This status code indicates that a client request was successfully received, understood, and accepted.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

spaceId -

query - The query restricts the payment terminals which are returned by the search.

params - Map of query params. A collection will be interpreted as passing in multiple instances of the same query param.

Returns:

List<PaymentTerminal>

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

Search Documentation

searchForHttpResponse

public com.google.api.client.http.HttpResponse searchForHttpResponse(Long spaceId,
                                                                     EntityQuery query)
                                                              throws IOException

Throws:

IOException

searchForHttpResponse

public com.google.api.client.http.HttpResponse searchForHttpResponse(Long spaceId,
                                                                     InputStream query,
                                                                     String mediaType)
                                                              throws IOException

Throws:

IOException

searchForHttpResponse

public com.google.api.client.http.HttpResponse searchForHttpResponse(Long spaceId,
                                                                     EntityQuery query,
                                                                     Map<String,Object> params)
                                                              throws IOException

Throws:

IOException

triggerFinalBalance

public void triggerFinalBalance(Long spaceId,
                                Long terminalId)
                         throws IOException

Remotely Trigger Final Balance Remotely triggers the final balance receipt on the terminal.

409 - This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

spaceId -

terminalId -

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

Remotely Trigger Final Balance Documentation

triggerFinalBalance

public void triggerFinalBalance(Long spaceId,
                                Long terminalId,
                                Map<String,Object> params)
                         throws IOException

Remotely Trigger Final Balance Remotely triggers the final balance receipt on the terminal.

409 - This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

spaceId -

terminalId -

params - Map of query params. A collection will be interpreted as passing in multiple instances of the same query param.

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

Remotely Trigger Final Balance Documentation

triggerFinalBalanceForHttpResponse

public com.google.api.client.http.HttpResponse triggerFinalBalanceForHttpResponse(Long spaceId,
                                                                                  Long terminalId)
                                                                           throws IOException

Throws:

IOException

triggerFinalBalanceForHttpResponse

public com.google.api.client.http.HttpResponse triggerFinalBalanceForHttpResponse(Long spaceId,
                                                                                  Long terminalId,
                                                                                  Map<String,Object> params)
                                                                           throws IOException

Throws:

IOException

triggerFinalBalanceByIdentifier

public void triggerFinalBalanceByIdentifier(Long spaceId,
                                            String terminalIdentifier)
                                     throws IOException

Remotely Trigger Final Balance By Identifier Remotely triggers the final balance receipt on the terminal by terminal identifier.

409 - This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

spaceId -

terminalIdentifier -

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

Remotely Trigger Final Balance By Identifier Documentation

triggerFinalBalanceByIdentifier

public void triggerFinalBalanceByIdentifier(Long spaceId,
                                            String terminalIdentifier,
                                            Map<String,Object> params)
                                     throws IOException

Remotely Trigger Final Balance By Identifier Remotely triggers the final balance receipt on the terminal by terminal identifier.

409 - This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

spaceId -

terminalIdentifier -

params - Map of query params. A collection will be interpreted as passing in multiple instances of the same query param.

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

Remotely Trigger Final Balance By Identifier Documentation

triggerFinalBalanceByIdentifierForHttpResponse

public com.google.api.client.http.HttpResponse triggerFinalBalanceByIdentifierForHttpResponse(Long spaceId,
                                                                                              String terminalIdentifier)
                                                                                       throws IOException

Throws:

IOException

triggerFinalBalanceByIdentifierForHttpResponse

public com.google.api.client.http.HttpResponse triggerFinalBalanceByIdentifierForHttpResponse(Long spaceId,
                                                                                              String terminalIdentifier,
                                                                                              Map<String,Object> params)
                                                                                       throws IOException

Throws:

IOException

unlink

public void unlink(Long spaceId,
                   Long terminalId)
            throws IOException

Unlink Device With Terminal Unlinks the device from terminal.

409 - This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

spaceId -

terminalId -

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

Unlink Device With Terminal Documentation

unlink

public void unlink(Long spaceId,
                   Long terminalId,
                   Map<String,Object> params)
            throws IOException

Unlink Device With Terminal Unlinks the device from terminal.

409 - This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

spaceId -

terminalId -

params - Map of query params. A collection will be interpreted as passing in multiple instances of the same query param.

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

Unlink Device With Terminal Documentation

unlinkForHttpResponse

public com.google.api.client.http.HttpResponse unlinkForHttpResponse(Long spaceId,
                                                                     Long terminalId)
                                                              throws IOException

Throws:

IOException

unlinkForHttpResponse

public com.google.api.client.http.HttpResponse unlinkForHttpResponse(Long spaceId,
                                                                     Long terminalId,
                                                                     Map<String,Object> params)
                                                              throws IOException

Throws:

IOException