Documentation

1Introduction

This document explains common aspects of all the REST services. Use the index on the right side to quickly navigate through the chapters. An overview over and introduction to the Rest services can be found in the general documentation.

1.1Type System

The REST service is based up on the following basic types. They are considered as primitives.

Long

A long is a number consisting only of digits. It is has a size of 64 bit.

Integer

An integer is a number consisting only of digits. It is has a size of 32 bit.

String

A string consists of digits or chars. The size is not limited by definition. However the parameters and properties may specify explicitly a size.

Boolean

A boolean holds either true or false.

Decimal

A decimal is floating point number. We typically have 19 digits and 8 decimal places.

Date

A date defines a specific day. We represent dates as strings since JSON does not provide a standard way to represent dates. We format the dates according to ISO 8601 (e.g. 2012-04-23). A date will not contain a time zone. If it is relevant to attach a time to the corresponding date we use UTC for this purpose. If you are in doubts how to convert to a date use UTC.

DateTime

A date defines a specific point in time. We represent dates as strings since JSON does not provide a standard way to represent dates. We format the dates according to ISO 8601 (e.g. 2012-04-23T18:25:43.511[Europe/Berlin]). When no time zone is provided we will use the time zone based on the current acting user or UTC. We strongly recommend always providing a time zone.

Duration

A duration defines a time span between to time points (e.g. one month). A duration is represented as a String in the duration format of ISO 8601 (e.g. P1M).

Complex Object

A complex object consists of a set of properties. Each property can have again a primitive type, a complex object or a collection.

Collection

A collection is a list of either primitives or a list of complex objects. A collection consists always of the same type. We do not mix types within a collection.

Binary

A binary contains data in a arbitrary format. The corresponding format is indicated along the type (e.g. text/csv)

1.2Object Versioning / Locking

The API returns objects and allows to update those objects. This may lead to race conditions when the same object is modified by multiple users or processes at the same time. Each potentially affected object contains a property version. This version is incremented whenever a change on it is applied. Before an update is applied on the object the version is verified to be still the same. If this check fails the update fails. This version number is also updated when a change is applied through the user interface. As a consequence to update a particular object the version property has to be passed. This concept is also known as optimistic locking.

The failure of an update should be handled depending on the context. Generally there are two options:

  • If a user was the trigger for the update let the user apply the update again. The latest version should be fetched and presented to the user to update the object again.

  • If an automated process is the trigger of the update the update should be wrapped within a loop which retries on a failure to update the object multiple times.

When a request leads to a conflict we return a 409 HTTP status.

1.3Entity Search

For most entities there is a search operation. The search allows to fetch only particular entities. Means the returned entities are filtered by a query. The query is structured similar to a SQL query. Essentially there is a part which limits the result and there is a paging mechanism. The model definition Entity Query defines the whole query.

The filter object allows to formulate the restrictions. The expression is similar to the WHERE part in an SQL statement. It is a recursive data structure which allows to define AND and OR groups. Each group can have multiple restrictions on properties. The fieldName can reference a property or it can be a path to a property. As an example to get all application users which are linked with the account test the following query can be used:

{
	'filter': {
		'fieldName': 'primaryAccount.name',
		'operator': 'EQUALS',
		'type': 'LEAF',
		'value': 'test'
	}
}

Beside the restriction given through the filter the query can also order the results by a fieldName. As the fieldName of the filter the fieldName of the orderBys can use the dot notation to order by a foreign property.

The paging can be realized by indicating the startingEntity and the numberOfEntities. The startingEntity indicates the entity with which the result should start. The numberOfEntities controls how many results should be returned. The get the total count for a particular filter the count operation can be used.

There are some limitation regarding the fields which can be used to filter results. Not all fields can be used for filtering and sorting. The fields which are marked as virtual cannot be used for filtering and ordering. Additionally if the relationship between entities are implemented with a reference consisting of a long the relationship cannot be used for ordering and filtering.

Some properties may be language aware. As such the filtering and ordering will impact the result. As such it is recommended to provide a language to make sure that the right results are returned. If no language is provided either the default language (en-US) is used or the language we may detect within the HTTP request.

1.4Machine-readable API Definition / Swagger

The description of the API in this document is intended to be used when the API is integrated without using a software development kit (SDK) and it is intended to be used as a reference to understand each single service.

To simplify the integration we provide the API definition also in a machine readable format. The service description is written in Swagger. It can be found under Swagger. The Swagger documentation may provide more details about how to use the provided JSON file.

Swagger uses tags to group operations together and each operation is uniquely identified by an operationId. The Swagger specification is not strict enough to generate meaningful client code. As such we introduce the following conventions:

  1. Each operation will be tagged exactly with one tag. This tag correspond to the service name. It is always in camel case.

  2. Each operationId starts with the operation tag followed by a underscore (_) and an operation name. This operation name is unique per service. Means each tag will contain exactly one such operation name and not more. This operation name is also in camel case.

We recommend to create a class per service (tag) and each such service class can hold all operations of this particular tag. The operation name can be used as the method name of the operation within the class. Client languages which are not object oriented may use the whole operationId as the identifier. We ensure that the operationId is stable over time.

1.5SDK

We provide software development kits (SDK) for several programming languages. Those SDK reduce your effort to integrate our services. All available SDKs including documentation can be accessed via our Github Repository.

1.6Meta Data

There are objects which contain meta data. Meta data properties allow to store arbitrary data along the object. The data provided is not changed or touched by our system. However it can be accessed as any other property of the object. The data can be accessed over the web service API, but also within templates etc. The meta data property is a key / value store.

There are some limits what can be stored and how it can be stored:

  • Per object no more than 25 key / value pairs can be provided.

  • A key cannot be longer as 40 chars.

  • A value cannot be longer as 512 chars.

  • The key can only contain alphabetic chars, numeric chars and underscores. The key cannot starts with an underscore or a number. The regex against we validate the key is: [a-zA-Z]{1}[a-zA-Z0-9_]{0,39}

  • The value can contain any printable UTF-8 char including line breaks. However stop chars etc. are not permitted. The value can also contain HTML tags.

2Authentication

In order to use the REST services you will have to properly authenticate in the web service API. In order to authenticate a request we use a MAC authentication algorithm. How this authentication algorithm has to be implemented - in case you do not use our libraries - is described in details here.

2.1Basics

The MAC authentication requires four custom HTTP headers to be sent with each request:

  • x-mac-version: To indicate the algorithm version. For the current this will always be the single digit 1.

  • x-mac-userid: The user ID (an unsigned integer) formatted as a decimal number.

  • x-mac-timestamp: The time formated as unix timestamp.

  • x-mac-value: The actual MAC value (a 64 byte value calculated as explained below) encoded in Base64 (with padding, using the standard alphabet) as defined in section 4 of RFC 4648.

Note
Splitting the Base64 string into whitespace separated chunks is accepted but not recommended.

Below you will find an example for the generation of a MAC value with example inputs including examples in some programming languages as guidelines.

2.2Getting the User ID and Authentication Key

To get the x-mac-userid you will first have to create an application user in your account. In order to do this navigate to Account > Users > Application Users and create your application user.

Once an application user is created you will see its ID in the corresponding column of the application user list. This value should be used for the x-mac-userid. In the image below it would be the userid 4.

Example Userid
Figure 1. Navigate to Account > Users > Application Users and get the userid. In this example it is the number 4.
Important
When you create a new user you will be displayed an application_user_key. This key represents the 32 byte authentication key encoded with Base-64. You should write that key down as it is used to sign the requests. For security reasons, the key will not be shown again! In case you loose the key, you will not be able to continue using that key. However you can create at any time a new key and deactivate the old one. The number of active keys a user can have is limited.

2.3Calculating the Time Stamp

The x-mac-timestamp is an unsigned integer (formatted as a decimal number) representing the number of seconds since midnight 1970‑01‑01. (See also UNIX Time Stamp in Wikipedia.)

The time in the request is needed to prevent relay attacks. In order to use the API you have to make sure that your server has set an accurate system time. We do currently allow a maximum of 600 seconds difference between our server time and your calculated time stamp.

The following example code demonstrates how to generated a time stamp using PHP:

<?php
// Assigns the current timestamp to the timestamp variable:
$timestamp = time();
?>

2.4Calculating the MAC Value

After you collected all the data you have to calculate the x-mac-value using the following input:

  1. Algorithm Version: The same fixed string as defined above in x-mac-version header.

  2. User ID: The user ID as used for the x-mac-userid header.

  3. Time stamp: The same string representing the current time as used for the x-mac-timestamp header.

  4. Method: The name of the HTTP method used for the request (as a string). This is normally one of the HTTP standard methods GET, HEAD, POST, PUT, DELETE, TRACE, CONNECT. Note: These values are case-sensitive; the standard methods are always uppercase.

  5. Path: The path component of the requested URL, including any query string (example see below).

To calculate the MAC, the strings from these items are concatenated into a single string (the authentication message) using the vertical bar |; (U+007C) as a separator.

This string is then encoded to a sequence of bytes using the UTF-8 encoding (without any byte order mark) according to RFC 3629. These bytes form the message which will be authenticated by the MAC which we generate.

Apart from the message bytes, the HMAC-SHA512 algorithm requires a secret key. In our case this is a sequence of exactly 32 bytes which you received in Base-64 encoding as the application_user_key when you created your application user (see above for more details). With this key you apply the HMAC-SHA512 algorithm to the message bytes and will receive a 64 byte MAC value as the result. This MAC value, again encoded in Base-64 code, will then be the value of x-mac-value header.

For a better understanding you will find an abstract illustration of the MAC calculation below in various programming languages.

2.5Example

In order to illustrate the above we created an example calculation with the following input values to generate an payment page displayed in an iframe. We will guide you through the implementation first a low level implementation. However, you find further down some concrete implementation in various programming languages based on the example values below.

  1. x-mac-version header: 1

  2. x-mac-userid header: 2481632

  3. x-mac-timestamp header: 1425387916

  4. Method: GET

  5. Path: /api/transaction/read?spaceId=12&id=1

  6. Authentication-Key: OWOMg2gnaSx1nukAM6SN2vxedfY1yLPONvcTKbhDv7I=

Concatenating items 1. through 5. with | as the separator we get the following string:

1|2481632|1425387916|GET|/api/transaction/read?spaceId=12&id=1

Which, encoded with UTF-8, results in our Authentication Message (shown as a sequence of 95 bytes in hex):

0x31, 0x7c, 0x32, 0x34, 0x38, 0x31, 0x36, 0x33, 0x32, 0x7c, 0x31, 0x34, 0x32, 0x35, 0x33, 0x38,
0x37, 0x39, 0x31, 0x36, 0x7c, 0x47, 0x45, 0x54, 0x7c, 0x2f, 0x61, 0x70, 0x69, 0x2f, 0x74, 0x72,
0x61, 0x6e, 0x73, 0x61, 0x63, 0x74, 0x69, 0x6f, 0x6e, 0x2f, 0x72, 0x65, 0x61, 0x64, 0x3f, 0x73,
0x70, 0x61, 0x63, 0x65, 0x49, 0x64, 0x3d, 0x31, 0x32, 0x26, 0x69, 0x64, 0x3d, 0x31

Decoding the Authentication-Key into a sequence of 32 bytes gives:

0x39, 0x63, 0x8c, 0x83, 0x68, 0x27, 0x69, 0x2c, 0x75, 0x9e, 0xe9, 0x00, 0x33, 0xa4, 0x8d, 0xda,
0xfc, 0x5e, 0x75, 0xf6, 0x35, 0xc8, 0xb3, 0xce, 0x36, 0xf7, 0x13, 0x29, 0xb8, 0x43, 0xbf, 0xb2

Now we apply the HMAC-SHA512 function with the Authentication-Key as the key and the Authentication Message as the message and get the following 64 bytes sequence as the resulting MAC value:

0xb7, 0x3e, 0xd1, 0xa9, 0x10, 0x47, 0xf0, 0x61, 0x30, 0xdb, 0xdb, 0x63, 0xdb, 0xfc, 0x7b, 0xea,
0x8a, 0x4a, 0x9a, 0x56, 0xed, 0x86, 0x40, 0x85, 0x24, 0xba, 0xa2, 0xc2, 0x42, 0x88, 0x51, 0x90,
0x4a, 0x88, 0xcd, 0x47, 0x68, 0x77, 0xa2, 0xb0, 0x2f, 0xc8, 0x43, 0x36, 0x84, 0x80, 0x20, 0xcc,
0x83, 0x40, 0x88, 0xd2, 0x4b, 0xc9, 0x74, 0xf0, 0x26, 0x6d, 0x2d, 0x75, 0xa3, 0x1c, 0xf3, 0xe1,

The above sequence encoded in Base-64 finally gives the string which should be used as the value of the x-mac-value header:

tz7RqRBH8GEw29tj2/x76opKmlbthgSFJLqiwkKIUQlKiM1HaHeisC/IQzaEgALMgwSI0kvJdPAmbS11oxzz4Q==

2.5.1PHP

To create an authentication in PHP use the example below as an illustration on how to create the x-mac-value.

<?php
$decodedSecret = base64_decode("OWOMg2gnaSx1nukAM6SN2vxedfY1yLPONvcTKbhDv7I=");
echo base64_encode(hash_hmac("sha512", "1|2481632|1425387916|GET|/api/transaction/read?spaceId=12&id=1", $decodedSecret, true));
?>

2.5.2Java

To create an authentication in Java use the example below as an illustration on how to create the x-mac-value.

import java.nio.charset.StandardCharsets;
import java.security.InvalidKeyException;
import java.security.NoSuchAlgorithmException;
import java.util.Base64;

import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;

public class Test {
	public static void main(String[] args) throws NoSuchAlgorithmException, InvalidKeyException {
		String securedData =
				"1|2481632|1425387916|GET|/api/transaction/read?spaceId=12&id=1";

		String secret = "OWOMg2gnaSx1nukAM6SN2vxedfY1yLPONvcTKbhDv7I=";
		byte[] decodedSecret = Base64.getDecoder().decode(secret);

		Mac mac = Mac.getInstance("HmacSHA512");
		mac.init(new SecretKeySpec(decodedSecret, "HmacSHA512"));

		byte[] bytes = mac.doFinal(securedData.getBytes(StandardCharsets.UTF_8));

		System.out.println(new String(Base64.getEncoder().encode(bytes), StandardCharsets.UTF_8));
	}
}

2.5.3Python

To create an authentication in Python use the example below as an illustration on how to create the x-mac-value.

import hashlib
import hmac
import base64

def sign(secret, userId, method, path, timestamp):
    data = "1|" + str(userId) + "|"+str(timestamp)+"|" + method + "|" + path
    return hmac.new(base64.b64decode(secret), data, hashlib.sha512).digest().encode("base64").replace('\n', '')

print sign("OWOMg2gnaSx1nukAM6SN2vxedfY1yLPONvcTKbhDv7I=", "2481632", "GET", "/api/transaction/read?spaceId=12&id=1", 1425387916)

2.6MAC Calculation Illustrated

The following diagram illustrates the calculation of the complete algorithm described above:

MAC Authentication Algorithm
Figure 2. Diagram illustrating the HMAC value calculation

2.7Request Logging

In some cases it helps when you can attach to each request an ID to trace the request through different systems. By adding the HTTP header x-wallee-logtoken you can send a request token which is added to our logs and we can trace it when you get in contact with us. The log token should contain a unique ID per request.

3Services

In this section all services are described. Each service is responsible for handling one particular entity.

A service consists of different operations. Each operation may accept a set of query parameter and depending on the request method a body message. The query parameter need to be append to the request URL according to the RFC 3986. The body message has to be sent within the body of the HTTP request.

Below there is a complete HTTP request for a notional service SomeService.

POST /api/SomeService/operationName?queryParameter1=valueOfQueryParameter1&queryParameter2=value2 HTTP/1.0
x-mac-version: 1
x-mac-userid: 12313
x-mac-timestamp: 1471016771
x-mac-value: (hash-calculated as described in the previous section)

{"some-property": "some-value", "other-value": 123}

The service will return a response. Depending on the response code the body may contain some JSON object. Each service states what kind of responses can be expected.

3.1Core

3.1.1Account Service

3.1.1.1Update

This updates the entity with the given properties. Only those properties which should be updated can be provided. The 'id' and 'version' are required to identify the entity.

POST /api/account/update View in Client
Message Body *
The account object with all the properties which should be updated. The id and the version are required properties.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.1.1.2Search

Searches for the entities as specified by the given query.

POST /api/account/search View in Client
Message Body *
The query restricts the accounts which are returned by the search.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Account
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.1.1.3Read

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

GET /api/account/read View in Client
Query Parameters
  • id
    *
    The id of the account which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.1.1.4Create

Creates the entity with the given properties.

POST /api/account/create View in Client
Message Body *
The account object with the properties which should be created.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.1.1.5Delete

Deletes the entity with the given id.

POST /api/account/delete View in Client
Message Body *
Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    No Response Body
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.1.1.6Count

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

POST /api/account/count View in Client
Message Body
The filter which restricts the entities which are used to calculate the count.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Long
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.1.2Metric Usage Service

The metric usage service allows to query used resources.

3.1.2.1Calculate

Calculates the consumed resources for the given space and time range.

POST /api/mertic-usage/calculate View in Client
Query Parameters
  • spaceId
    *
    Long
  • start
    *
    The start date from which on the consumed units should be returned from.
    DateTime
  • end
    *
    The end date to which the consumed units should be returned to. The end date is not included in the result.
    DateTime
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Metric Usage
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.1.3Space Service

3.1.3.1Read

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

GET /api/space/read View in Client
Query Parameters
  • id
    *
    The id of the space which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.1.3.2Count

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

POST /api/space/count View in Client
Message Body
The filter which restricts the entities which are used to calculate the count.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Long
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.1.3.3Update

This updates the entity with the given properties. Only those properties which should be updated can be provided. The 'id' and 'version' are required to identify the entity.

POST /api/space/update View in Client
Message Body *
The space object with all the properties which should be updated. The id and the version are required properties.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.1.3.4Search

Searches for the entities as specified by the given query.

POST /api/space/search View in Client
Message Body *
The query restricts the spaces which are returned by the search.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Space
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.1.3.5Create

Creates the entity with the given properties.

POST /api/space/create View in Client
Message Body *
The space object with the properties which should be created.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.1.3.6Delete

Deletes the entity with the given id.

POST /api/space/delete View in Client
Message Body *
Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    No Response Body
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.1.4Web App Service

The web app service allows to manage the installation of web apps.

3.1.4.1Uninstall

This operation uninstalls the web app from the provided space. The web app is implied by the client ID resp. user ID that is been used to invoke this operation.

POST /api/web-app/uninstall View in Client
Query Parameters
  • spaceId
    *
    This parameter identifies the space within which the web app should be uninstalled.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    No Response Body
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.1.4.2Confirm

This operation confirms the app installation. This method has to be invoked after the user returns to the web app. The request of the user will contain the code as a request parameter. The web app is implied by the client ID resp. user ID that is been used to invoke this operation.

POST /api/web-app/confirm View in Client
Message Body *
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.1.4.3Check Installation

This operation returns true when the app is installed in given space. The web app is implied by the client ID resp. user ID that is been used to invoke this operation.

GET /api/web-app/check-installation View in Client
Query Parameters
  • spaceId
    *
    This parameter identifies the space which should be checked if the web app is installed.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Boolean
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.2Customer

3.2.1Customer Address Service

3.2.1.1Update

This updates the entity with the given properties. Only those properties which should be updated can be provided. The 'id' and 'version' are required to identify the entity.

POST /api/customer-address/update View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The customer object with the properties which should be updated.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.2.1.2Search

Searches for the entities as specified by the given query.

POST /api/customer-address/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the customers which are returned by the search.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Customer Address
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.2.1.3selectDefaultAddress

GET /api/customer-address/select-default-address View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the customer address to set as default.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    No Response Body
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.2.1.4Create

Creates the entity with the given properties.

POST /api/customer-address/create View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The customer object which should be created.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.2.1.5Delete

Deletes the entity with the given id.

POST /api/customer-address/delete View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    No Response Body
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.2.1.6Read

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

GET /api/customer-address/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the customer which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.2.1.7Count

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

POST /api/customer-address/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Long
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.2.2Customer Comment Service

3.2.2.1pinComment

GET /api/customer-comment/pin-comment View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the customer comment to pin to the top.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    No Response Body
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.2.2.2Update

This updates the entity with the given properties. Only those properties which should be updated can be provided. The 'id' and 'version' are required to identify the entity.

POST /api/customer-comment/update View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The customer object with the properties which should be updated.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.2.2.3unpinComment

GET /api/customer-comment/unpin-comment View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the customer comment to unpin.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    No Response Body
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.2.2.4Read

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

GET /api/customer-comment/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the customer which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.2.2.5Search

Searches for the entities as specified by the given query.

POST /api/customer-comment/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the customers which are returned by the search.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Customer Comment
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.2.2.6Create

Creates the entity with the given properties.

POST /api/customer-comment/create View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The customer object which should be created.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.2.2.7Delete

Deletes the entity with the given id.

POST /api/customer-comment/delete View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    No Response Body
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.2.2.8Count

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

POST /api/customer-comment/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Long
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.2.3Customer Service

3.2.3.1Create

Creates the entity with the given properties.

POST /api/customer/create View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The customer object which should be created.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.2.3.2Delete

Deletes the entity with the given id.

POST /api/customer/delete View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    No Response Body
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.2.3.3Read

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

GET /api/customer/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the customer which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.2.3.4Count

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

POST /api/customer/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Long
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.2.3.5Update

This updates the entity with the given properties. Only those properties which should be updated can be provided. The 'id' and 'version' are required to identify the entity.

POST /api/customer/update View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The customer object with the properties which should be updated.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.2.3.6Search

Searches for the entities as specified by the given query.

POST /api/customer/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the customers which are returned by the search.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Customer
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.3Debt Collection

3.3.1Debt Collection Case Service

3.3.1.1Mark Case As Reviewed

This operation will mark a debt collection case as reviewed and allow the collection process to proceed.

POST /api/debt-collection-case/markAsReviewed View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the debt collection case which should be reviewed.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.3.1.2Update

This updates the entity with the given properties. Only those properties which should be updated can be provided. The 'id' and 'version' are required to identify the entity.

POST /api/debt-collection-case/update View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The object with all the properties which should be updated. The id and the version are required properties.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.3.1.3Search

Searches for the entities as specified by the given query.

POST /api/debt-collection-case/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the cases which are returned by the search.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.3.1.4Attach Document

Attach an additional supporting document to the case.

POST /api/debt-collection-case/attachDocument View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the debt collection case.
    Long
  • fileName
    *
    The file name of the document that is uploaded.
    String
  • contentBase64
    *
    The BASE64 encoded contents of the document.
    String
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.3.1.5Add Collected Amount

Adds a new collected amount to the case, creating a new payment receipt.

POST /api/debt-collection-case/addCollectedAmount View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the debt collection case for which the amount should be added.
    Long
  • collectedAmount
    *
    The amount that has been collected.
    Decimal
  • externalId
    *
    The unique external id of this payment receipt.
    String
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.3.1.6Count

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

POST /api/debt-collection-case/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Long
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.3.1.7Mark Case As Prepared

This operation will mark a debt collection case as prepared and allow the collection process to proceed.

POST /api/debt-collection-case/markAsPrepared View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the debt collection case which should be marked as prepared.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.3.1.8Delete

Deletes the entity with the given id.

POST /api/debt-collection-case/delete View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    No Response Body
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.3.1.9Create

Creates the entity with the given properties.

POST /api/debt-collection-case/create View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The debt collection case object with the properties which should be created.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.3.1.10Read

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

GET /api/debt-collection-case/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the debt collection case which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.3.1.11Documents

Returns all documents that are attached to a debt collection case.

POST /api/debt-collection-case/documents View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the debt collection case for which the attached documents are returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.3.1.12Close

Closes the debt collection case, meaning no further money can be collected.

POST /api/debt-collection-case/close View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the debt collection case which should be closed.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.3.2Debt Collector Configuration Service

3.3.2.1Count

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

POST /api/debt-collector-configuration/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Long
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.3.2.2Search

Searches for the entities as specified by the given query.

POST /api/debt-collector-configuration/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the debt collector configuration which are returned by the search.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.3.2.3Read

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

GET /api/debt-collector-configuration/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the debt collector configuration which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.3.3Debt Collector Service

3.3.3.1Read

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

GET /api/debt-collector/read View in Client
Query Parameters
  • id
    *
    The id of the collector which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.3.3.2All

This operation returns all entities which are available.

GET /api/debt-collector/all View in Client
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Debt Collector
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.4Document

3.4.1Document Template Service

3.4.1.1Read

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

GET /api/document-template/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the document template which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.4.1.2Search

Searches for the entities as specified by the given query.

POST /api/document-template/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the document templates which are returned by the search.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Document Template
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.4.1.3Count

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

POST /api/document-template/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Long
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.4.2Document Template Type

3.4.2.1Read

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

GET /api/document-template-type/read View in Client
Query Parameters
  • id
    *
    The id of the document template type which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.4.2.2All

This operation returns all entities which are available.

GET /api/document-template-type/all View in Client
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.5Installment

3.5.1Installment Payment Service

3.5.1.1Count

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

POST /api/installment-payment/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The filter which restricts the installment payment which are used to calculate the count.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Long
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.5.1.2Create Installment Payment

This operation creates based up on the given transaction an installment payment.

POST /api/installment-payment/createInstallmentPayment View in Client
Query Parameters
  • spaceId
    *
    Long
  • transactionId
    *
    The transaction which should be converted into an installment payment.
    Long
  • installmentPlanConfiguration
    *
    The installment plan configuration ID which should be applied on the transaction.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.5.1.3Search

Searches for the entities as specified by the given query.

POST /api/installment-payment/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the installment payments which are returned by the search.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Installment Payment
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.5.1.4Read

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

GET /api/installment-payment/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the installment payment which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.5.2Installment Payment Slice Service

3.5.2.1Count

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

POST /api/installment-payment-slice/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The filter which restricts the installment payment slices which are used to calculate the count.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Long
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.5.2.2Search

Searches for the entities as specified by the given query.

POST /api/installment-payment-slice/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the installment payment slices which are returned by the search.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.5.2.3Read

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

GET /api/installment-payment-slice/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the installment payment slice which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.5.3Installment Plan Calculation Service

3.5.3.1Calculate Plans

This operation allows to calculate all plans for the given transaction. The transaction will not be changed in any way.

POST /api/installment-plan-calculation/calculatePlans View in Client
Query Parameters
  • spaceId
    *
    Long
  • transactionId
    *
    The transaction for which the plans should be calculated for.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.5.4Installment Plan Configuration Service

3.5.4.1Read

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

GET /api/installment-plan-configuration/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the installment plan configuration which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.5.4.2Search

Searches for the entities as specified by the given query.

POST /api/installment-plan-configuration/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the installment plan configurations which are returned by the search.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Installment Plan
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.5.4.3Count

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

POST /api/installment-plan-configuration/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The filter which restricts the installment plan configurations which are used to calculate the count.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Long
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.5.5Installment Plan Slice Configuration

3.5.5.1Count

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

POST /api/installment-plan-slice-configuration/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The filter which restricts the installment plan slice configurations which are used to calculate the count.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Long
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.5.5.2Search

Searches for the entities as specified by the given query.

POST /api/installment-plan-slice-configuration/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the installment plan slice configurations which are returned by the search.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.5.5.3Read

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

GET /api/installment-plan-slice-configuration/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the installment plan slice configuration which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.6Internationalization

3.6.1Country Service

3.6.1.1All

This operation returns all countries.

GET /api/country/all View in Client
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Country
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.6.2Country State Service

3.6.2.1All

This operation returns all states of all countries.

GET /api/country-state/all View in Client
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of State
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.6.2.2Find by Country

This operation returns all states for a given country.

GET /api/country-state/country View in Client
Query Parameters
  • code
    *
    The country code in ISO code two letter format for which all states should be returned.
    String
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of State
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.6.3Currency Service

3.6.3.1All

This operation returns all currencies.

GET /api/currency/all View in Client
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Currency
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.6.4Language Service

3.6.4.1All

This operation returns all languages.

GET /api/language/all View in Client
Examples
GET /api/language/all HTTP/1.1
Host: app-wallee.com 
Content-Type: application/json;charset=utf-8
X-Mac-Version: 1
X-Mac-Userid: <:YOUR_USER_ID>
X-Mac-Timestamp: <:UNIX_TIMESTAMP>
X-Mac-Value: <:CALCULATED_MAC_VALUE>
$client = new \Wallee\Sdk\ApiClient(<:YOUR_USER_ID>, <:YOUR_API_KEY>);

$service = new \Wallee\Sdk\Service\LanguageService($client);
$result = $service->languageAllGet();
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Language
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.6.5Legal Organization Form Service

3.6.5.1Read

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

GET /api/legal-organization-form/read View in Client
Query Parameters
  • id
    *
    The id of the legal organization form which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.6.5.2All

This operation returns all entities which are available.

GET /api/legal-organization-form/all View in Client
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.6.5.3Find by Country

This operation returns all legal organization forms for a given country.

GET /api/legal-organization-form/country View in Client
Query Parameters
  • code
    *
    The country in ISO 3166-1 alpha-2 format, for which all legal organization forms should be returned.
    String
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.7Label

3.7.1Label Descriptor Group Service

3.7.1.1All

This operation returns all entities which are available.

GET /api/label-description-group-service/all View in Client
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.7.1.2Read

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

GET /api/label-description-group-service/read View in Client
Query Parameters
  • id
    *
    The id of the label descriptor group which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.7.2Label Descriptor Service

3.7.2.1All

This operation returns all entities which are available.

GET /api/label-description-service/all View in Client
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Label Descriptor
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.7.2.2Read

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

GET /api/label-description-service/read View in Client
Query Parameters
  • id
    *
    The id of the label descriptor which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.7.3Static Value Service

3.7.3.1All

This operation returns all entities which are available.

GET /api/static-value-service/all View in Client
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Static Value
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.7.3.2Read

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

GET /api/static-value-service/read View in Client
Query Parameters
  • id
    *
    The id of the static value which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.8Manual Task

3.8.1Manual Task Service

3.8.1.1Count

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

POST /api/manual-task/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Long
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.8.1.2Read

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

GET /api/manual-task/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the manual task which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.8.1.3Search

Searches for the entities as specified by the given query.

POST /api/manual-task/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the manual tasks which are returned by the search.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Manual Task
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9Payment

3.9.1Bank Account Service

3.9.1.1Count

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

POST /api/bank-account/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Long
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.1.2Read

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

GET /api/bank-account/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The ID of the bank account which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.1.3Search

Searches for the entities as specified by the given query.

POST /api/bank-account/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the bank accounts which are returned by the search.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Bank Account
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.2Bank Transaction Service

3.9.2.1Read

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

GET /api/bank-transaction/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The ID of the bank transaction which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.2.2Count

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

POST /api/bank-transaction/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Long
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.2.3Search

Searches for the entities as specified by the given query.

POST /api/bank-transaction/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the bank transactions which are returned by the search.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Bank Transaction
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.3Card Processing Service

The card processing service allows to process card data directly without using our forms. This service is only allowed to be used in a PCI DSS Level 1 compliant application.

3.9.3.1Process

The process method will process the transaction with the given card details without using 3-D secure.

POST /api/card-processing/process View in Client
Query Parameters
  • spaceId
    *
    Long
  • transactionId
    *
    The ID of the transaction which should be processed.
    Long
  • paymentMethodConfigurationId
    *
    The payment method configuration ID which is applied to the transaction.
    Long
Message Body *
The card details as JSON in plain which should be used to authorize the payment.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.3.2Process With 3-D Secure

The process method will process the transaction with the given card details by eventually using 3-D secure. The buyer has to be redirect to the URL returned by this method.

POST /api/card-processing/processWith3DSecure View in Client
Query Parameters
  • spaceId
    *
    Long
  • transactionId
    *
    The ID of the transaction which should be processed.
    Long
  • paymentMethodConfigurationId
    *
    The payment method configuration ID which is applied to the transaction.
    Long
Message Body *
The card details as JSON in plain which should be used to authorize the payment.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    String
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.4Charge Attempt Service

3.9.4.1Search

Searches for the entities as specified by the given query.

POST /api/charge-attempt/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the charge attempts which are returned by the search.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Charge Attempt
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.4.2Read

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

GET /api/charge-attempt/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the charge attempt which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.4.3Count

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

POST /api/charge-attempt/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Long
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.5Charge Bank Transaction Service

3.9.5.1Read

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

GET /api/charge-bank-transaction/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The ID of the charge bank transaction which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.5.2Count

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

POST /api/charge-bank-transaction/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Long
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.5.3Search

Searches for the entities as specified by the given query.

POST /api/charge-bank-transaction/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the charge bank transactions which are returned by the search.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.6Charge Flow Level Payment Link Service

3.9.6.1Search

Searches for the entities as specified by the given query.

POST /api/charge-flow-level-payment-link/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the charge flow level payment links which are returned by the search.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.6.2Count

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

POST /api/charge-flow-level-payment-link/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Long
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.6.3Read

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

GET /api/charge-flow-level-payment-link/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The ID of the charge flow level payment link which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.7Charge Flow Level Service

3.9.7.1Send Payment Link

Sends the payment link of the charge flow level with the given 'id'.

POST /api/charge-flow-level/sendMessage View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the charge flow level whose payment link should be sent.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.7.2Read

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

GET /api/charge-flow-level/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the payment flow level which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.7.3Count

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

POST /api/charge-flow-level/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Long
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.7.4Search

Searches for the entities as specified by the given query.

POST /api/charge-flow-level/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the payment flow levels which are returned by the search.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Charge Flow Level
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.8Charge Flow Service

3.9.8.1updateRecipient

POST /api/charge-flow/updateRecipient View in Client
Query Parameters
  • spaceId
    *
    Long
  • transactionId
    *
    The transaction id of the transaction whose recipient should be updated.
    Long
  • type
    *
    The id of the charge flow configuration type to recipient should be updated for.
    Long
  • recipient
    *
    The recipient address that should be used to send the payment URL.
    String
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    No Response Body
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.8.2applyFlow

POST /api/charge-flow/applyFlow View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The transaction id of the transaction which should be process asynchronously.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.8.3Read

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

GET /api/charge-flow/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the charge flow which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.8.4Fetch 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.

GET /api/charge-flow/fetch-charge-flow-payment-page-url View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The transaction id of the transaction for which the URL of the charge flow should be fetched.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    String
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.8.5Count

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

POST /api/charge-flow/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Long
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.8.6Search

Searches for the entities as specified by the given query.

POST /api/charge-flow/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the charge flows which are returned by the search.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Charge Flow
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.8.7Cancel Charge Flow

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

POST /api/charge-flow/cancel-charge-flow View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The ID of the transaction for which the charge flow should be canceled.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.9Condition Type Service

3.9.9.1Read

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

GET /api/condition-type/read View in Client
Query Parameters
  • id
    *
    The id of the condition type which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.9.2All

This operation returns all entities which are available.

GET /api/condition-type/all View in Client
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.10Currency Bank Account Service

3.9.10.1Search

Searches for the entities as specified by the given query.

POST /api/currency-bank-account/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the currency bank accounts which are returned by the search.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.10.2Read

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

GET /api/currency-bank-account/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The ID of the currency bank account which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.10.3Count

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

POST /api/currency-bank-account/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Long
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.11Delivery Indication Service

3.9.11.1Search

Searches for the entities as specified by the given query.

POST /api/delivery-indication/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the delivery indications which are returned by the search.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Delivery Indication
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.11.2Count

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

POST /api/delivery-indication/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Long
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.11.3markAsNotSuitable

This operation marks the delivery indication as not suitable.

POST /api/delivery-indication/markAsNotSuitable View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The delivery indication id which should be marked as not suitable.
Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.11.4markAsSuitable

This operation marks the delivery indication as suitable.

POST /api/delivery-indication/markAsSuitable View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The delivery indication id which should be marked as suitable.
Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.11.5Read

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

GET /api/delivery-indication/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the delivery indication which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.12External Transfer Bank Transaction Service

3.9.12.1Read

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

GET /api/external-transfer-bank-transaction/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The ID of the external transfer bank transaction which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.12.2Count

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

POST /api/external-transfer-bank-transaction/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Long
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.12.3Search

Searches for the entities as specified by the given query.

POST /api/external-transfer-bank-transaction/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the external transfer bank transactions which are returned by the search.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.13Internal Transfer Bank Transaction Service

3.9.13.1Search

Searches for the entities as specified by the given query.

POST /api/internal-transfer-bank-transaction/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the internal transfer bank transactions which are returned by the search.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.13.2Read

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

GET /api/internal-transfer-bank-transaction/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The ID of the internal transfer bank transaction which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.13.3Count

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

POST /api/internal-transfer-bank-transaction/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Long
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.14Invoice Reconciliation Record Invoice Link Service

This service allows to link Invoice Reconciliation Records with invoices.

3.9.14.1Read

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

GET /api/invoice-reconciliation-record-invoice-link-service/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The ID of the invoice reconciliation record invoice link which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.14.2Link Invoice

Links the invoice reconciliation record with the provided invoice.

POST /api/invoice-reconciliation-record-invoice-link-service/link View in Client
Query Parameters
  • spaceId
    *
    Long
  • recordId
    *
    The ID of the invoice reconciliation record which should be linked.
    Long
  • completionId
    *
    The ID of the completion which should be linked.
    Long
  • amount
    The amount of the invoice reconciliation record linked completion which should be changed.
    Decimal
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.14.3Search

Searches for the entities as specified by the given query.

POST /api/invoice-reconciliation-record-invoice-link-service/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the invoice reconciliation record invoice link which are returned by the search.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.14.4Count

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

POST /api/invoice-reconciliation-record-invoice-link-service/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Long
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.14.5Unlink Invoice

Unlinks the invoice reconciliation record from the provided invoice.

POST /api/invoice-reconciliation-record-invoice-link-service/unlink-transaction View in Client
Query Parameters
  • spaceId
    *
    Long
  • recordId
    *
    The ID of the invoice reconciliation record which should be unlinked.
    Long
  • completionId
    *
    The ID of the completion which should be unlinked.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    No Response Body
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.15Invoice Reconciliation Record Service

3.9.15.1Search for matchable invoices by query

Searches for transaction invoices by given query.

POST /api/invoice-reconciliation-record-service/search-for-invoices-by-query View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the invoices which are returned by the search.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Transaction Invoice
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.15.2Search

Searches for the entities as specified by the given query.

POST /api/invoice-reconciliation-record-service/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the invoice reconciliation records which are returned by the search.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.15.3Resolve

Resolves the invoice reconciliation record.

POST /api/invoice-reconciliation-record-service/resolve View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The ID of the invoice reconciliation record which should be resolved.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    No Response Body
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.15.4Read

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

GET /api/invoice-reconciliation-record-service/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The ID of the invoice reconciliation record which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.15.5Count

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

POST /api/invoice-reconciliation-record-service/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Long
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.15.6Discard

Discards the invoice reconciliation record.

POST /api/invoice-reconciliation-record-service/discard View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The ID of the invoice reconciliation record which should be discarded.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    No Response Body
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.16Invoice Reimbursement Service

3.9.16.1Update IBAN

Updates recipient and/or sender IBAN for reimbursement which is in manual review.

POST /api/invoice-reimbursement-service/update-iban View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The ID of the invoice reimbursement of which IBANs should be updated.
    Long
  • recipientIban
    String
  • senderIban
    String
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    No Response Body
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.16.2Count

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

POST /api/invoice-reimbursement-service/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Long
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.16.3Update payment connector configuration

Updates payment connector configuration for reimbursement which is in manual review.

POST /api/invoice-reimbursement-service/update-connector View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The ID of the invoice reimbursement of which connector should be updated.
    Long
  • paymentConnectorConfigurationId
    *
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    No Response Body
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.16.4Read

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

GET /api/invoice-reimbursement-service/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The ID of the invoice reimbursement which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.16.5Search

Searches for the entities as specified by the given query.

POST /api/invoice-reimbursement-service/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the invoice reimbursements which are returned by the search.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.17Payment Connector Configuration Service

3.9.17.1Count

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

POST /api/payment-connector-configuration/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Long
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.17.2Search

Searches for the entities as specified by the given query.

POST /api/payment-connector-configuration/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the payment connector configuration which are returned by the search.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.17.3Read

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

GET /api/payment-connector-configuration/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the payment connector configuration which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.18Payment Connector Service

3.9.18.1Read

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

GET /api/payment-connector/read View in Client
Query Parameters
  • id
    *
    The id of the connector which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.18.2All

This operation returns all entities which are available.

GET /api/payment-connector/all View in Client
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Payment Connector
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.19Payment Link Service

The payment link service allows to manage payment links via the web service API.

3.9.19.1Update

This updates the entity with the given properties. Only those properties which should be updated can be provided. The 'id' and 'version' are required to identify the entity.

POST /api/payment-link/update View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The object with all the properties which should be updated. The id and the version are required properties.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.19.2Search

Searches for the entities as specified by the given query.

POST /api/payment-link/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the payment links which are returned by the search.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Payment Link
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.19.3Read

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

GET /api/payment-link/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the payment links which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.19.4Count

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

POST /api/payment-link/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Long
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.19.5Create

Creates the entity with the given properties.

POST /api/payment-link/create View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The payment link object with the properties which should be created.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.19.6Delete

Deletes the entity with the given id.

POST /api/payment-link/delete View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    No Response Body
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.20Payment Method Brand Service

3.9.20.1Read

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

GET /api/payment-method-brand/read View in Client
Query Parameters
  • id
    *
    The id of the payment method brand which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.20.2All

This operation returns all entities which are available.

GET /api/payment-method-brand/all View in Client
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.21Payment Method Configuration Service

3.9.21.1Count

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

POST /api/payment-method-configuration/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Long
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.21.2Read

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

GET /api/payment-method-configuration/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the payment method configuration which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.21.3Search

Searches for the entities as specified by the given query.

POST /api/payment-method-configuration/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the payment method configuration which are returned by the search.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.22Payment Method Service

3.9.22.1All

This operation returns all entities which are available.

GET /api/payment-method/all View in Client
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Payment Method
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.22.2Read

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

GET /api/payment-method/read View in Client
Query Parameters
  • id
    *
    The id of the payment method which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.23Payment Processor Configuration Service

3.9.23.1Read

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

GET /api/payment-processor-configuration/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the payment processor configuration which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.23.2Count

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

POST /api/payment-processor-configuration/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Long
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.23.3Search

Searches for the entities as specified by the given query.

POST /api/payment-processor-configuration/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the payment processor configuration which are returned by the search.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.24Payment Processor Service

3.9.24.1Read

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

GET /api/payment-processor/read View in Client
Query Parameters
  • id
    *
    The id of the processor which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.24.2All

This operation returns all entities which are available.

GET /api/payment-processor/all View in Client
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Payment Processor
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.25Payment Terminal Service

The payment terminal service allows to fetch the configured terminals.

3.9.25.1Remotely Trigger Final Balance By Identifier

Remotely triggers the final balance receipt on the terminal by terminal identifier.

POST /api/payment-terminal/trigger-final-balance-by-identifier View in Client
Query Parameters
  • spaceId
    *
    Long
  • terminalIdentifier
    *
    String
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.25.2Remotely Trigger Final Balance

Remotely triggers the final balance receipt on the terminal.

POST /api/payment-terminal/trigger-final-balance View in Client
Query Parameters
  • spaceId
    *
    Long
  • terminalId
    *
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.25.3Read

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

GET /api/payment-terminal/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the payment terminal which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.25.4Unlink Device With Terminal

Unlinks the device from terminal.

POST /api/payment-terminal/unlink View in Client
Query Parameters
  • spaceId
    *
    Long
  • terminalId
    *
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    No Response Body
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.25.5Search

Searches for the entities as specified by the given query.

POST /api/payment-terminal/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the payment terminals which are returned by the search.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Payment Terminal
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.25.6Count

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

POST /api/payment-terminal/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Long
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.25.7Link Device With Terminal

Links the device with given serial number with terminal.

POST /api/payment-terminal/link View in Client
Query Parameters
  • spaceId
    *
    Long
  • terminalId
    *
    Long
  • serialNumber
    *
    String
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    No Response Body
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.26Payment Terminal Till Service

The payment terminal till service allows the till to communicate with the terminal.

3.9.26.1Perform Payment Terminal Transaction

Starts a payment terminal transaction and waits for its completion. If the call returns with a long polling timeout status, you may try again. The processing of the transaction will be picked up where it was left off.

GET /api/payment-terminal-till/perform-transaction View in Client
Query Parameters
  • spaceId
    *
    Long
  • transactionId
    *
    The ID of the transaction which is used to process with the terminal.
    Long
  • terminalId
    *
    The ID of the terminal which should be used to process the transaction.
    Long
  • language
    The language in which the messages should be rendered in.
    String
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
  • 543
    Error
    This status code indicates that the long polling request timed out.

3.9.26.2Perform Payment Terminal Transaction (using TID)

Starts a payment terminal transaction and waits for its completion. If the call returns with a long polling timeout status, you may try again. The processing of the transaction will be picked up where it was left off.

GET /api/payment-terminal-till/perform-transaction-by-identifier View in Client
Query Parameters
  • spaceId
    *
    Long
  • transactionId
    *
    The ID of the transaction which is used to process with the terminal.
    Long
  • terminalIdentifier
    *
    The identifier (aka TID) of the terminal which should be used to process the transaction.
    String
  • language
    The language in which the messages should be rendered in.
    String
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
  • 543
    Error
    This status code indicates that the long polling request timed out.

3.9.27Payment Terminal Transaction Summary Service

The payment terminal transaction summary service allows to fetch the detailed transaction summaries, such as final balance reports.

3.9.27.1Fetch Receipt

Returns the terminal receipt corresponding to the specified transaction summary id.

POST /api/payment-terminal-transaction-summary/fetch-receipt View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.27.2Count

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

POST /api/payment-terminal-transaction-summary/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Long
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.27.3Read

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

GET /api/payment-terminal-transaction-summary/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the transaction summary report which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.27.4Search

Searches for the entities as specified by the given query.

POST /api/payment-terminal-transaction-summary/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the transaction summary reports which are returned by the search.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Transaction summary
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.28Payment Web App Service

The payment web app service allows to insert payment processors through a web app.

3.9.28.1Update Refund

This operation updates the state of the refund. This method can be invoked for transactions originally created with a processor associated with the web app that invokes this operation. The returned refund corresponds to the refund indicated in the request.

POST /api/payment-web-app/update-refund View in Client
Query Parameters
  • spaceId
    *
    This is the ID of the space in which the refund is located in.
    Long
Message Body *
The refund update request allows to update the state of a refund.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.28.2Delete Connector

This operation removes the web app payment connector from the given space.

POST /api/payment-web-app/delete-connector View in Client
Query Parameters
  • spaceId
    *
    The space ID identifies the space in which the connector is installed in.
    Long
  • externalId
    *
    The external ID identifies the connector. The external ID corresponds to the ID provided during inserting of the connector.
    String
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    No Response Body
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.28.3Insert or Update Processor

This operation inserts or updates a web app payment processor.

POST /api/payment-web-app/insert-or-update-processor View in Client
Query Parameters
  • spaceId
    *
    The space ID identifies the space into which the processor should be inserted into.
    Long
Message Body *
The processor object contains all the details required to create or update a web app processor.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.28.4Activate Processor for Production

This operation marks the processor to be usable within the production environment.

POST /api/payment-web-app/activate-processor-for-production View in Client
Query Parameters
  • spaceId
    *
    The space ID identifies the space in which the processor is installed in.
    Long
  • externalId
    *
    The external ID identifies the processor. The external ID corresponds to the ID provided during inserting of the processor.
    String
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.28.5Update Completion

This operation updates the state of the transaction completion. This method can be invoked for transactions originally created with a processor associated with the web app that invokes this operation. The returned completion corresponds to the completion indicated in the request.

POST /api/payment-web-app/update-completion View in Client
Query Parameters
  • spaceId
    *
    This is the ID of the space in which the completion is located in.
    Long
Message Body *
The completion update request allows to update the state of a completion.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.28.6Delete Processor

This operation removes the web app payment processor and its connectors from the given space.

POST /api/payment-web-app/delete-processor View in Client
Query Parameters
  • spaceId
    *
    The space ID identifies the space in which the processor is installed in.
    Long
  • externalId
    *
    The external ID identifies the processor. The external ID corresponds to the ID provided during inserting of the processor.
    String
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    No Response Body
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.28.7Update Void

This operation updates the state of the transaction void. This method can be invoked for transactions originally created with a processor associated with the web app that invokes this operation. The returned void corresponds to the void indicated in the request.

POST /api/payment-web-app/update-void View in Client
Query Parameters
  • spaceId
    *
    This is the ID of the space in which the void is located in.
    Long
Message Body *
The void update request allows to update the state of a void.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.28.8Update Charge Attempt

This operation updates the state of the charge attempt. This method can be invoked for transactions originally created with a processor associated with the web app that invokes this operation. The returned charge attempt corresponds to the charge attempt indicated in the request.

POST /api/payment-web-app/update-charge-attempt View in Client
Query Parameters
  • spaceId
    *
    This is the ID of the space in which the charge attempt is located in.
    Long
Message Body *
The charge attempt update request allows to update the state of a charge attempt.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.28.9Insert or Update Connector

This operation inserts or updates a web app payment connector.

POST /api/payment-web-app/insert-or-update-connector View in Client
Query Parameters
  • spaceId
    *
    The space ID identifies the space into which the connector should be inserted into.
    Long
Message Body *
The connector object contains all the details required to create or update a web app connector.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.29Refund Bank Transaction Service

3.9.29.1Count

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

POST /api/refund-bank-transaction/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Long
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.29.2Read

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

GET /api/refund-bank-transaction/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The ID of the refund bank transaction which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.29.3Search

Searches for the entities as specified by the given query.

POST /api/refund-bank-transaction/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the refund bank transactions which are returned by the search.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.30Refund Comment Service

3.9.30.1Find by refund

Returns all comments of the given refund.

POST /api/refund-comment/all View in Client
Query Parameters
  • spaceId
    *
    Long
  • refundId
    *
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Refund Comment
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.30.2Unpin

Unpins the comment from the top.

GET /api/refund-comment/unpin View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the comment to unpin.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    No Response Body
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.30.3Read

Reads the comment with the given 'id' and returns it.

GET /api/refund-comment/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the comment which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.30.4Pin

Pins the comment to the top.

GET /api/refund-comment/pin View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the comment to pin to the top.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    No Response Body
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.30.5Update

This updates the comment with the given properties. Only those properties which should be updated can be provided. The 'id' and 'version' are required to identify the comment.

POST /api/refund-comment/update View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The comment object with the properties which should be updated.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.30.6Delete

Deletes the comment with the given id.

POST /api/refund-comment/delete View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    No Response Body
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.30.7Create

Creates the comment with the given properties.

POST /api/refund-comment/create View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The comment object which should be created.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.31Refund Recovery Bank Transaction Service

3.9.31.1Read

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

GET /api/refund-recovery-bank-transaction/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The ID of the refund recovery bank transaction which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.31.2Search

Searches for the entities as specified by the given query.

POST /api/refund-recovery-bank-transaction/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the refund recovery bank transactions which are returned by the search.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.31.3Count

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

POST /api/refund-recovery-bank-transaction/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Long
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.32Refund Service

3.9.32.1getRefundDocument

Returns the PDF document for the refund with given id.

GET /api/refund/getRefundDocument View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the refund to get the document for.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.32.2getRefundDocumentWithTargetMediaType

Returns the PDF document for the refund with given id and the given target media type.

GET /api/refund/getRefundDocumentWithTargetMediaType View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the refund to get the document for.
    Long
  • targetMediaTypeId
    *
    The id of the target media type for which the refund should be generated for.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.32.3Read

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

GET /api/refund/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the refund which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.32.4Search

Searches for the entities as specified by the given query.

POST /api/refund/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the refunds which are returned by the search.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Refund
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.32.5succeed

This operation allows to mark a refund as successful which is in state MANUAL_CHECK.

POST /api/refund/succeed View in Client
Query Parameters
  • spaceId
    *
    Long
  • refundId
    *
    The id of the refund which should be marked as successful.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.32.6Count

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

POST /api/refund/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Long
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.32.7create

This operation creates and executes a refund of a particular transaction.

POST /api/refund/refund View in Client
Examples
use Wallee\Sdk\ApiClient;
use Wallee\Sdk\Model\AddressCreate;
use Wallee\Sdk\Model\LineItemCreate;
use Wallee\Sdk\Model\LineItemType;
use Wallee\Sdk\Model\RefundCreate;
use Wallee\Sdk\Model\RefundState;
use Wallee\Sdk\Model\RefundType;
use Wallee\Sdk\Model\TransactionCreate;
use Wallee\Sdk\Model\TransactionState;
use Wallee\Sdk\Service\RefundService;
use Wallee\Sdk\Service\TransactionService;

// credentials
$spaceId = <:YOUR_SPACE_ID>;
$userId = <:YOUR_USER_ID>;
$secret = <:YOUR_USER_SECRET>;

// Services
$apiClient = new ApiClient($userId, $secret);
$transactionService = new TransactionService($apiClient);
$refundService = new RefundService($apiClient);

// line item
$lineItem = new LineItemCreate();
$lineItem->setName('Red T-Shirt');
$lineItem->setUniqueId('5412');
$lineItem->setSku('red-t-shirt-123');
$lineItem->setQuantity(1);
$lineItem->setAmountIncludingTax(29.95);
$lineItem->setType(LineItemType::PRODUCT);

// Customer Billing Address
$billingAddress = new AddressCreate();
$billingAddress->setCity('Winterthur');
$billingAddress->setCountry('CH');
$billingAddress->setEmailAddress('test@example.com');
$billingAddress->setFamilyName('Customer');
$billingAddress->setGivenName('Good');
$billingAddress->setPostCode('8400');
$billingAddress->setPostalState('ZH');
$billingAddress->setOrganizationName('Test GmbH');
$billingAddress->setPhoneNumber('+41791234567');
$billingAddress->setSalutation('Ms');

// Transaction payload
$transactionPayload = new TransactionCreate();
$transactionPayload->setCurrency('CHF');
$transactionPayload->setLineItems([$lineItem]);
$transactionPayload->setAutoConfirmationEnabled(true);
$transactionPayload->setBillingAddress($billingAddress);
$transactionPayload->setShippingAddress($billingAddress);
$transactionPayload->setFailedUrl('https://YOUR.SITE/transaction?state=fail');
$transactionPayload->setSuccessUrl('https://YOUR.SITE/transaction?state=success');

// Create a transaction
$transaction = $transactionService->create($spaceId, $transactionPayload);
$transaction = $transactionService->processWithoutUserInteraction($spaceId, $transaction->getId());

// Fetch the transaction you would like to refund 
$transaction = $this->transactionService->read($this->spaceId, $transaction->getId());
if (in_array($transaction->getState(), [TransactionState::FULFILL])) {

    // Refund payload
    $refundPayload = new RefundCreate();
    $refundPayload->setAmount($transaction->getAuthorizationAmount());
    $refundPayload->setTransaction($transaction->getId());
    $refundPayload->setMerchantReference($transaction->getMerchantReference());
    $refundPayload->setExternalId($transaction->getId());
    $refundPayload->setType(RefundType::MERCHANT_INITIATED_ONLINE);

    $refund = $refundService->refund($this->spaceId, $refundPayload);
    if(in_array($refund->getState(), [RefundState::SUCCESSFUL])){
        // refund successful
    }
}
package com.wallee.sdk.test;

import com.wallee.sdk.ApiClient;
import com.wallee.sdk.model.*;
import com.wallee.sdk.service.*;

import java.math.BigDecimal;

/**
 * API tests for RefundService
 */
public class RefundServiceTest {

    // Credentials
    private Long spaceId = <:YOUR_SPACE_ID>;
    private Long applicationUserId = <:YOUR_USER_ID>;
    private String authenticationKey = <:YOUR_USER_SECRET>;

    // Services
    private ApiClient apiClient;
    private RefundService refundService;
    private TransactionCompletionService transactionCompletionService;
    private TransactionService transactionService;

    // Models
    private TransactionCreate transactionPayload;

    public RefundServiceTest() {
        this.apiClient = new ApiClient(applicationUserId, authenticationKey);
        this.refundService = new RefundService(this.apiClient);
        this.transactionCompletionService = new TransactionCompletionService(this.apiClient);
        this.transactionService = new TransactionService(this.apiClient);
    }

    /**
     * Get transaction payload
     *
     * @return TransactionCreate
     */
    private TransactionCreate getTransactionPayload() {
        if (this.transactionPayload == null) {
            // Line item
            LineItemCreate lineItem = new LineItemCreate();
            lineItem.name("Red T-Shirt")
                .uniqueId("5412")
                .type(LineItemType.PRODUCT)
                .quantity(BigDecimal.valueOf(1))
                .amountIncludingTax(BigDecimal.valueOf(29.95))
                .sku("red-t-shirt-123");

            // Customer Billind Address
            AddressCreate billingAddress = new AddressCreate();
            billingAddress.city("Winterthur")
                .country("CH")
                .emailAddress("test@example.com")
                .familyName("Customer")
                .givenName("Good")
                .postcode("8400")
                .postalState("ZH")
                .organizationName("Test GmbH")
                .mobilePhoneNumber("+41791234567")
                .salutation("Ms");

            this.transactionPayload = new TransactionCreate();
            this.transactionPayload.autoConfirmationEnabled(true).currency("CHF").language("en-US");
            this.transactionPayload.setBillingAddress(billingAddress);
            this.transactionPayload.setShippingAddress(billingAddress);
            this.transactionPayload.addLineItemsItem(lineItem);
        }
        return this.transactionPayload;
    }

    /**
     * Get refund payload
     *
     * @param transaction
     * @return
     */
    private RefundCreate getRefundPayload(Transaction transaction) {
        RefundCreate refundPayload = new RefundCreate();
        refundPayload.amount(transaction.getAuthorizationAmount())
            .transaction(transaction.getId())
            .merchantReference(transaction.getMerchantReference())
            .externalId(transaction.getId().toString())
            .type(RefundType.MERCHANT_INITIATED_ONLINE);
        return refundPayload;
    }

    /**
     * create
     *
     * This operation creates and executes a refund of a particular transaction.
     */
    public void refund() {
        try {
            Transaction transaction = this.transactionService.create(this.spaceId, this.getTransactionPayload());
            transaction = this.transactionService.processWithoutUserInteraction(this.spaceId, transaction.getId());
            for (int i = 1; i <= 5; i++) {
                if (
                    transaction.getState() == TransactionState.FULFILL ||
                    transaction.getState() == TransactionState.FAILED
                ) {
                    break;
                }

                try {
                    Thread.sleep(i * 30);
                } catch (InterruptedException e) {
                    System.err.println(e.getMessage());
                }
                transaction = this.transactionService.read(this.spaceId, transaction.getId());
            }

            if (transaction.getState() == TransactionState.FULFILL) {
                TransactionCompletion transactionCompletion = this.transactionCompletionService.completeOffline(this.spaceId, transaction.getId());
                transaction = this.transactionService.read(transaction.getLinkedSpaceId(), transactionCompletion.getLinkedTransaction());
                Refund refund = this.refundService.refund(this.spaceId, getRefundPayload(transaction));
                // expect refund.getState() to equal RefundState.SUCCESSFUL
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}
using System;
using System.IO;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Linq;
using System.Reflection;
using RestSharp;
using NUnit.Framework;

using Wallee.Model;
using Wallee.Service;
using Wallee.Client;

namespace Wallee.RefundServiceExample
{
    /// <summary>
    ///  Class for RefundServiceExample
    /// </summary>
    public class RefundServiceExample
    {
        private readonly long SpaceId = <:YOUR_SPACE_ID>;
        private readonly string ApplicationUserID = <:YOUR_USER_ID>;
        private readonly string AuthenticationKey = <:YOUR_USER_SECRET>;

        private Configuration Configuration;
        private RefundService RefundService;
        private Transaction Transaction;
        private TransactionCompletionService TransactionCompletionService;
        private TransactionCreate TransactionPayload;
        private TransactionService TransactionService;

        /// <summary>
        /// RefundServiceExample
        /// </summary>
        public RefundServiceExample()
        {
            this.Configuration = new Configuration(this.ApplicationUserID, this.AuthenticationKey);
            this.RefundService = new RefundService(this.Configuration);
            this.TransactionCompletionService = new TransactionCompletionService(this.Configuration);
            this.TransactionService = new TransactionService(this.Configuration);
        }

        // <summary>
        // Get transaction payload
        // <summary>
        private TransactionCreate GetTransactionPayload()
        {
            if (this.TransactionPayload == null)
            {
                // Line item
                LineItemCreate lineItem1 = new LineItemCreate(
                    name: "Red T-Shirt",
                    uniqueId: "5412",
                    type: LineItemType.PRODUCT,
                    quantity: 1,
                    amountIncludingTax: (decimal)29.95
                )
                {
                    Sku = "red-t-shirt-123"
                };

                // Customer Billind Address
                AddressCreate billingAddress = new AddressCreate
                {
                    City = "Winterthur",
                    Country = "CH",
                    EmailAddress = "test@example.com",
                    FamilyName = "Customer",
                    GivenName = "Good",
                    Postcode = "8400",
                    PostalState = "ZH",
                    OrganizationName = "Test GmbH",
                    MobilePhoneNumber = "+41791234567",
                    Salutation = "Ms"
                };

                this.TransactionPayload = new TransactionCreate(new List<LineItemCreate>() { lineItem1 })
                {
                    Currency = "CHF",
                    AutoConfirmationEnabled = true,
                    BillingAddress = billingAddress,
                    ShippingAddress = billingAddress,
                    Language = "en-US"
                };
            }
            return this.TransactionPayload;
        }

        /// <summary>
        /// Create Transaction
        /// </summary>
        private Transaction GetTransaction()
        {
            return this.TransactionService.Create(this.SpaceId, this.GetTransactionPayload());
        }


        // <summary>
        // Get refund payload
        // <summary>
        private RefundCreate GetRefundPayload(Transaction transaction)
        {
            RefundCreate refundPayload = new RefundCreate(transaction.Id.ToString(), RefundType.MERCHANT_INITIATED_ONLINE)
            {
                Amount = transaction.AuthorizationAmount,
                Transaction = transaction.Id,
                MerchantReference = transaction.MerchantReference
            };
            return refundPayload;
        }

        /// <summary>
        /// Refund
        /// </summary>
        public void Refund()
        {
            this.Transaction = this.GetTransaction();
            Transaction transaction = this.TransactionService.ProcessWithoutUserInteraction(this.SpaceId, this.Transaction.Id);
            TransactionState[] TransactionStates = {
                TransactionState.FAILED,
                TransactionState.FULFILL
            };
            for (var i = 1; i <= 5; i++) {
                if (Array.Exists(TransactionStates, element => element == transaction.State)){
                    break;
                }
                System.Threading.Thread.Sleep(i * 30); // keep waiting for the transaction to transition to FULFILL or FAIL
                transaction = this.TransactionService.Read(this.SpaceId, transaction.Id);
            }

            if (transaction.State == TransactionState.FULFILL){
                TransactionCompletion transactionCompletion = this.TransactionCompletionService.CompleteOffline(this.SpaceId, transaction.Id);
                transaction = this.TransactionService.Read(this.SpaceId, transactionCompletion.LinkedTransaction);  // fetch the latest transaction data
                RefundCreate refundPayload = this.GetRefundPayload(transaction);
                Refund refund = this.RefundService.Refund(this.SpaceId, refundPayload);
            }
        }
    }
}
'use strict';
import { Wallee } from 'wallee';
import http = require("http");

// config
let config: { space_id: number, user_id: number, api_secret: string } = {
    space_id: <:YOUR_SPACE_ID>,
    user_id: <:YOUR_USER_ID>,
    api_secret: <:YOUR_USER_SECRET>
};

// Services
let refundService: Wallee.api.RefundService = new Wallee.api.RefundService(config);
let transactionCompletionService: Wallee.api.TransactionCompletionService = new Wallee.api.TransactionCompletionService(config);
let transactionService: Wallee.api.TransactionService = new Wallee.api.TransactionService(config);

// Models
let transactionPayload: Wallee.model.TransactionCreate;

/**
 * Get transaction payload
 */
function getTransactionPayload(): Wallee.model.TransactionCreate {
    if (!transactionPayload) {
        // Line item
        let lineItem: Wallee.model.LineItemCreate = new Wallee.model.LineItemCreate();
        lineItem.name = 'Red T-Shirt';
        lineItem.uniqueId = '5412';
        lineItem.type = Wallee.model.LineItemType.PRODUCT;
        lineItem.quantity = 1;
        lineItem.amountIncludingTax = 29.95;
        lineItem.sku = 'red-t-shirt-123';

        // Customer Billing Address
        let billingAddress: Wallee.model.AddressCreate = new Wallee.model.AddressCreate();
        billingAddress.city = "Winterthur";
        billingAddress.country = "CH";
        billingAddress.emailAddress = "test@example.com";
        billingAddress.familyName = "Customer";
        billingAddress.givenName = "Good";
        billingAddress.postcode = "8400";
        billingAddress.postalState = "ZH";
        billingAddress.organizationName = "Test GmbH";
        billingAddress.mobilePhoneNumber = "+41791234567";
        billingAddress.salutation = "Ms";

        // Payload
        transactionPayload = new Wallee.model.TransactionCreate();
        transactionPayload.lineItems = [lineItem];
        transactionPayload.autoConfirmationEnabled = true;
        transactionPayload.currency = 'CHF';
        transactionPayload.billingAddress = billingAddress;
        transactionPayload.shippingAddress = billingAddress;
    }

    return transactionPayload;
}

/**
 * Get refund payload
 */
function getRefundPayload(transaction: Wallee.model.Transaction): Wallee.model.RefundCreate {
    let refundPayload: Wallee.model.RefundCreate = new Wallee.model.RefundCreate();
    refundPayload.externalId = <string><any>transaction.id;
    refundPayload.type = Wallee.model.RefundType.MERCHANT_INITIATED_ONLINE;
    refundPayload.amount = transaction.authorizationAmount;
    refundPayload.transaction = transaction.id;
    refundPayload.merchantReference = transaction.merchantReference;
    return refundPayload;
}

// Refund a transaction
let transaction: Wallee.model.Transaction;
let refund: Wallee.model.Refund;
transactionService.create(config.space_id, getTransactionPayload())
    .then((response: { response: http.IncomingMessage, body: Wallee.model.Transaction }) => {
        transaction = response.body;
        return transactionService.processWithoutUserInteraction(config.space_id, <number>transaction.id);
    })
    .delay(15000)
    .then((response: { response: http.IncomingMessage, body: Wallee.model.Transaction }) => {
        transaction = response.body;
        return transactionCompletionService.completeOffline(config.space_id, <number>transaction.id)
            .then((response1: { response: http.IncomingMessage, body: Wallee.model.TransactionCompletion }) => {
                return transactionService.read(config.space_id, <number>transaction.id);
            });
    }).then((response: { response: http.IncomingMessage, body: Wallee.model.Transaction }) => {
        transaction = response.body;
        return refundService.refund(config.space_id, getRefundPayload(transaction));
    }).done((response: { response: http.IncomingMessage, body: Wallee.model.Refund }) => {
        refund = response.body;
        // expect refund.state to equal Wallee.model.RefundState.SUCCESSFUL
    });
Query Parameters
  • spaceId
    *
    Long
Message Body *
The refund object which should be created.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.32.8fail

This operation allows to mark a refund as failed which is in state MANUAL_CHECK.

POST /api/refund/fail View in Client
Query Parameters
  • spaceId
    *
    Long
  • refundId
    *
    The id of the refund which should be marked as failed.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.33Token Service

3.9.33.1Create

Creates the entity with the given properties.

POST /api/token/create View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The token object with the properties which should be created.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.33.2Create Transaction for Token Update

This operation creates a transaction which allows the updating of the provided token.

POST /api/token/createTransactionForTokenUpdate View in Client
Query Parameters
  • spaceId
    *
    Long
  • tokenId
    *
    The id of the token which should be updated.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.33.3Delete

Deletes the entity with the given id.

POST /api/token/delete View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    No Response Body
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.33.4Create Token Based On Transaction And Fill It With Stored Payment Information

This operation creates a token for the given transaction and fills it with the stored payment information of the transaction. The payment information for the transaction will be filled in immediately, if payment information is missing, an exception will be thrown.

POST /api/token/create-token-based-on-transaction View in Client
Query Parameters
  • spaceId
    *
    Long
  • transactionId
    *
    The id of the transaction for which we want to create the token.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.33.5Create Token

This operation creates a token for the given transaction. The transaction payment information will be populated asynchronously as soon as all data becomes available.

POST /api/token/create-token View in Client
Query Parameters
  • spaceId
    *
    Long
  • transactionId
    *
    The id of the transaction for which we want to create the token.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.33.6Check If Token Creation Is Possible

This operation checks if the given transaction can be used to create a token out of it.

POST /api/token/check-token-creation-possible View in Client
Query Parameters
  • spaceId
    *
    Long
  • transactionId
    *
    The id of the transaction for which we want to check if the token can be created or not.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Boolean
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.33.7Count

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

POST /api/token/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Long
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.33.8Read

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

GET /api/token/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the token which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.33.9Process Transaction

This operation processes the given transaction by using the token associated with the transaction.

POST /api/token/process-transaction View in Client
Query Parameters
  • spaceId
    *
    Long
  • transactionId
    *
    The id of the transaction for which we want to check if the token can be created or not.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.33.10Update

This updates the entity with the given properties. Only those properties which should be updated can be provided. The 'id' and 'version' are required to identify the entity.

POST /api/token/update View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The object with all the properties which should be updated. The id and the version are required properties.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.33.11Search

Searches for the entities as specified by the given query.

POST /api/token/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the tokens which are returned by the search.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Payment Token
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.34Token Version Service

3.9.34.1Search

Searches for the entities as specified by the given query.

POST /api/token-version/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the token versions which are returned by the search.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Token Version
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.34.2Active Version

Returns the token version which is currently active given by the token id. In case no token version is active the method will return null.

GET /api/token-version/active-version View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of a token for which you want to look up the current active token version.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.34.3Count

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

POST /api/token-version/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Long
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.34.4Read

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

GET /api/token-version/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the token version which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.35Transaction Comment Service

3.9.35.1Create

Creates the comment with the given properties.

POST /api/transaction-comment/create View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The comment object which should be created.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.35.2Delete

Deletes the comment with the given id.

POST /api/transaction-comment/delete View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    No Response Body
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.35.3Unpin

Unpins the comment from the top.

GET /api/transaction-comment/unpin View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the comment to unpin.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    No Response Body
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.35.4Find by transaction

Returns all comments of the transaction.

POST /api/transaction-comment/all View in Client
Query Parameters
  • spaceId
    *
    Long
  • transactionId
    *
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Transaction Comment
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.35.5Read

Reads the comment with the given 'id' and returns it.

GET /api/transaction-comment/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the comment which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.35.6Update

This updates the comment with the given properties. Only those properties which should be updated can be provided. The 'id' and 'version' are required to identify the comment.

POST /api/transaction-comment/update View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The comment object with the properties which should be updated.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.35.7Pin

Pins the comment to the top.

GET /api/transaction-comment/pin View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the comment to pin to the top.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    No Response Body
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.36Transaction Completion Service

3.9.36.1Count

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

POST /api/transaction-completion/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Long
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.36.2completePartiallyOnline

This operation can be used to partially complete the transaction online. The completion is forwarded to the processor. This implies that the processor may take some actions based on the completion.

POST /api/transaction-completion/completePartiallyOnline View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.36.3completeOffline

This operation completes the transaction offline. The completion is not forwarded to the processor. This implies the processor does not do anything. This method is only here to fix manually the transaction state.

POST /api/transaction-completion/completeOffline View in Client
Examples
use Wallee\Sdk\ApiClient;
use Wallee\Sdk\Model\AddressCreate;
use Wallee\Sdk\Model\LineItemCreate;
use Wallee\Sdk\Model\LineItemType;
use Wallee\Sdk\Model\TransactionCompletionState;
use Wallee\Sdk\Model\TransactionCreate;
use Wallee\Sdk\Model\TransactionState;
use Wallee\Sdk\Service\TransactionCompletionService;
use Wallee\Sdk\Service\TransactionService;

// credentials
$spaceId = <:YOUR_SPACE_ID>;
$userId = <:YOUR_USER_ID>;
$secret = <:YOUR_USER_SECRET>;

// Services
$apiClient = new ApiClient($userId, $secret);
$transactionCompletionService = new TransactionCompletionService($apiClient);
$transactionService = new TransactionService($apiClient);

// line item
$lineItem = new LineItemCreate();
$lineItem->setName('Red T-Shirt');
$lineItem->setUniqueId('5412');
$lineItem->setSku('red-t-shirt-123');
$lineItem->setQuantity(1);
$lineItem->setAmountIncludingTax(29.95);
$lineItem->setType(LineItemType::PRODUCT);

// Customer Billing Address
$billingAddress = new AddressCreate();
$billingAddress->setCity('Winterthur');
$billingAddress->setCountry('CH');
$billingAddress->setEmailAddress('test@example.com');
$billingAddress->setFamilyName('Customer');
$billingAddress->setGivenName('Good');
$billingAddress->setPostCode('8400');
$billingAddress->setPostalState('ZH');
$billingAddress->setOrganizationName('Test GmbH');
$billingAddress->setPhoneNumber('+41791234567');
$billingAddress->setSalutation('Ms');

// Transaction payload
$transactionPayload = new TransactionCreate();
$transactionPayload->setCurrency('CHF');
$transactionPayload->setLineItems([$lineItem]);
$transactionPayload->setAutoConfirmationEnabled(true);
$transactionPayload->setBillingAddress($billingAddress);
$transactionPayload->setShippingAddress($billingAddress);
$transactionPayload->setFailedUrl('https://YOUR.SITE/transaction?state=fail');
$transactionPayload->setSuccessUrl('https://YOUR.SITE/transaction?state=success');

// Create a transaction
$transaction = $transactionService->create($spaceId, $transactionPayload);
$transaction = $transactionService->processWithoutUserInteraction($spaceId, $transaction->getId());

// Complete a transaction offline
$transactionCompletion = $this->transactionCompletionService->completeOffline($this->spaceId, $transaction->getId());
if(in_array($transactionCompletion->getState(), [TransactionCompletionState::SUCCESSFUL])){
    // completion successful
}
package com.wallee.sdk.test;

import com.wallee.sdk.ApiClient;
import com.wallee.sdk.model.*;
import com.wallee.sdk.service.*;

import java.math.BigDecimal;

/**
 * API tests for TransactionCompletionService
 */
public class TransactionCompletionServiceTest {

    // Credentials
    private Long spaceId = <:YOUR_SPACE_ID>;
    private Long applicationUserId = <:YOUR_USER_ID>;
    private String authenticationKey = <:YOUR_USER_SECRET>;

    // Services
    private ApiClient apiClient;
    private TransactionCompletionService transactionCompletionService;
    private TransactionService transactionService;

    // Models
    private TransactionCreate transactionPayload;

    public TransactionCompletionServiceTest() {
        this.apiClient = new ApiClient(applicationUserId, authenticationKey);
        this.transactionCompletionService = new TransactionCompletionService(this.apiClient);
        this.transactionService = new TransactionService(this.apiClient);
    }

    /**
     * Get transaction payload
     *
     * @return TransactionCreate
     */
    private TransactionCreate getTransactionPayload() {
        if (this.transactionPayload == null) {
            // Line item
            LineItemCreate lineItem = new LineItemCreate();
            lineItem.name("Red T-Shirt")
                .uniqueId("5412")
                .type(LineItemType.PRODUCT)
                .quantity(BigDecimal.valueOf(1))
                .amountIncludingTax(BigDecimal.valueOf(29.95))
                .sku("red-t-shirt-123");

            // Customer Billind Address
            AddressCreate billingAddress = new AddressCreate();
            billingAddress.city("Winterthur")
                .country("CH")
                .emailAddress("test@example.com")
                .familyName("Customer")
                .givenName("Good")
                .postcode("8400")
                .postalState("ZH")
                .organizationName("Test GmbH")
                .mobilePhoneNumber("+41791234567")
                .salutation("Ms");

            this.transactionPayload = new TransactionCreate();
            this.transactionPayload.autoConfirmationEnabled(true).currency("CHF").language("en-US");
            this.transactionPayload.setBillingAddress(billingAddress);
            this.transactionPayload.setShippingAddress(billingAddress);
            this.transactionPayload.addLineItemsItem(lineItem);
        }
        return this.transactionPayload;
    }

    /**
     * completeOffline
     *
     * This operation completes the transaction offline. The completion is not forwarded to the processor. This implies the processor does not do anything. This method is only here to fix manually the transaction state.
     */
    public void completeOffline() {
        try {
            Transaction transaction = this.transactionService.create(this.spaceId, this.getTransactionPayload());
            transaction = this.transactionService.processWithoutUserInteraction(this.spaceId, transaction.getId());
            TransactionCompletion transactionCompletion = this.transactionCompletionService.completeOffline(this.spaceId, transaction.getId());
            TransactionCompletionState[] TransactionCompletionStates = {
                TransactionCompletionState.SUCCESSFUL,
                TransactionCompletionState.PENDING
            };
            // expect transactionCompletion.getState() to be in TransactionCompletionStates
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}
using System;
using System.IO;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Linq;
using System.Reflection;
using RestSharp;
using NUnit.Framework;

using Wallee.Model;
using Wallee.Service;
using Wallee.Client;

namespace Wallee.TransactionCompletionServiceExample
{
    /// <summary>
    ///  Class for TransactionCompletionServiceExample
    /// </summary>
    public class TransactionCompletionServiceExample
    {
        private readonly long SpaceId = <:YOUR_SPACE_ID>;
        private readonly string ApplicationUserID = <:YOUR_USER_ID>;
        private readonly string AuthenticationKey = <:YOUR_USER_SECRET>;

        private TransactionCompletionService TransactionCompletionService;
        private TransactionService TransactionService;


        /// <summary>
        /// TransactionCompletionServiceExample
        /// </summary>
        public TransactionCompletionServiceExample()
        {
            Configuration configuration = new Configuration(this.ApplicationUserID, this.AuthenticationKey);
            this.TransactionCompletionService = new TransactionCompletionService(configuration);
            this.TransactionService = new TransactionService(configuration);
        }

        // <summary>
        // Get transaction payload
        // <summary>
        private TransactionCreate GetTransactionPayload()
        {
            // Line item
            LineItemCreate lineItem1 = new LineItemCreate(
                name: "Red T-Shirt",
                uniqueId: "5412",
                type: LineItemType.PRODUCT,
                quantity: 1,
                amountIncludingTax: (decimal)29.95
            )
            {
                Sku = "red-t-shirt-123"
            };

            // Customer Billind Address
            AddressCreate billingAddress = new AddressCreate
            {
                City = "Winterthur",
                Country = "CH",
                EmailAddress = "test@example.com",
                FamilyName = "Customer",
                GivenName = "Good",
                Postcode = "8400",
                PostalState = "ZH",
                OrganizationName = "Test GmbH",
                MobilePhoneNumber = "+41791234567",
                Salutation = "Ms"
            };

            TransactionCreate transactionPayload = new TransactionCreate(new List<LineItemCreate>() { lineItem1 })
            {
                Currency = "CHF",
                AutoConfirmationEnabled = true,
                BillingAddress = billingAddress,
                ShippingAddress = billingAddress,
                Language = "en-US"
            };
            return transactionPayload;
        }

        /// <summary>
        /// CompleteOffline
        /// </summary>
        public void CompleteOffline()
        {
            Transaction transaction = this.TransactionService.Create(this.SpaceId, this.GetTransactionPayload());
            transaction = this.TransactionService.ProcessWithoutUserInteraction(this.SpaceId, transaction.Id);
            TransactionCompletion transactionCompletion = this.TransactionCompletionService.CompleteOffline(this.SpaceId, transaction.Id);
        }

    }
}
'use strict';
import { Wallee } from 'wallee';
import http = require("http");

// config
let config: { space_id: number, user_id: number, api_secret: string } = {
    space_id: <:YOUR_SPACE_ID>,
    user_id: <:YOUR_USER_ID>,
    api_secret: <:YOUR_USER_SECRET>
};

// Services
let transactionCompletionService: Wallee.api.TransactionCompletionService = new Wallee.api.TransactionCompletionService(config);
let transactionService: Wallee.api.TransactionService = new Wallee.api.TransactionService(config);

// Models
let transactionPayload: Wallee.model.TransactionCreate;

/**
 * Get transaction payload
 */
function getTransactionPayload(): Wallee.model.TransactionCreate {
    if (!transactionPayload) {
        // Line item
        let lineItem: Wallee.model.LineItemCreate = new Wallee.model.LineItemCreate();
        lineItem.name = 'Red T-Shirt';
        lineItem.uniqueId = '5412';
        lineItem.type = Wallee.model.LineItemType.PRODUCT;
        lineItem.quantity = 1;
        lineItem.amountIncludingTax = 29.95;
        lineItem.sku = 'red-t-shirt-123';

        // Customer Billing Address
        let billingAddress: Wallee.model.AddressCreate = new Wallee.model.AddressCreate();
        billingAddress.city = "Winterthur";
        billingAddress.country = "CH";
        billingAddress.emailAddress = "test@example.com";
        billingAddress.familyName = "Customer";
        billingAddress.givenName = "Good";
        billingAddress.postcode = "8400";
        billingAddress.postalState = "ZH";
        billingAddress.organizationName = "Test GmbH";
        billingAddress.mobilePhoneNumber = "+41791234567";
        billingAddress.salutation = "Ms";

        // Payload
        transactionPayload = new Wallee.model.TransactionCreate();
        transactionPayload.lineItems = [lineItem];
        transactionPayload.autoConfirmationEnabled = true;
        transactionPayload.currency = 'CHF';
        transactionPayload.billingAddress = billingAddress;
        transactionPayload.shippingAddress = billingAddress;
    }

    return transactionPayload;
}

// Complete a transaction offline
let transaction: Wallee.model.Transaction;
let transactionCompletion: Wallee.model.TransactionCompletion;
transactionService.create(config.space_id, getTransactionPayload())
.then((response: { response: http.IncomingMessage, body: Wallee.model.Transaction }) => {
    transaction = response.body;
    return transactionService.processWithoutUserInteraction(config.space_id, <number>transaction.id);
})
.delay(7500)
.then((response: { response: http.IncomingMessage, body: Wallee.model.Transaction }) => {
    transaction = response.body;
    return transactionCompletionService.completeOffline(config.space_id, <number>transaction.id);
})
.delay(7500)
.done((response: { response: http.IncomingMessage, body: Wallee.model.TransactionCompletion }) => {
    transactionCompletion = response.body;
    // expect transactionCompletion.state to equal Wallee.model.TransactionCompletionState.SUCCESSFUL
});
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the transaction which should be completed.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.36.4Search

Searches for the entities as specified by the given query.

POST /api/transaction-completion/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the transaction completions which are returned by the search.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.36.5completePartiallyOffline

This operation can be used to partially complete the transaction offline. The completion is not forwarded to the processor. This implies the processor does not do anything. This method is only here to fix manually the transaction state.

POST /api/transaction-completion/completePartiallyOffline View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.36.6Read

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

GET /api/transaction-completion/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the transaction completions which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.36.7completeOnline

This operation completes the transaction online. The completion is forwarded to the processor. This implies that the processor may take some actions based on the completion.

POST /api/transaction-completion/completeOnline View in Client
Examples
use Wallee\Sdk\ApiClient;
use Wallee\Sdk\Model\AddressCreate;
use Wallee\Sdk\Model\LineItemCreate;
use Wallee\Sdk\Model\LineItemType;
use Wallee\Sdk\Model\TransactionCompletionState;
use Wallee\Sdk\Model\TransactionCreate;
use Wallee\Sdk\Model\TransactionState;
use Wallee\Sdk\Service\TransactionCompletionService;
use Wallee\Sdk\Service\TransactionService;

// credentials
$spaceId = <:YOUR_SPACE_ID>;
$userId = <:YOUR_USER_ID>;
$secret = <:YOUR_USER_SECRET>;

// Services
$apiClient = new ApiClient($userId, $secret);
$transactionCompletionService = new TransactionCompletionService($apiClient);
$transactionService = new TransactionService($apiClient);

// line item
$lineItem = new LineItemCreate();
$lineItem->setName('Red T-Shirt');
$lineItem->setUniqueId('5412');
$lineItem->setSku('red-t-shirt-123');
$lineItem->setQuantity(1);
$lineItem->setAmountIncludingTax(29.95);
$lineItem->setType(LineItemType::PRODUCT);

// Customer Billing Address
$billingAddress = new AddressCreate();
$billingAddress->setCity('Winterthur');
$billingAddress->setCountry('CH');
$billingAddress->setEmailAddress('test@example.com');
$billingAddress->setFamilyName('Customer');
$billingAddress->setGivenName('Good');
$billingAddress->setPostCode('8400');
$billingAddress->setPostalState('ZH');
$billingAddress->setOrganizationName('Test GmbH');
$billingAddress->setPhoneNumber('+41791234567');
$billingAddress->setSalutation('Ms');

// Transaction payload
$transactionPayload = new TransactionCreate();
$transactionPayload->setCurrency('CHF');
$transactionPayload->setLineItems([$lineItem]);
$transactionPayload->setAutoConfirmationEnabled(true);
$transactionPayload->setBillingAddress($billingAddress);
$transactionPayload->setShippingAddress($billingAddress);
$transactionPayload->setFailedUrl('https://YOUR.SITE/transaction?state=fail');
$transactionPayload->setSuccessUrl('https://YOUR.SITE/transaction?state=success');

// Create a transaction
$transaction = $transactionService->create($spaceId, $transactionPayload);
$transaction = $transactionService->processWithoutUserInteraction($spaceId, $transaction->getId());

// Complete a transaction offline
$transactionCompletion = $this->transactionCompletionService->completeOnline($this->spaceId, $transaction->getId());
if(in_array($transactionCompletion->getState(), [TransactionCompletionState::SUCCESSFUL])){
    // completion successful
}
package com.wallee.sdk.test;

import com.wallee.sdk.ApiClient;
import com.wallee.sdk.model.*;
import com.wallee.sdk.service.*;

import java.math.BigDecimal;

/**
 * API tests for TransactionCompletionService
 */
public class TransactionCompletionServiceTest {

    // Credentials
    private Long spaceId = <:YOUR_SPACE_ID>;
    private Long applicationUserId = <:YOUR_USER_ID>;
    private String authenticationKey = <:YOUR_USER_SECRET>;

    // Services
    private ApiClient apiClient;
    private TransactionCompletionService transactionCompletionService;
    private TransactionService transactionService;

    // Models
    private TransactionCreate transactionPayload;

    public TransactionCompletionServiceTest() {
        this.apiClient = new ApiClient(applicationUserId, authenticationKey);
        this.transactionCompletionService = new TransactionCompletionService(this.apiClient);
        this.transactionService = new TransactionService(this.apiClient);
    }

    /**
     * Get transaction payload
     *
     * @return TransactionCreate
     */
    private TransactionCreate getTransactionPayload() {
        if (this.transactionPayload == null) {
            // Line item
            LineItemCreate lineItem = new LineItemCreate();
            lineItem.name("Red T-Shirt")
                .uniqueId("5412")
                .type(LineItemType.PRODUCT)
                .quantity(BigDecimal.valueOf(1))
                .amountIncludingTax(BigDecimal.valueOf(29.95))
                .sku("red-t-shirt-123");

            // Customer Billind Address
            AddressCreate billingAddress = new AddressCreate();
            billingAddress.city("Winterthur")
                .country("CH")
                .emailAddress("test@example.com")
                .familyName("Customer")
                .givenName("Good")
                .postcode("8400")
                .postalState("ZH")
                .organizationName("Test GmbH")
                .mobilePhoneNumber("+41791234567")
                .salutation("Ms");

            this.transactionPayload = new TransactionCreate();
            this.transactionPayload.autoConfirmationEnabled(true).currency("CHF").language("en-US");
            this.transactionPayload.setBillingAddress(billingAddress);
            this.transactionPayload.setShippingAddress(billingAddress);
            this.transactionPayload.addLineItemsItem(lineItem);
        }
        return this.transactionPayload;
    }

    /**
     * completeOnline
     *
     * This operation completes the transaction online. The completion is forwarded to the processor. This implies that the processor may take some actions based on the completion.
     */
    public void completeOnline() {
        try {
            Transaction transaction = this.transactionService.create(this.spaceId, this.getTransactionPayload());
            transaction = this.transactionService.processWithoutUserInteraction(this.spaceId, transaction.getId());
            TransactionCompletion transactionCompletion = this.transactionCompletionService.completeOnline(this.spaceId, transaction.getId());
            TransactionCompletionState[] TransactionCompletionStates = {
                TransactionCompletionState.SUCCESSFUL,
                TransactionCompletionState.PENDING
            };
            // expect transactionCompletion.getState() to be in TransactionCompletionStates
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}
using System;
using System.IO;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Linq;
using System.Reflection;
using RestSharp;
using NUnit.Framework;

using Wallee.Model;
using Wallee.Service;
using Wallee.Client;

namespace Wallee.TransactionCompletionServiceExample
{
    /// <summary>
    ///  Class for TransactionCompletionServiceExample
    /// </summary>
    public class TransactionCompletionServiceExample
    {
        private readonly long SpaceId = <:YOUR_SPACE_ID>;
        private readonly string ApplicationUserID = <:YOUR_USER_ID>;
        private readonly string AuthenticationKey = <:YOUR_USER_SECRET>;

        private TransactionCompletionService TransactionCompletionService;
        private TransactionService TransactionService;


        /// <summary>
        /// TransactionCompletionServiceExample
        /// </summary>
        public TransactionCompletionServiceExample()
        {
            Configuration configuration = new Configuration(this.ApplicationUserID, this.AuthenticationKey);
            this.TransactionCompletionService = new TransactionCompletionService(configuration);
            this.TransactionService = new TransactionService(configuration);
        }

        // <summary>
        // Get transaction payload
        // <summary>
        private TransactionCreate GetTransactionPayload()
        {
            // Line item
            LineItemCreate lineItem1 = new LineItemCreate(
                name: "Red T-Shirt",
                uniqueId: "5412",
                type: LineItemType.PRODUCT,
                quantity: 1,
                amountIncludingTax: (decimal)29.95
            )
            {
                Sku = "red-t-shirt-123"
            };

            // Customer Billind Address
            AddressCreate billingAddress = new AddressCreate
            {
                City = "Winterthur",
                Country = "CH",
                EmailAddress = "test@example.com",
                FamilyName = "Customer",
                GivenName = "Good",
                Postcode = "8400",
                PostalState = "ZH",
                OrganizationName = "Test GmbH",
                MobilePhoneNumber = "+41791234567",
                Salutation = "Ms"
            };

            TransactionCreate transactionPayload = new TransactionCreate(new List<LineItemCreate>() { lineItem1 })
            {
                Currency = "CHF",
                AutoConfirmationEnabled = true,
                BillingAddress = billingAddress,
                ShippingAddress = billingAddress,
                Language = "en-US"
            };
            return transactionPayload;
        }

        /// <summary>
        /// CompleteOnline
        /// </summary>
        public void CompleteOnline()
        {
            Transaction transaction = this.TransactionService.Create(this.SpaceId, this.GetTransactionPayload());
            transaction = this.TransactionService.ProcessWithoutUserInteraction(this.SpaceId, transaction.Id);
            TransactionCompletion transactionCompletion = this.TransactionCompletionService.CompleteOnline(this.SpaceId, transaction.Id);
        }
    }
}
'use strict';
import { Wallee } from 'wallee';
import http = require("http");

// config
let config: { space_id: number, user_id: number, api_secret: string } = {
    space_id: <:YOUR_SPACE_ID>,
    user_id: <:YOUR_USER_ID>,
    api_secret: <:YOUR_USER_SECRET>
};

// Services
let transactionCompletionService: Wallee.api.TransactionCompletionService = new Wallee.api.TransactionCompletionService(config);
let transactionService: Wallee.api.TransactionService = new Wallee.api.TransactionService(config);

// Models
let transactionPayload: Wallee.model.TransactionCreate;

/**
 * Get transaction payload
 */
function getTransactionPayload(): Wallee.model.TransactionCreate {
    if (!transactionPayload) {
        // Line item
        let lineItem: Wallee.model.LineItemCreate = new Wallee.model.LineItemCreate();
        lineItem.name = 'Red T-Shirt';
        lineItem.uniqueId = '5412';
        lineItem.type = Wallee.model.LineItemType.PRODUCT;
        lineItem.quantity = 1;
        lineItem.amountIncludingTax = 29.95;
        lineItem.sku = 'red-t-shirt-123';

        // Customer Billing Address
        let billingAddress: Wallee.model.AddressCreate = new Wallee.model.AddressCreate();
        billingAddress.city = "Winterthur";
        billingAddress.country = "CH";
        billingAddress.emailAddress = "test@example.com";
        billingAddress.familyName = "Customer";
        billingAddress.givenName = "Good";
        billingAddress.postcode = "8400";
        billingAddress.postalState = "ZH";
        billingAddress.organizationName = "Test GmbH";
        billingAddress.mobilePhoneNumber = "+41791234567";
        billingAddress.salutation = "Ms";

        // Payload
        transactionPayload = new Wallee.model.TransactionCreate();
        transactionPayload.lineItems = [lineItem];
        transactionPayload.autoConfirmationEnabled = true;
        transactionPayload.currency = 'CHF';
        transactionPayload.billingAddress = billingAddress;
        transactionPayload.shippingAddress = billingAddress;
    }

    return transactionPayload;
}

// Complete a transaction online
let transaction: Wallee.model.Transaction;
let transactionCompletion: Wallee.model.TransactionCompletion;
transactionService.create(config.space_id, getTransactionPayload())
.then((response: { response: http.IncomingMessage, body: Wallee.model.Transaction }) => {
    transaction = response.body;
    return transactionService.processWithoutUserInteraction(config.space_id, <number>transaction.id);
})
.delay(7500)
.then((response: { response: http.IncomingMessage, body: Wallee.model.Transaction }) => {
    transaction = response.body;
    return transactionCompletionService.completeOnline(config.space_id, <number>transaction.id);
})
.delay(7500)
.done((response: { response: http.IncomingMessage, body: Wallee.model.TransactionCompletion }) => {
    transactionCompletion = response.body;
    // expect transactionCompletion.state to equal Wallee.model.TransactionCompletionState.SUCCESSFUL
});
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the transaction which should be completed.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.37Transaction Iframe Service

3.9.37.1Build JavaScript URL

This operation creates the URL which can be used to embed the JavaScript for handling the iFrame checkout flow.

GET /api/transaction-iframe/javascript-url View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the transaction which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    String
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.38Transaction Invoice Comment Service

3.9.38.1Delete

Deletes the comment with the given id.

POST /api/transaction-invoice-comment/delete View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    No Response Body
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.38.2Find by invoice

Returns all comments of the given transaction invoice.

POST /api/transaction-invoice-comment/all View in Client
Query Parameters
  • spaceId
    *
    Long
  • invoiceId
    *
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.38.3Pin

Pins the comment to the top.

GET /api/transaction-invoice-comment/pin View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the comment to pin to the top.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    No Response Body
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.38.4Update

This updates the comment with the given properties. Only those properties which should be updated can be provided. The 'id' and 'version' are required to identify the comment.

POST /api/transaction-invoice-comment/update View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The comment object with the properties which should be updated.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.38.5Read

Reads the comment with the given 'id' and returns it.

GET /api/transaction-invoice-comment/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the comment which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.38.6Unpin

Unpins the comment from the top.

GET /api/transaction-invoice-comment/unpin View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the comment to unpin.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    No Response Body
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.38.7Create

Creates the comment with the given properties.

POST /api/transaction-invoice-comment/create View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The comment object which should be created.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.39Transaction Invoice Service

3.9.39.1Mark as Paid

Marks the transaction invoice with the given id as paid.

POST /api/transaction-invoice/markAsPaid View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the transaction invoice which should be marked as paid.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.39.2replace

Replaces the transaction invoice with given id with the replacement and returns the new transaction invoice.

POST /api/transaction-invoice/replace View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the transaction invoices which should be replaced.
    Long
Message Body *
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.39.3Count

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

POST /api/transaction-invoice/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Long
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.39.4Read

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

GET /api/transaction-invoice/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the transaction invoices which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.39.5Search

Searches for the entities as specified by the given query.

POST /api/transaction-invoice/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the transaction invoices which are returned by the search.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Transaction Invoice
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.39.6Mark as Derecognized

Marks the transaction invoice with the given id as derecognized.

POST /api/transaction-invoice/markAsDerecognized View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the transaction invoice which should be marked as derecognized.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.39.7getInvoiceDocument

Returns the PDF document for the transaction invoice with given id.

GET /api/transaction-invoice/getInvoiceDocument View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the transaction invoice to get the document for.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.39.8isReplacementPossible

Returns whether the transaction invoice with the given id can be replaced.

GET /api/transaction-invoice/isReplacementPossible View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The invoice which should be checked if a replacement is possible.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Boolean
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.39.9getInvoiceDocumentWithTargetMediaType

Returns the PDF document for the transaction invoice with given id and target media type id.

GET /api/transaction-invoice/getInvoiceDocumentWithTargetMediaType View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the transaction invoice to get the document for.
    Long
  • targetMediaTypeId
    *
    The id of the target media type for which the invoice should be generated for.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.40Transaction Lightbox Service

3.9.40.1Build JavaScript URL

This operation creates the URL which can be used to embed the JavaScript for handling the Lightbox checkout flow.

GET /api/transaction-lightbox/javascript-url View in Client
Examples
use Wallee\Sdk\ApiClient;
use Wallee\Sdk\Model\AddressCreate;
use Wallee\Sdk\Model\LineItemCreate;
use Wallee\Sdk\Model\LineItemType;
use Wallee\Sdk\Model\TransactionCreate;
use Wallee\Sdk\Service\TransactionLightboxService;
use Wallee\Sdk\Service\TransactionService;

// credentials
$spaceId = <:YOUR_SPACE_ID>;
$userId = <:YOUR_USER_ID>;
$secret = <:YOUR_USER_SECRET>;

// Services
$apiClient = new ApiClient($userId, $secret);
$transactionLightboxService = new TransactionLightboxService($apiClient);
$transactionService = new TransactionService($apiClient);

// line item
$lineItem = new LineItemCreate();
$lineItem->setName('Red T-Shirt');
$lineItem->setUniqueId('5412');
$lineItem->setSku('red-t-shirt-123');
$lineItem->setQuantity(1);
$lineItem->setAmountIncludingTax(29.95);
$lineItem->setType(LineItemType::PRODUCT);

// Customer Billing Address
$billingAddress = new AddressCreate();
$billingAddress->setCity('Winterthur');
$billingAddress->setCountry('CH');
$billingAddress->setEmailAddress('test@example.com');
$billingAddress->setFamilyName('Customer');
$billingAddress->setGivenName('Good');
$billingAddress->setPostCode('8400');
$billingAddress->setPostalState('ZH');
$billingAddress->setOrganizationName('Test GmbH');
$billingAddress->setPhoneNumber('+41791234567');
$billingAddress->setSalutation('Ms');

// Transaction payload
$transactionPayload = new TransactionCreate();
$transactionPayload->setCurrency('CHF');
$transactionPayload->setLineItems([$lineItem]);
$transactionPayload->setAutoConfirmationEnabled(true);
$transactionPayload->setBillingAddress($billingAddress);
$transactionPayload->setShippingAddress($billingAddress);
$transactionPayload->setFailedUrl('https://YOUR.SITE/transaction?state=fail');
$transactionPayload->setSuccessUrl('https://YOUR.SITE/transaction?state=success');

$transaction   = $transactionService->create($spaceId, $transactionPayload);
$javascriptUrl = $transactionLightboxService->javascriptUrl($spaceId, $transaction->getId());
package com.wallee.sdk.test;

import com.wallee.sdk.ApiClient;
import com.wallee.sdk.model.*;
import com.wallee.sdk.service.*;

import java.math.BigDecimal;

/**
 * API tests for TransactionLightboxService
 */
public class TransactionLightboxServiceTest {

    // Credentials
    private Long spaceId = <:YOUR_SPACE_ID>;
    private Long applicationUserId = <:YOUR_USER_ID>;
    private String authenticationKey = <:YOUR_USER_SECRET>;

    // Services
    private ApiClient apiClient;
    private TransactionLightboxService transactionLightboxService;
    private TransactionService transactionService;

    // Models
    private TransactionCreate transactionPayload;

    public TransactionLightboxServiceTest() {
        this.apiClient = new ApiClient(applicationUserId, authenticationKey);
        this.transactionLightboxService = new TransactionLightboxService(this.apiClient);
        this.transactionService = new TransactionService(this.apiClient);
    }

    /**
     * Get transaction payload
     *
     * @return TransactionCreate
     */
    private TransactionCreate getTransactionPayload() {
        if (this.transactionPayload == null) {
            // Line item
            LineItemCreate lineItem = new LineItemCreate();
            lineItem.name("Red T-Shirt")
                .uniqueId("5412")
                .type(LineItemType.PRODUCT)
                .quantity(BigDecimal.valueOf(1))
                .amountIncludingTax(BigDecimal.valueOf(29.95))
                .sku("red-t-shirt-123");

            // Customer Billind Address
            AddressCreate billingAddress = new AddressCreate();
            billingAddress.city("Winterthur")
                .country("CH")
                .emailAddress("test@example.com")
                .familyName("Customer")
                .givenName("Good")
                .postcode("8400")
                .postalState("ZH")
                .organizationName("Test GmbH")
                .mobilePhoneNumber("+41791234567")
                .salutation("Ms");

            this.transactionPayload = new TransactionCreate();
            this.transactionPayload.autoConfirmationEnabled(true).currency("CHF").language("en-US");
            this.transactionPayload.setBillingAddress(billingAddress);
            this.transactionPayload.setShippingAddress(billingAddress);
            this.transactionPayload.addLineItemsItem(lineItem);
        }
        return this.transactionPayload;
    }

    /**
     * Build JavaScript URL
     *
     * This operation creates the URL which can be used to embed the JavaScript for handling the Lightbox checkout flow.
     */
    public void javascriptUrl() {
        try {
            Transaction transaction = this.transactionService.create(this.spaceId, this.getTransactionPayload());
            String javascriptUrl = this.transactionLightboxService.javascriptUrl(spaceId, transaction.getId());
            // expect javascriptUrl to be a URL beginning with https://
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

}
using System;
using System.IO;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Linq;
using System.Reflection;
using RestSharp;
using NUnit.Framework;

using Wallee.Model;
using Wallee.Service;
using Wallee.Client;

namespace Wallee.TransactionLightboxServiceExample
{
    /// <summary>
    ///  Class for TransactionLightboxServiceExample
    /// </summary>
    public class TransactionLightboxServiceExample
    {
        private readonly long SpaceId = <:YOUR_SPACE_ID>;
        private readonly string ApplicationUserID = <:YOUR_USER_ID>;
        private readonly string AuthenticationKey = <:YOUR_USER_SECRET>;

        private Configuration Configuration;
        private TransactionLightboxService TransactionLightboxService;
        private TransactionCreate TransactionPayload;
        private TransactionService TransactionService;

        /// <summary>
        /// Class for TransactionLightboxServiceExample
        /// </summary>
        public TransactionLightboxServiceExample()
        {
            this.Configuration = new Configuration(this.ApplicationUserID, this.AuthenticationKey);
            this.TransactionLightboxService = new TransactionLightboxService(this.Configuration);
            this.TransactionService = new TransactionService(this.Configuration);
        }

        // <summary>
        // Get transaction payload
        // <summary>
        private TransactionCreate GetTransactionPayload()
        {
            if (this.TransactionPayload == null)
            {
                // Line item
                LineItemCreate lineItem1 = new LineItemCreate(
                    name: "Red T-Shirt",
                    uniqueId: "5412",
                    type: LineItemType.PRODUCT,
                    quantity: 1,
                    amountIncludingTax: (decimal)29.95
                )
                {
                    Sku = "red-t-shirt-123"
                };

                // Customer Billind Address
                AddressCreate billingAddress = new AddressCreate
                {
                    City = "Winterthur",
                    Country = "CH",
                    EmailAddress = "test@example.com",
                    FamilyName = "Customer",
                    GivenName = "Good",
                    Postcode = "8400",
                    PostalState = "ZH",
                    OrganizationName = "Test GmbH",
                    MobilePhoneNumber = "+41791234567",
                    Salutation = "Ms"
                };

                this.TransactionPayload = new TransactionCreate(new List<LineItemCreate>() { lineItem1 })
                {
                    Currency = "CHF",
                    AutoConfirmationEnabled = true,
                    BillingAddress = billingAddress,
                    ShippingAddress = billingAddress,
                    Language = "en-US"
                };
            }
            return this.TransactionPayload;
        }

        /// <summary>
        /// JavascriptUrl
        /// </summary>
        public void JavascriptUrl()
        {
            Transaction transaction = this.TransactionService.Create(this.SpaceId, this.GetTransactionPayload());
            var response = TransactionLightboxService.JavascriptUrl(this.SpaceId, transaction.Id);
        }

    }

}
'use strict';
import { Wallee } from 'wallee';
import http = require("http");

// config
let config: { space_id: number, user_id: number, api_secret: string } = {
    space_id: <:YOUR_SPACE_ID>,
    user_id: <:YOUR_USER_ID>,
    api_secret: <:YOUR_USER_SECRET>
};

// Services
let transactionLightboxService: Wallee.api.TransactionLightboxService = new Wallee.api.TransactionLightboxService(config);
let transactionService: Wallee.api.TransactionService = new Wallee.api.TransactionService(config);

// Models
let transactionPayload: Wallee.model.TransactionCreate;

/**
 * Get transaction payload
 */
function getTransactionPayload(): Wallee.model.TransactionCreate {
    if (!transactionPayload) {
        // Line item
        let lineItem: Wallee.model.LineItemCreate = new Wallee.model.LineItemCreate();
        lineItem.name = 'Red T-Shirt';
        lineItem.uniqueId = '5412';
        lineItem.type = Wallee.model.LineItemType.PRODUCT;
        lineItem.quantity = 1;
        lineItem.amountIncludingTax = 29.95;
        lineItem.sku = 'red-t-shirt-123';

        // Customer Billing Address
        let billingAddress: Wallee.model.AddressCreate = new Wallee.model.AddressCreate();
        billingAddress.city = "Winterthur";
        billingAddress.country = "CH";
        billingAddress.emailAddress = "test@example.com";
        billingAddress.familyName = "Customer";
        billingAddress.givenName = "Good";
        billingAddress.postcode = "8400";
        billingAddress.postalState = "ZH";
        billingAddress.organizationName = "Test GmbH";
        billingAddress.mobilePhoneNumber = "+41791234567";
        billingAddress.salutation = "Ms";

        // Payload
        transactionPayload = new Wallee.model.TransactionCreate();
        transactionPayload.lineItems = [lineItem];
        transactionPayload.autoConfirmationEnabled = true;
        transactionPayload.currency = 'CHF';
        transactionPayload.billingAddress = billingAddress;
        transactionPayload.shippingAddress = billingAddress;
    }

    return transactionPayload;
}

// Fetch lightbox javascript url
transactionService.create(config.space_id, getTransactionPayload())
    .then((response: { response: http.IncomingMessage, body: Wallee.model.Transaction }) => {
        let transaction: Wallee.model.Transaction = response.body;
        return transactionLightboxService.javascriptUrl(config.space_id, <number>transaction.id);
    })
    .done((response: { response: http.IncomingMessage, body: string }) => {
        let javascriptUrl: string = response.body;
        // expect javascriptUrl to be a string
        // expect javascriptUrl to include https://
    });
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the transaction which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    String
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.41Transaction Line Item Version Service

3.9.41.1Count

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

POST /api/transaction-line-item-version/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Long
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.41.2Search

Searches for the entities as specified by the given query.

POST /api/transaction-line-item-version/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts line item versions which are returned by the search.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.41.3Read

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

GET /api/transaction-line-item-version/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The ID of the line item version which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.41.4create

This operation applies a line item version on a particular transaction.

POST /api/transaction-line-item-version/create View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The line item version object which should be created.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.42Transaction Mobile SDK Service

3.9.42.1Build Mobile SDK URL

This operation builds the URL which is used to load the payment form within a WebView on a mobile device. This operation is typically called through the mobile SDK.

GET /api/transaction-mobile-sdk/payment-form-url View in Client
Query Parameters
  • credentials
    *
    The credentials identifies the transaction and contains the security details which grants the access this operation.
    String
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    String
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.43Transaction Payment Page Service

3.9.43.1Build Payment Page URL

This operation creates the URL to which the user should be redirected to when the payment page should be used.

GET /api/transaction-payment-page/payment-page-url View in Client
Examples
use Wallee\Sdk\ApiClient;
use Wallee\Sdk\Model\AddressCreate;
use Wallee\Sdk\Model\LineItemCreate;
use Wallee\Sdk\Model\LineItemType;
use Wallee\Sdk\Model\TransactionCreate;
use Wallee\Sdk\Service\TransactionPaymentPageService;
use Wallee\Sdk\Service\TransactionService;

// credentials
$spaceId = <:YOUR_SPACE_ID>;
$userId = <:YOUR_USER_ID>;
$secret = <:YOUR_USER_SECRET>;

// Services
$apiClient = new ApiClient($userId, $secret);
$transactionPaymentPageService = new TransactionPaymentPageService($apiClient);
$transactionService = new TransactionService($apiClient);

// line item
$lineItem = new LineItemCreate();
$lineItem->setName('Red T-Shirt');
$lineItem->setUniqueId('5412');
$lineItem->setSku('red-t-shirt-123');
$lineItem->setQuantity(1);
$lineItem->setAmountIncludingTax(29.95);
$lineItem->setType(LineItemType::PRODUCT);

// Customer Billing Address
$billingAddress = new AddressCreate();
$billingAddress->setCity('Winterthur');
$billingAddress->setCountry('CH');
$billingAddress->setEmailAddress('test@example.com');
$billingAddress->setFamilyName('Customer');
$billingAddress->setGivenName('Good');
$billingAddress->setPostCode('8400');
$billingAddress->setPostalState('ZH');
$billingAddress->setOrganizationName('Test GmbH');
$billingAddress->setPhoneNumber('+41791234567');
$billingAddress->setSalutation('Ms');

// Transaction payload
$transactionPayload = new TransactionCreate();
$transactionPayload->setCurrency('CHF');
$transactionPayload->setLineItems([$lineItem]);
$transactionPayload->setAutoConfirmationEnabled(true);
$transactionPayload->setBillingAddress($billingAddress);
$transactionPayload->setShippingAddress($billingAddress);
$transactionPayload->setFailedUrl('https://YOUR.SITE/transaction?state=fail');
$transactionPayload->setSuccessUrl('https://YOUR.SITE/transaction?state=success');

$transaction    = $transactionService->create($spaceId, $transactionPayload);
$paymentPageUrl = $transactionPaymentPageService->paymentPageUrl($spaceId, $transaction->getId());

header('Location: '. $paymentPageUrl);
package com.wallee.sdk.test;

import com.wallee.sdk.ApiClient;
import com.wallee.sdk.model.*;
import com.wallee.sdk.service.*;

import java.math.BigDecimal;

/**
 * API tests for TransactionPaymentPageService
 */
public class TransactionPaymentPageServiceTest {

    // Credentials
    private Long spaceId = <:YOUR_SPACE_ID>;
    private Long applicationUserId = <:YOUR_USER_ID>;
    private String authenticationKey = <:YOUR_USER_SECRET>;

    // Services
    private ApiClient apiClient;
    private TransactionPaymentPageService transactionPaymentPageService;
    private TransactionService transactionService;

    // Models
    private TransactionCreate transactionPayload;

    public TransactionPaymentPageServiceTest() {
        this.apiClient = new ApiClient(applicationUserId, authenticationKey);
        this.transactionPaymentPageService = new TransactionPaymentPageService(this.apiClient);
        this.transactionService = new TransactionService(this.apiClient);
    }

    /**
     * Get transaction payload
     *
     * @return TransactionCreate
     */
    private TransactionCreate getTransactionPayload() {
        if (this.transactionPayload == null) {
            // Line item
            LineItemCreate lineItem = new LineItemCreate();
            lineItem.name("Red T-Shirt")
                .uniqueId("5412")
                .type(LineItemType.PRODUCT)
                .quantity(BigDecimal.valueOf(1))
                .amountIncludingTax(BigDecimal.valueOf(29.95))
                .sku("red-t-shirt-123");

            // Customer Billind Address
            AddressCreate billingAddress = new AddressCreate();
            billingAddress.city("Winterthur")
                .country("CH")
                .emailAddress("test@example.com")
                .familyName("Customer")
                .givenName("Good")
                .postcode("8400")
                .postalState("ZH")
                .organizationName("Test GmbH")
                .mobilePhoneNumber("+41791234567")
                .salutation("Ms");

            this.transactionPayload = new TransactionCreate();
            this.transactionPayload.autoConfirmationEnabled(true).currency("CHF").language("en-US");
            this.transactionPayload.setBillingAddress(billingAddress);
            this.transactionPayload.setShippingAddress(billingAddress);
            this.transactionPayload.addLineItemsItem(lineItem);
        }
        return this.transactionPayload;
    }

    /**
     * Build Payment Page URL
     *
     * This operation creates the URL to which the user should be redirected to when the payment page should be used.
     *
     */
    public void paymentPageUrl() {
        try {
            Transaction transaction = this.transactionService.create(this.spaceId, this.getTransactionPayload());
            String paymentPageUrl = this.transactionPaymentPageService.paymentPageUrl(spaceId, transaction.getId());
            // expect paymentPageUrl to be a URL beginning with https://
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

}
using System;
using System.IO;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Linq;
using System.Reflection;
using RestSharp;
using NUnit.Framework;

using Wallee.Model;
using Wallee.Service;
using Wallee.Client;

namespace Wallee.TransactionPaymentPageServiceExample
{
    /// <summary>
    ///  TransactionPaymentPageServiceExample
    /// </summary>
    public class TransactionPaymentPageServiceExample
    {
        private readonly long SpaceId = <:YOUR_SPACE_ID>;
        private readonly string ApplicationUserID = <:YOUR_USER_ID>;
        private readonly string AuthenticationKey = <:YOUR_USER_SECRET>;

        private Configuration Configuration;
        private TransactionPaymentPageService TransactionPaymentPageService;
        private TransactionCreate TransactionPayload;
        private TransactionService TransactionService;

        /// <summary>
        /// TransactionPaymentPageServiceExample
        /// </summary>
        public TransactionPaymentPageServiceExample()
        {
            this.Configuration = new Configuration(this.ApplicationUserID, this.AuthenticationKey);
            this.TransactionPaymentPageService = new TransactionPaymentPageService(this.Configuration);
            this.TransactionService = new TransactionService(this.Configuration);
        }

        // <summary>
        // Get transaction payload
        // <summary>
        private TransactionCreate GetTransactionPayload()
        {
            if (this.TransactionPayload == null)
            {
                // Line item
                LineItemCreate lineItem1 = new LineItemCreate(
                    name: "Red T-Shirt",
                    uniqueId: "5412",
                    type: LineItemType.PRODUCT,
                    quantity: 1,
                    amountIncludingTax: (decimal)29.95
                )
                {
                    Sku = "red-t-shirt-123"
                };

                // Customer Billind Address
                AddressCreate billingAddress = new AddressCreate
                {
                    City = "Winterthur",
                    Country = "CH",
                    EmailAddress = "test@example.com",
                    FamilyName = "Customer",
                    GivenName = "Good",
                    Postcode = "8400",
                    PostalState = "ZH",
                    OrganizationName = "Test GmbH",
                    MobilePhoneNumber = "+41791234567",
                    Salutation = "Ms"
                };

                this.TransactionPayload = new TransactionCreate(new List<LineItemCreate>() { lineItem1 })
                {
                    Currency = "CHF",
                    AutoConfirmationEnabled = true,
                    BillingAddress = billingAddress,
                    ShippingAddress = billingAddress,
                    Language = "en-US"
                };
            }
            return this.TransactionPayload;
        }

        /// <summary>
        /// PaymentPageUrl
        /// </summary>
        public void PaymentPageUrl()
        {
            Transaction transaction = this.TransactionService.Create(this.SpaceId, this.GetTransactionPayload());
            var response = TransactionPaymentPageService.PaymentPageUrl(this.SpaceId, transaction.Id);
        }
    }
}
'use strict';
import { Wallee } from 'wallee';
import http = require("http");

// config
let config: { space_id: number, user_id: number, api_secret: string } = {
    space_id: <:YOUR_SPACE_ID>,
    user_id: <:YOUR_USER_ID>,
    api_secret: <:YOUR_USER_SECRET>
};

// Services
let transactionPaymentPageService: Wallee.api.TransactionPaymentPageService = new Wallee.api.TransactionPaymentPageService(config);
let transactionService: Wallee.api.TransactionService = new Wallee.api.TransactionService(config);

// Models
let transactionPayload: Wallee.model.TransactionCreate;

/**
 * Get transaction payload
 */
function getTransactionPayload(): Wallee.model.TransactionCreate {
    if (!transactionPayload) {
        // Line item
        let lineItem: Wallee.model.LineItemCreate = new Wallee.model.LineItemCreate();
        lineItem.name = 'Red T-Shirt';
        lineItem.uniqueId = '5412';
        lineItem.type = Wallee.model.LineItemType.PRODUCT;
        lineItem.quantity = 1;
        lineItem.amountIncludingTax = 29.95;
        lineItem.sku = 'red-t-shirt-123';

        // Customer Billing Address
        let billingAddress: Wallee.model.AddressCreate = new Wallee.model.AddressCreate();
        billingAddress.city = "Winterthur";
        billingAddress.country = "CH";
        billingAddress.emailAddress = "test@example.com";
        billingAddress.familyName = "Customer";
        billingAddress.givenName = "Good";
        billingAddress.postcode = "8400";
        billingAddress.postalState = "ZH";
        billingAddress.organizationName = "Test GmbH";
        billingAddress.mobilePhoneNumber = "+41791234567";
        billingAddress.salutation = "Ms";

        // Payload
        transactionPayload = new Wallee.model.TransactionCreate();
        transactionPayload.lineItems = [lineItem];
        transactionPayload.autoConfirmationEnabled = true;
        transactionPayload.currency = 'CHF';
        transactionPayload.billingAddress = billingAddress;
        transactionPayload.shippingAddress = billingAddress;
    }

    return transactionPayload;
}

// Fetch Payment Page Url
transactionService.create(config.space_id, getTransactionPayload())
    .then((response: { response: http.IncomingMessage, body: Wallee.model.Transaction }) => {
        let transaction: Wallee.model.Transaction = response.body;
        return transactionPaymentPageService.paymentPageUrl(config.space_id, <number>transaction.id);
    })
    .done((response: { response: http.IncomingMessage, body: string }) => {
        let paymentPageUrl: string = response.body;
        // expect paymentPageUrl to be a string
        // expect paymentPageUrl to include https://
    });
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the transaction which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    String
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.44Transaction Service

3.9.44.1Process One-Click Token with Credentials

This operation assigns the given token to the transaction and process it. This method will return an URL where the customer has to be redirect to complete the transaction.

POST /api/transaction/processOneClickTokenAndRedirectWithCredentials View in Client
Query Parameters
  • credentials
    *
    The credentials identifies the transaction and contains the security details which grants the access this operation.
    String
  • tokenId
    *
    The token ID is used to load the corresponding token and to process the transaction with it.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    String
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.44.2Read

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

GET /api/transaction/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the transaction which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.44.3Read With Credentials

Reads the transaction with the given 'id' and returns it. This method uses the credentials to authenticate and identify the transaction.

GET /api/transaction/readWithCredentials View in Client
Query Parameters
  • credentials
    *
    The credentials identifies the transaction and contains the security details which grants the access this operation.
    String
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.44.4getPackingSlip

Returns the packing slip for the transaction with given id.

GET /api/transaction/getPackingSlip View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the transaction to get the packing slip for.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.44.5Update

This updates the entity with the given properties. Only those properties which should be updated can be provided. The 'id' and 'version' are required to identify the entity.

POST /api/transaction/update View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The transaction object with the properties which should be updated.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.44.6Search

Searches for the entities as specified by the given query.

POST /api/transaction/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the transactions which are returned by the search.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Transaction
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.44.7Export

Exports the transactions into a CSV file. The file will contain the properties defined in the request.

POST /api/transaction/export View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The request controls the entries which are exported.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    binary:
    text/csv
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.44.8Create Transaction Credentials

This operation allows to create transaction credentials to delegate temporarily the access to the web service API for this particular transaction.

POST /api/transaction/createTransactionCredentials View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the transaction which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    String
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.44.9Confirm

The confirm operation marks the transaction as confirmed. Once the transaction is confirmed no more changes can be applied.

POST /api/transaction/confirm View in Client
Examples
POST /api/transaction/confirm?spaceId={YOUR_SPACE_ID} HTTP/1.1
Host: app-wallee.com 
Content-Type: application/json;charset=utf-8
X-Mac-Version: 1
X-Mac-Userid: {YOUR_USER_ID}
X-Mac-Timestamp: {UNIX_TIMESTAMP}
X-Mac-Value: {CALCULATED_MAC_VALUE}

{
	"id": 109891
}
Query Parameters
  • spaceId
    *
    Long
Message Body *
The transaction JSON object to update and confirm.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.44.10Count

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

POST /api/transaction/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Long
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.44.11Delete One-Click Token with Credentials

This operation removes the given token.

POST /api/transaction/deleteOneClickTokenWithCredentials View in Client
Query Parameters
  • credentials
    *
    The credentials identifies the transaction and contains the security details which grants the access this operation.
    String
  • tokenId
    *
    The token ID will be used to find the token which should be removed.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    No Response Body
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.44.12Create

Creates the entity with the given properties.

POST /api/transaction/create View in Client
Examples
POST /api/transaction/create?spaceId={YOUR_SPACE_ID} HTTP/1.1
Host: app-wallee.com 
Content-Type: application/json;charset=utf-8
X-Mac-Version: 1
X-Mac-Userid: {YOUR_USER_ID}
X-Mac-Timestamp: {UNIX_TIMESTAMP}
X-Mac-Value: {CALCULATED_MAC_VALUE}

{
	"billingAddress": {
		"city": "Winterthur",
		"commercialRegisterNumber": "",
		"country": "CH",
		"dateOfBirth": "",
		"emailAddress": "some-buyer@test.com",
		"familyName": "Test",
		"gender": "",
		"givenName": "Sam",
		"mobilePhoneNumber": "",
		"organisationName": "Test Company Ltd",
		"phoneNumber": "",
		"postcode": "8400",
		"salesTaxNumber": "",
		"salutation": "",
		"socialSecurityNumber": "",
		"state": "",
		"street": "Sample Street 47"
	},
	"currency": "EUR",
	"language": "en-US",
	"lineItems": [{
		"amountIncludingTax": "11.87",
		"name": "Sample Product",
		"quantity": "1",
		"shippingRequired": "true",
		"sku": "sample-123",
		"type": "PRODUCT",
		"uniqueId": "sample-123",
		"attributes": {
			"test1": {
				"label": "My Test Label",
				"value": "Test Attribute Value"
			},
			"c2": {
				"label": "My Test Label 2",
				"value": "Test Attribute Value"
			}
		}
	}],
	"metaData": {
		"sampleKey": "Some value",
		"additionalDataItem": "Other value"
	},
	"merchantReference": "DEV-2630",
	"shippingAddress": {
		"city": "Winterthur",
		"commercialRegisterNumber": "",
		"country": "CH",
		"dateOfBirth": "",
		"emailAddress": "some-buyer@test.com",
		"familyName": "Test",
		"gender": "",
		"givenName": "Sam",
		"mobilePhoneNumber": "",
		"organisationName": "Test Company Ltd",
		"phoneNumber": "",
		"postcode": "8400",
		"salesTaxNumber": "",
		"salutation": "",
		"socialSecurityNumber": "",
		"state": "",
		"street": "Sample Street 47"
	}
}
Query Parameters
  • spaceId
    *
    Long
Message Body *
The transaction object which should be created.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.44.13Fetch Possible Payment Methods with Credentials

This operation allows to get the payment method configurations which can be used with the provided transaction.

GET /api/transaction/fetch-payment-methods-with-credentials View in Client
Query Parameters
  • credentials
    *
    The credentials identifies the transaction and contains the security details which grants the access this operation.
    String
  • integrationMode
    *
    The integration mode defines the type of integration that is applied on the transaction.
    String
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.44.14Process Without User Interaction

This operation processes the transaction without requiring that the customer is present. Means this operation applies strategies to process the transaction without a direct interaction with the buyer. This operation is suitable for recurring transactions.

POST /api/transaction/processWithoutUserInteraction View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the transaction which should be processed.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.44.15Fetch One Click Tokens with Credentials

This operation returns the token version objects which references the tokens usable as one-click payment tokens for the provided transaction.

GET /api/transaction/fetchOneClickTokensWithCredentials View in Client
Query Parameters
  • credentials
    *
    The credentials identifies the transaction and contains the security details which grants the access this operation.
    String
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Token Version
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.44.16getInvoiceDocument

Returns the PDF document for the transaction invoice with given id.

GET /api/transaction/getInvoiceDocument View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the transaction to get the invoice document for.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.44.17Fetch Possible Payment Methods

This operation allows to get the payment method configurations which can be used with the provided transaction.

GET /api/transaction/fetch-payment-methods View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the transaction which should be returned.
    Long
  • integrationMode
    *
    The integration mode defines the type of integration that is applied on the transaction.
    String
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.44.18getLatestSuccessfulTransactionLineItemVersion

GET /api/transaction/getLatestTransactionLineItemVersion View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the transaction to get the latest line item version for.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.45Transaction Terminal Service

3.9.45.1Create Till Connection Credentials

This operation creates a set of credentials to use within the WebSocket.

POST /api/transaction-terminal/till-connection-credentials View in Client
Query Parameters
  • spaceId
    *
    Long
  • transactionId
    *
    The ID of the transaction which is used to process with the terminal.
    Long
  • terminalId
    *
    The ID of the terminal which should be used to process the transaction.
    Long
  • language
    The language in which the messages should be rendered in.
    String
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    String
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.45.2Fetch Receipts

Returns all receipts for the requested terminal transaction.

POST /api/transaction-terminal/fetch-receipts View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.46Transaction Void Service

3.9.46.1voidOffline

This operation voids the transaction offline. The void is not forwarded to the processor. This implies the processor does not do anything. This method is only here to fix manually the transaction state.

POST /api/transaction-void/voidOffline View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the transaction which should be voided.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.46.2Read

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

GET /api/transaction-void/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the transaction voids which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.46.3voidOnline

This operation voids the transaction online. The void is forwarded to the processor. This implies that the processor may take some actions based on the void.

POST /api/transaction-void/voidOnline View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the transaction which should be voided.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.46.4Search

Searches for the entities as specified by the given query.

POST /api/transaction-void/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the transaction voids which are returned by the search.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Transaction Void
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.9.46.5Count

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

POST /api/transaction-void/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Long
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.10Shopify

3.10.1Shopify Recurring Order Service

3.10.1.1Count

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

POST /api/shopify-recurring-order/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Long
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.10.1.2Read

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

GET /api/shopify-recurring-order/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the Shopify recurring order which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.10.1.3Update

This operation allows to update a Shopify recurring order.

POST /api/shopify-recurring-order/update View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    No Response Body
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.10.1.4Search

Searches for the entities as specified by the given query.

POST /api/shopify-recurring-order/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the Shopify recurring orders which are returned by the search.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.10.2Shopify Subscriber Service

3.10.2.1Count

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

POST /api/shopify-subscriber/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Long
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.10.2.2Update

This updates the entity with the given properties. Only those properties which should be updated can be provided. The 'id' and 'version' are required to identify the entity.

POST /api/shopify-subscriber/update View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The Shopify subscriber object with all the properties which should be updated. The id and the version are required properties.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.10.2.3Search

Searches for the entities as specified by the given query.

POST /api/shopify-subscriber/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the Shopify subscribers which are returned by the search.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Shopify Subscriber
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.10.2.4Read

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

GET /api/shopify-subscriber/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the Shopify subscriber which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.10.3Shopify Subscription Product Service

3.10.3.1Count

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

POST /api/shopify-subscription-product/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Long
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.10.3.2Read

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

GET /api/shopify-subscription-product/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the Shopify subscription product which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.10.3.3Create

Creates the entity with the given properties.

POST /api/shopify-subscription-product/create View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The Shopify subscription product object with the properties which should be created.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.10.3.4Update

This updates the entity with the given properties. Only those properties which should be updated can be provided. The 'id' and 'version' are required to identify the entity.

POST /api/shopify-subscription-product/update View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The Shopify subscription product object with all the properties which should be updated. The id and the version are required properties.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 409
    Error
    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
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.10.3.5Search

Searches for the entities as specified by the given query.

POST /api/shopify-subscription-product/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the Shopify subscription products which are returned by the search.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.10.4Shopify Subscription Service

3.10.4.1Read

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

GET /api/shopify-subscription/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the Shopify subscription which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.10.4.2Update Addresses

This operation allows to update a Shopify subscription addresses.

POST /api/shopify-subscription/update-addresses View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.10.4.3Count

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

POST /api/shopify-subscription/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Long
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.10.4.4Terminate

This operation allows to terminate a Shopify subscription.

POST /api/shopify-subscription/terminate View in Client
Query Parameters
  • spaceId
    *
    Long
  • subscriptionId
    *
    The ID identifies the Shopify subscription which should be terminated.
    Long
  • respectTerminationPeriod
    *
    The respect termination period controls whether the termination period configured on the product version should be respected or if the operation should take effect immediately.
    Boolean
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    No Response Body
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.10.4.5Update

This operation allows to update a Shopify subscription.

POST /api/shopify-subscription/update View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.10.4.6Search

Searches for the entities as specified by the given query.

POST /api/shopify-subscription/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the Shopify subscriptions which are returned by the search.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.10.4.7Create

This operation allows to create a Shopify subscription.

POST /api/shopify-subscription/create View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.10.5Shopify Subscription Suspension Service

3.10.5.1Count

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

POST /api/shopify-subscription-suspension/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Long
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.10.5.2Suspend

This operation allows to suspend a Shopify subscription.

POST /api/shopify-subscription-suspension/suspend View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.10.5.3Read

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

GET /api/shopify-subscription-suspension/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the Shopify subscription suspension which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.10.5.4Search

Searches for the entities as specified by the given query.

POST /api/shopify-subscription-suspension/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the Shopify subscription suspensions which are returned by the search.
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
  • 442
    Error
    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
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

3.10.5.5Reactivate