ch.postfinance.sdk.service

Class ChargeFlowService

java.lang.Object

ch.postfinance.sdk.service.ChargeFlowService

public class ChargeFlowService
extends Object

Constructor Summary

Constructors

Constructor and Description
ChargeFlowService(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
Transaction	applyFlow(Long spaceId, Long id) applyFlow
Transaction	applyFlow(Long spaceId, Long id, Map<String,Object> params) applyFlow
com.google.api.client.http.HttpResponse	applyFlowForHttpResponse(Long spaceId, Long id)
com.google.api.client.http.HttpResponse	applyFlowForHttpResponse(Long spaceId, Long id, Map<String,Object> params)
Transaction	cancelChargeFlow(Long spaceId, Long id) Cancel Charge Flow This operation cancels the charge flow that is linked with the transaction indicated by the given ID.
Transaction	cancelChargeFlow(Long spaceId, Long id, Map<String,Object> params) Cancel Charge Flow This operation cancels the charge flow that is linked with the transaction indicated by the given ID.
com.google.api.client.http.HttpResponse	cancelChargeFlowForHttpResponse(Long spaceId, Long id)
com.google.api.client.http.HttpResponse	cancelChargeFlowForHttpResponse(Long spaceId, Long id, Map<String,Object> params)
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)
String	fetchChargeFlowPaymentPageUrl(Long spaceId, Long id) Fetch Charge Flow Payment Page URL This operation allows to fetch the payment page URL that is been applied on the charge flow linked with the provided transaction.
String	fetchChargeFlowPaymentPageUrl(Long spaceId, Long id, Map<String,Object> params) Fetch Charge Flow Payment Page URL This operation allows to fetch the payment page URL that is been applied on the charge flow linked with the provided transaction.
com.google.api.client.http.HttpResponse	fetchChargeFlowPaymentPageUrlForHttpResponse(Long spaceId, Long id)
com.google.api.client.http.HttpResponse	fetchChargeFlowPaymentPageUrlForHttpResponse(Long spaceId, Long id, Map<String,Object> params)
ApiClient	getApiClient()
ChargeFlow	read(Long spaceId, Long id) Read Reads the entity with the given 'id' and returns it.
ChargeFlow	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<ChargeFlow>	search(Long spaceId, EntityQuery query) Search Searches for the entities as specified by the given query.
List<ChargeFlow>	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	updateRecipient(Long spaceId, Long transactionId, Long type, String recipient) updateRecipient
void	updateRecipient(Long spaceId, Long transactionId, Long type, String recipient, Map<String,Object> params) updateRecipient
com.google.api.client.http.HttpResponse	updateRecipientForHttpResponse(Long spaceId, Long transactionId, Long type, String recipient)
com.google.api.client.http.HttpResponse	updateRecipientForHttpResponse(Long spaceId, Long transactionId, Long type, String recipient, Map<String,Object> params)

Methods inherited from class java.lang.Object

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

Constructor Detail

ChargeFlowService

public ChargeFlowService(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

applyFlow

public Transaction applyFlow(Long spaceId,
                             Long id)
                      throws IOException

applyFlow

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 transaction id of the transaction which should be process asynchronously.

Returns:

Transaction

Throws:

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

See Also:

applyFlow Documentation

applyFlow

public Transaction applyFlow(Long spaceId,
                             Long id,
                             Map<String,Object> params)
                      throws IOException

applyFlow

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 transaction id of the transaction which should be process asynchronously.

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

Returns:

Transaction

Throws:

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

See Also:

applyFlow Documentation

applyFlowForHttpResponse

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

Throws:

IOException

applyFlowForHttpResponse

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

Throws:

IOException

cancelChargeFlow

public Transaction cancelChargeFlow(Long spaceId,
                                    Long id)
                             throws IOException

Cancel Charge Flow This operation cancels the charge flow that is linked with the transaction indicated by the given ID.

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 transaction for which the charge flow should be canceled.

Returns:

Transaction

Throws:

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

See Also:

Cancel Charge Flow Documentation

cancelChargeFlow

public Transaction cancelChargeFlow(Long spaceId,
                                    Long id,
                                    Map<String,Object> params)
                             throws IOException

Cancel Charge Flow This operation cancels the charge flow that is linked with the transaction indicated by the given ID.

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 transaction for which the charge flow should be canceled.

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

Returns:

Transaction

Throws:

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

See Also:

Cancel Charge Flow Documentation

cancelChargeFlowForHttpResponse

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

Throws:

IOException

cancelChargeFlowForHttpResponse

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

Throws:

IOException

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

fetchChargeFlowPaymentPageUrl

public String fetchChargeFlowPaymentPageUrl(Long spaceId,
                                            Long id)
                                     throws IOException

Fetch Charge Flow Payment Page URL This operation allows to fetch the payment page URL that is been applied on the charge flow linked with the provided transaction. The operation might return an empty result when no payment page is needed or can be invoked.

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 transaction id of the transaction for which the URL of the charge flow should be fetched.

Returns:

String

Throws:

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

See Also:

Fetch Charge Flow Payment Page URL Documentation

fetchChargeFlowPaymentPageUrl

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

Fetch Charge Flow Payment Page URL This operation allows to fetch the payment page URL that is been applied on the charge flow linked with the provided transaction. The operation might return an empty result when no payment page is needed or can be invoked.

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 transaction id of the transaction for which the URL of the charge flow should be fetched.

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

Returns:

String

Throws:

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

See Also:

Fetch Charge Flow Payment Page URL Documentation

fetchChargeFlowPaymentPageUrlForHttpResponse

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

Throws:

IOException

fetchChargeFlowPaymentPageUrlForHttpResponse

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

Throws:

IOException

read

public ChargeFlow 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 charge flow which should be returned.

Returns:

ChargeFlow

Throws:

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

See Also:

Read Documentation

read

public ChargeFlow 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 charge flow 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:

ChargeFlow

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<ChargeFlow> 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 charge flows which are returned by the search.

Returns:

List<ChargeFlow>

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<ChargeFlow> 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 charge flows 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<ChargeFlow>

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

updateRecipient

public void updateRecipient(Long spaceId,
                            Long transactionId,
                            Long type,
                            String recipient)
                     throws IOException

updateRecipient

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 -

transactionId - The transaction id of the transaction whose recipient should be updated.

type - The id of the charge flow configuration type to recipient should be updated for.

recipient - The recipient address that should be used to send the payment URL.

Throws:

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

See Also:

updateRecipient Documentation

updateRecipient

public void updateRecipient(Long spaceId,
                            Long transactionId,
                            Long type,
                            String recipient,
                            Map<String,Object> params)
                     throws IOException

updateRecipient

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 -

transactionId - The transaction id of the transaction whose recipient should be updated.

type - The id of the charge flow configuration type to recipient should be updated for.

recipient - The recipient address that should be used to send the payment URL.

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:

updateRecipient Documentation

updateRecipientForHttpResponse

public com.google.api.client.http.HttpResponse updateRecipientForHttpResponse(Long spaceId,
                                                                              Long transactionId,
                                                                              Long type,
                                                                              String recipient)
                                                                       throws IOException

Throws:

IOException

updateRecipientForHttpResponse

public com.google.api.client.http.HttpResponse updateRecipientForHttpResponse(Long spaceId,
                                                                              Long transactionId,
                                                                              Long type,
                                                                              String recipient,
                                                                              Map<String,Object> params)
                                                                       throws IOException

Throws:

IOException