Documentation
Documentation
    • English (United States)
Web Service API

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.1Base

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.
Account Update
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Account
  • 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.
    Client Error
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.1.1.2Read

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.
    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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.1.1.3Create

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.
Account Create
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.1.1.4Count

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.
Entity Query Filter
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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.1.1.5Search

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.
Entity Query
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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.1.1.6Delete

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.
    Client Error
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.1.2Space Service

3.1.2.1Search

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.
Entity Query
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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.1.2.2Delete

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.
    Client Error
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.1.2.3Read

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.
    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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.1.2.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/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.
Space Update
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Space
  • 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.
    Client Error
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.1.2.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.
Space Create
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.1.2.6Count

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.
Entity Query Filter
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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

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.
Customer Address Active
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Customer Address
  • 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.
    Client Error
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.2.1.2Create

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.
Customer Address Create
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.2.1.3Count

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.
Entity Query Filter
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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.2.1.4selectDefaultAddress

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.
    Client Error
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.2.1.5Search

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.
Entity Query
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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.2.1.6Delete

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.
    Client Error
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.2.1.7Read

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.
    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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.2.2Customer Comment Service

3.2.2.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-comment/update View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The customer object with the properties which should be updated.
Customer Comment Active
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Customer Comment
  • 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.
    Client Error
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.2.2.2Create

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.
Customer Comment Create
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

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.
    Client Error
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.2.2.4Count

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.
Entity Query Filter
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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.2.2.5Read

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.
    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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.2.2.6Delete

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.
    Client Error
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.2.2.7Search

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.
Entity Query
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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.2.2.8pinComment

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.
    Client Error
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.2.3Customer Service

3.2.3.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/update View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The customer object with the properties which should be updated.
Customer Active
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Customer
  • 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.
    Client Error
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.2.3.2Create

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.
Customer Create
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.2.3.3Search

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.
Entity Query
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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.2.3.4Read

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.
    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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.2.3.5Delete

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.
    Client Error
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.2.3.6Count

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.
Entity Query Filter
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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.3Internationalization

3.3.1Country Service

3.3.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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.3.2Country State Service

3.3.2.1Find 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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.3.2.2All

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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.3.3Currency Service

3.3.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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.3.4Language Service

3.3.4.1All

This operation returns all languages.

GET /api/language/all View in Client
Examples 
GET /api/language/all HTTP/1.1
Host: smb.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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.3.5Legal Organization Form Service

3.3.5.1All

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.
    Collection of Legal Organization Form
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.3.5.2Find 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.
    Collection of Legal Organization Form
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.3.5.3Read

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.
    Legal Organization Form
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.4Label

3.4.1Label Descriptor Group Service

3.4.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.
    Collection of Label Descriptor Group
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.4.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.
    Label Descriptor Group
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.4.2Label Descriptor Service

3.4.2.1Read

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.
    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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.4.2.2All

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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.4.3Static Value Service

3.4.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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.4.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.
    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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.5Manual Task

3.5.1Manual Task Service

3.5.1.1Read

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.
    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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.5.1.2Count

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.
Entity Query Filter
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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.5.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.
Entity Query
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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6Payment

3.6.1Charge Attempt Service

3.6.1.1Read

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.
    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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.1.2Count

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.
Entity Query Filter
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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.1.3Search

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.
Entity Query
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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.2Charge Flow Level Payment Link Service

3.6.2.1Count

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.
Entity Query Filter
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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.2.2Read

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.
    Charge Flow Level 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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.2.3Search

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.
Entity Query
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Charge Flow Level 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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.3Charge Flow Level Service

3.6.3.1Read

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.
    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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.3.2Count

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.
Entity Query Filter
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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.3.3Search

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.
Entity Query
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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.3.4Send 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.
    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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.4Charge Flow Service

3.6.4.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.
    Client Error
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.4.2Read

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.
    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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.4.3applyFlow

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.
    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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.4.4Search

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.
Entity Query
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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.4.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.
Entity Query Filter
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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.4.6Cancel 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.
    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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.4.7Fetch 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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.5Condition Type Service

3.6.5.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.
    Condition Type
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.5.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.
    Collection of Condition Type
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.6Payment Connector Configuration Service

3.6.6.1Search

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.
Entity Query
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Connector Configuration
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.6.2Read

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.
    Connector Configuration
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.6.3Count

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.
Entity Query Filter
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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.7Payment Connector Service

3.6.7.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.
    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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.7.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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.8Payment Method Brand Service

3.6.8.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.
    Payment Method Brand
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.8.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.
    Collection of Payment Method Brand
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.9Payment Method Configuration Service

3.6.9.1Search

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.
Entity Query
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Payment Method Configuration
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.9.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.
    Payment Method Configuration
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.9.3Count

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.
Entity Query Filter
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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.10Payment Method Service

3.6.10.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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.10.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.
    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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.11Payment Processor Configuration Service

3.6.11.1Count

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.
Entity Query Filter
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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.11.2Read

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.
    Processor Configuration
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.11.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.
Entity Query
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Processor Configuration
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.12Payment Processor Service

3.6.12.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.
    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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.12.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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.13Payment Terminal Service

The payment terminal service allows to fetch the configured terminals.

3.6.13.1Remotely 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.
    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.
    Client Error
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.13.2Unlink 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.
    Client Error
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.13.3Remotely 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.
    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.
    Client Error
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.13.4Link 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.
    Client Error
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.13.5Count

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.
Entity Query Filter
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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.13.6Read

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.
    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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.13.7Search

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.
Entity Query
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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.14Payment Terminal Till Service

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

3.6.14.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.
    Transaction
  • 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.
    Client Error
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error
  • 543
    Error
    This status code indicates that the long polling request timed out.
    Client Error

3.6.14.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.
    Transaction
  • 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.
    Client Error
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error
  • 543
    Error
    This status code indicates that the long polling request timed out.
    Client Error

3.6.15Payment Terminal Transaction Summary Service

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

3.6.15.1Count

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.
Entity Query Filter
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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.15.2Fetch 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 *
Terminal Receipt Fetch Request
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Rendered Terminal 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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.15.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.
    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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.15.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.
Entity Query
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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.16Refund Comment Service

3.6.16.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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.16.2Pin

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.
    Client Error
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.16.3Delete

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.
    Client Error
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.16.4Unpin

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.
    Client Error
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.16.5Read

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.
    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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.16.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/refund-comment/update View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The comment object with the properties which should be updated.
Comment Active
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Refund Comment
  • 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.
    Client Error
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.16.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.
Comment Create
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.17Transaction Comment Service

3.6.17.1Find 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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.17.2Pin

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.
    Client Error
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.17.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.
    Client Error
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.17.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-comment/update View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The comment object with the properties which should be updated.
Comment Active
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Transaction Comment
  • 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.
    Client Error
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.17.5Create

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.
Comment Create
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.17.6Read

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.
    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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.17.7Delete

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.
    Client Error
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.18Transaction Invoice Comment Service

3.6.18.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.
    Client Error
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.18.2Read

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.
    Transaction Invoice 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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.18.3Update

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.
Comment Active
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Transaction Invoice Comment
  • 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.
    Client Error
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.18.4Create

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.
Comment Create
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Transaction Invoice 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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.18.5Find 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.
    Collection of Transaction Invoice 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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.18.6Pin

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.
    Client Error
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.18.7Unpin

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.
    Client Error
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.19Transaction Invoice Service

3.6.19.1Search

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.
Entity Query
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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.19.2getInvoiceDocument

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.
    Rendered Document
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.19.3Read

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.
    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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.19.4isReplacementPossible

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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.19.5replace

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 *
Transaction Invoice Replacement
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.19.6Mark 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.
    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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.19.7getInvoiceDocumentWithTargetMediaType

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.
    Rendered Document
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.19.8Mark 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.
    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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.19.9Count

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.
Entity Query Filter
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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.20Transaction Line Item Version Service

3.6.20.1create

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.
Transaction Line Item Version . Create
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Transaction Line Item 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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.20.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.
Entity Query
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Transaction Line Item 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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.20.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.
    Transaction Line Item 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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.20.4Count

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.
Entity Query Filter
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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.21Transaction Service

3.6.21.1Read

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.
    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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.21.2getLatestSuccessfulTransactionLineItemVersion

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.
    Transaction Line Item 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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.21.3Fetch 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.
    Collection of Payment Method Configuration
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.21.4Count

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.
Entity Query Filter
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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.21.5Fetch 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.
    Collection of Payment Method Configuration
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.21.6Update

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.
Transaction Pending
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Transaction
  • 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.
    Client Error
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.21.7Create

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: smb.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.
Transaction Create
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.21.8Export

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.
Entity Export Request
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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.21.9Process 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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.21.10getInvoiceDocument

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.
    Rendered Document
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.21.11Search

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.
Entity Query
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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.21.12Confirm

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: smb.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.
Transaction Pending
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Transaction
  • 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.
    Client Error
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.21.13Process 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.
    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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.21.14Create 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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.21.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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.21.16Delete 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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.21.17Read 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.
    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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.21.18getPackingSlip

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.
    Rendered Document
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.22Transaction Terminal Service

3.6.22.1Fetch Receipts

Returns all receipts for the requested terminal transaction.

POST /api/transaction-terminal/fetch-receipts View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
Terminal Receipt Fetch Request
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Rendered Terminal Receipt
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.6.22.2Create 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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.7User

3.7.1Application User Service

3.7.1.1Count

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

POST /api/application-user/count View in Client
Message Body
The filter which restricts the entities which are used to calculate the count.
Entity Query Filter
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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.7.1.2Search

Searches for the entities as specified by the given query.

POST /api/application-user/search View in Client
Message Body *
The query restricts the application users which are returned by the search.
Entity Query
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Application User
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.7.1.3Delete

Deletes the entity with the given id.

POST /api/application-user/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.
    Client Error
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.7.1.4Read

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

GET /api/application-user/read View in Client
Query Parameters
  • id
    *
    The id of the application user which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Application User
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.7.1.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/application-user/update View in Client
Message Body *
The application user entity with all the properties which should be updated. The id and the version are required properties.
Application User Update
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Application User
  • 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.
    Client Error
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.7.1.6Create

Creates the application user with the given properties.

POST /api/application-user/create View in Client
Message Body *
The user object with the properties which should be created.
Application User Create
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Application User With Mac Key
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.7.2Human User Service

3.7.2.1Read

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

GET /api/human-user/read View in Client
Query Parameters
  • id
    *
    The id of the human user which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Human User
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.7.2.2Count

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

POST /api/human-user/count View in Client
Message Body
The filter which restricts the entities which are used to calculate the count.
Entity Query Filter
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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.7.2.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/human-user/update View in Client
Message Body *
The object with all the properties which should be updated. The id and the version are required properties.
Human User Update
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Human User
  • 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.
    Client Error
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.7.2.4Create

Creates the entity with the given properties.

POST /api/human-user/create View in Client
Message Body *
The human user object with the properties which should be created.
Human User Create
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Human User
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.7.2.5Export

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

POST /api/human-user/export View in Client
Message Body *
The request controls the entries which are exported.
Entity Export Request
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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.7.2.6Search

Searches for the entities as specified by the given query.

POST /api/human-user/search View in Client
Message Body *
The query restricts the human users which are returned by the search.
Entity Query
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Human User
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.7.2.7Delete

Deletes the entity with the given id.

POST /api/human-user/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.
    Client Error
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.7.3Permission Service

3.7.3.1Read

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

GET /api/permission/read View in Client
Query Parameters
  • id
    *
    The id of the permission which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Permission
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.7.3.2All

This operation returns all entities which are available.

GET /api/permission/all View in Client
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Permission
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.7.4User Account Role Service

3.7.4.1List Roles

List all the roles that are assigned to the given user in the given account.

POST /api/user-account-role/list View in Client
Query Parameters
  • userId
    *
    The id of the user to whom the role is assigned.
    Long
  • accountId
    *
    The account to which the role is mapped.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of User Account Role
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.7.4.2Add Role

This operation grants the role to the given user with in the given account.

POST /api/user-account-role/addRole View in Client
Query Parameters
  • userId
    *
    The id of the user to whom the role is assigned.
    Long
  • accountId
    *
    The account to which the role is mapped.
    Long
  • roleId
    *
    The role which is mapped to the user and account.
    Long
  • appliesOnSubaccount
    Whether the role applies only on subaccount.
    Boolean
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    User Account Role
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.7.4.3Remove Role

This operation removes the specified user account role.

POST /api/user-account-role/removeRole View in Client
Query Parameters
  • id
    *
    The id of user account role 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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.7.5User Space Role Service

3.7.5.1Remove Role

This operation removes the specified user space role.

POST /api/user-space-role/removeRole View in Client
Query Parameters
  • id
    *
    The id of user space role 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.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.7.5.2List Roles

List all the roles that are assigned to the given user in the given space.

POST /api/user-space-role/list View in Client
Query Parameters
  • userId
    *
    The id of the user to whom the role is assigned.
    Long
  • spaceId
    *
    The space to which the role is mapped.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of User Space Role
  • 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.
    Client Error
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.7.5.3Add Role

This operation grants the given role to the user in the given space.

POST /api/user-space-role/addRole View in Client
Query Parameters
  • userId
    *
    The id of the user to whom the role is assigned.
    Long
  • spaceId
    *
    The space to which the role is mapped.
    Long
  • roleId
    *
    The role which is mapped to the user and space.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    User Space Role
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

3.8Webhook

3.8.1Webhook Encryption Service

3.8.1.1Read

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

GET /api/webhook-encryption/read View in Client
Query Parameters
  • id
    *
    The ID of the key version.
    String
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Webhook Encryption Public Key
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    Client Error
  • 542
    Error
    This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
    Server Error

4Model Definitions

The service may return complex objects those objects are defined within this section.

Models may have references between each other. A reference means an object points to another object. Depending on the reference we serialize the referenced object directly or we only serialize the primary key (long) of the referenced object. This means depending on the use case the actual object needs to be loaded with the according service. In this case we indicate this by defining the type as a long and we provide a link to the actual model we reference.

4.1Base

4.1.1Account Details

Properties
  • active
    Virtual
    Whether this account and all its parent accounts are active.
    Boolean
  • activeOrRestrictedActive
    Virtual
    Whether this account and all its parent accounts are active or restricted active.
    Boolean
  • createdBy
    The ID of the user the account was created by.
    Long
    User
  • createdOn
    The date and time when the account was created.
    DateTime
  • deletedBy
    The ID of a user the account was deleted by.
    Long
    User
  • deletedOn
    The date and time when the account was deleted.
    DateTime
  • id
    A unique identifier for the object.
    Long
  • lastModifiedDate
    The date and time when the object was last modified.
    DateTime
  • name
    3 - 200 chars
    The name used to identify the account.
    String
  • parentAccount
    Virtual
    The parent account responsible for administering this account.
    Account
  • plannedPurgeDate
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
    DateTime
  • restrictedActive
    Virtual
    Whether this account and all its parent accounts are active or restricted active. There is at least one account that is restricted active.
    Boolean
  • scope
    The scope that the account belongs to.
    Long
    Scope
  • state
    The object's current state.
    Account State
  • subaccountLimit
    The number of sub-accounts that can be created within this account.
    Long
  • type
    The account's type which defines its role and capabilities.
    Account Type
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.1.2Account State

Fields
  • CREATE
    Create
  • RESTRICTED_ACTIVE
    Restricted Active
  • ACTIVE
    Active
  • INACTIVE
    Inactive
  • DELETING
    Deleting
  • DELETED
    Deleted

4.1.3Account Type

Fields
  • MASTER
    Master
  • REGULAR
    Regular
  • SUBACCOUNT
    Subaccount

4.1.4Address Details

Properties
  • city
    ≤ 100 chars
    The city, town or village.
    String
  • commercialRegisterNumber
    ≤ 100 chars
    The commercial registration number of the organization.
    String
  • country
    The two-letter country code (ISO 3166 format).
    String
  • dateOfBirth
    The date of birth.
    Date
  • dependentLocality
    ≤ 100 chars
    The dependent locality which is a sub-division of the state.
    String
  • emailAddress
    Email
    ≤ 254 chars
    The email address.
    String
  • familyName
    ≤ 100 chars
    The family or last name.
    String
  • gender
    The gender.
    Gender
  • givenName
    ≤ 100 chars
    The given or first name.
    String
  • legalOrganizationForm
    The legal form of the organization.
    Legal Organization Form
  • mobilePhoneNumber
    ≤ 100 chars
    The phone number of a mobile phone.
    String
  • organizationName
    ≤ 100 chars
    The organization's name.
    String
  • phoneNumber
    ≤ 100 chars
    The phone number.
    String
  • postalState
    The name of the region, typically a state, county, province or prefecture.
    String
  • postcode
    ≤ 40 chars
    The postal code, also known as ZIP, postcode, etc.
    String
  • salesTaxNumber
    ≤ 100 chars
    The sales tax number of the organization.
    String
  • salutation
    ≤ 20 chars
    The salutation e.g. Mrs, Mr, Dr.
    String
  • socialSecurityNumber
    ≤ 100 chars
    The social security number.
    String
  • sortingCode
    ≤ 100 chars
    The sorting code identifying the post office where the PO Box is located.
    String
  • street
    ≤ 300 chars
    The street or PO Box.
    String

4.1.5Creation Entity State

Fields
  • CREATE
    Create
  • ACTIVE
    Active
  • INACTIVE
    Inactive
  • DELETING
    Deleting
  • DELETED
    Deleted

4.1.6Criteria Operator

Fields
  • CONTAINS
    Contains
  • EQUALS
    Equals
  • EQUALS_IGNORE_CASE
    Equals Ignore Case
  • GREATER_THAN
    Greater Than
  • GREATER_THAN_OR_EQUAL
    Greater Than Or Equal
  • LESS_THAN
    Less Than
  • LESS_THAN_OR_EQUAL
    Less Than Or Equal
  • NOT_EQUALS
    Not Equals
  • NOT_EQUALS_IGNORE_CASE
    Not Equals Ignore Case
  • NOT_CONTAINS
    Not Contains
  • IS_NULL
    Is Null
  • IS_NOT_NULL
    Is Not Null

4.1.7Database Details

Properties
  • id
    A unique identifier for the object.
    Long
  • name
    ≤ 200 chars
    The name used to identify the database.
    String
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.1.8Environment

Fields
  • LIVE
    Live
  • PREVIEW
    Preview

4.1.9Failure Category

Fields
  • TEMPORARY_ISSUE
    Temporary Issue
  • INTERNAL
    Internal
  • END_USER
    End User
  • CONFIGURATION
    Configuration
  • DEVELOPER
    Developer

4.1.10Failure Reason Details

Properties
  • category
    Failure Category
  • description
    The localized description of the object.
    Map of String String
  • features
    Collection of Long
    Feature
  • id
    A unique identifier for the object.
    Long
  • name
    The localized name of the object.
    Map of String String

4.1.11Feature Details

Properties
  • beta
    Whether the feature is in beta stage and there may still be some issues.
    Boolean
  • category
    The category that the feature belongs to.
    Feature Category
  • description
    The localized description of the object.
    Map of String String
  • id
    A unique identifier for the object.
    Long
  • logoPath
    The path to the feature's logo image.
    String
  • name
    The localized name of the object.
    Map of String String
  • requiredFeatures
    The features that must be enabled for this feature to work properly.
    Collection of Long
    Feature
  • sortOrder
    When listing features, they can be sorted by this number.
    Integer
  • visible
    Boolean

4.1.12Feature Category Details

Properties
  • description
    The localized description of the object.
    Map of String String
  • id
    A unique identifier for the object.
    Long
  • name
    The localized name of the object.
    Map of String String
  • orderWeight
    When listing feature categories, they can be sorted by this number.
    Integer

4.1.13Gender

Fields
  • MALE
    Male
  • FEMALE
    Female

4.1.14Line Item Details

Properties
  • aggregatedTaxRate
    Virtual
    The aggregated tax rate is the sum of all tax rates of the line item.
    Decimal
  • amountExcludingTax
    Virtual
    Decimal
  • amountIncludingTax
    Virtual
    Decimal
  • attributes
    Map of String Line Item Attribute
  • discountExcludingTax
    Virtual
    Decimal
  • discountIncludingTax
    Decimal
  • name
    1 - 150 chars
    String
  • quantity
    Positive
    Decimal
  • shippingRequired
    Boolean
  • sku
    ≤ 200 chars
    String
  • taxAmount
    Virtual
    Decimal
  • taxAmountPerUnit
    Virtual
    Decimal
  • taxes
    Collection of Tax
  • type
    Line Item Type
  • undiscountedAmountExcludingTax
    Virtual
    Decimal
  • undiscountedAmountIncludingTax
    Virtual
    Decimal
  • undiscountedUnitPriceExcludingTax
    Virtual
    Decimal
  • undiscountedUnitPriceIncludingTax
    Virtual
    Decimal
  • uniqueId
    ≤ 200 chars
    The unique id identifies the line item within the set of line items associated with the transaction.
    String
  • unitPriceExcludingTax
    Virtual
    Decimal
  • unitPriceIncludingTax
    Virtual
    Decimal

4.1.15Line Item Attribute Details

Properties
  • label
    ≤ 512 chars
    String
  • value
    ≤ 512 chars
    String

4.1.16Line Item Reduction Details

Properties
  • lineItemUniqueId
    ≤ 200 chars
    The unique id identifies the line item on which the reduction is applied on.
    String
  • quantityReduction
    Positive
    Decimal
  • unitPriceReduction
    Decimal

4.1.17Line Item Type

Fields
  • SHIPPING
    Shipping
  • DISCOUNT
    Discount
  • FEE
    Fee
  • PRODUCT
    Product
  • TIP
    Tip

4.1.18Resource Path Details

Properties
  • id
    A unique identifier for the object.
    Long
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • path
    4 - 500 chars
    String
  • plannedPurgeDate
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
    DateTime
  • spaceId
    Long
  • state
    The object's current state.
    Resource State
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.1.19Resource State

Fields
  • ACTIVE
    Active
  • DELETING
    Deleting
  • DELETED
    Deleted

4.1.20Scope Details

Properties
  • domainName
    ≤ 40 chars
    The domain name that belongs to the scope.
    String
  • features
    The list of features that are active in the scope.
    Collection of Feature
  • id
    A unique identifier for the object.
    Long
  • machineName
    ≤ 50 chars
    ([A-Z][A-Za-z0-9]+)(_([A-Z][A-Za-z0-9]+))*
    The name identifying the scope in e.g. URLs.
    String
  • name
    ≤ 50 chars
    The name used to identify the scope.
    String
  • plannedPurgeDate
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
    DateTime
  • port
    ≥ 1
    The port where the scope can be accessed.
    Integer
  • sslActive
    Whether the scope supports SSL.
    Boolean
  • state
    The object's current state.
    Creation Entity State
  • themes
    The themes that determine the look and feel of the scope's user interface. A fall-through strategy is applied when building the actual theme.
    Collection of String
  • url
    Virtual
    The URL where the scope can be accessed.
    String
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.1.21Space Details

Properties
  • account
    The account that the space belongs to.
    Account
  • active
    Virtual
    Whether this space and all its parent accounts are active.
    Boolean
  • activeOrRestrictedActive
    Virtual
    Whether this space and all its parent accounts are active or restricted active.
    Boolean
  • createdBy
    The ID of the user the space was created by.
    Long
    User
  • createdOn
    The date and time when the space was created.
    DateTime
  • database
    The database the space is connected to and that holds the space's data.
    Database
  • deletedBy
    The ID of the user the space was deleted by.
    Long
    User
  • deletedOn
    The date and time when the space was deleted.
    DateTime
  • id
    A unique identifier for the object.
    Long
  • lastModifiedDate
    The date and time when the object was last modified.
    DateTime
  • name
    3 - 200 chars
    The name used to identify the space.
    String
  • plannedPurgeDate
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
    DateTime
  • postalAddress
    The address that is used in communication with clients for example in emails, documents, etc.
    Space Address
  • primaryCurrency
    The currency that is used to display aggregated amounts in the space.
    String
  • requestLimit
    The maximum number of API requests that are accepted within two minutes. This limit can only be changed with special privileges.
    Long
  • restrictedActive
    Virtual
    Whether this space and all its parent accounts are active or restricted active. There is least one parent account that is restricted active.
    Boolean
  • state
    The object's current state.
    Creation Entity State
  • technicalContactAddresses
    The email address that will receive messages about technical issues and errors that occur in the space.
    Collection of String
  • timeZone
    The time zone that is used to schedule and run background processes. This does not affect the formatting of dates in the user interface.
    String
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.1.22Space Address Details

Properties
  • city
    The city, town or village.
    String
  • country
    The two-letter country code (ISO 3166 format).
    String
  • dependentLocality
    ≤ 100 chars
    The dependent locality which is a sub-division of the state.
    String
  • emailAddress
    The email address used for communication with clients.
    String
  • familyName
    ≤ 100 chars
    The family or last name.
    String
  • givenName
    ≤ 100 chars
    The given or first name.
    String
  • mobilePhoneNumber
    ≤ 100 chars
    The phone number of a mobile phone.
    String
  • organizationName
    ≤ 100 chars
    The organization's name.
    String
  • phoneNumber
    ≤ 100 chars
    The phone number.
    String
  • postalState
    The name of the region, typically a state, county, province or prefecture.
    String
  • postcode
    The postal code, also known as ZIP, postcode, etc.
    String
  • salesTaxNumber
    ≤ 100 chars
    The sales tax number of the organization.
    String
  • salutation
    ≤ 20 chars
    The salutation e.g. Mrs, Mr, Dr.
    String
  • sortingCode
    ≤ 100 chars
    The sorting code identifying the post office where the PO Box is located.
    String
  • street
    The street or PO Box.
    String

4.1.23Space View Details

Properties
  • id
    A unique identifier for the object.
    Long
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • name
    3 - 200 chars
    The space view name is used internally to identify the space view in administrative interfaces. For example it is used within search fields and hence it should be distinct and descriptive.
    String
  • plannedPurgeDate
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
    DateTime
  • space
    The space to which the view belongs to.
    Space
  • state
    The object's current state.
    Creation Entity State
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.2Customer

4.2.1Customer Details

Properties
  • createdOn
    The date and time when the object was created.
    DateTime
  • customerId
    ≤ 100 chars
    The customer's ID in the merchant's system.
    String
  • emailAddress
    Email
    ≤ 254 chars
    The customer's email address.
    String
  • familyName
    ≤ 100 chars
    The customer's family or last name.
    String
  • givenName
    ≤ 100 chars
    The customer's given or first name.
    String
  • id
    A unique identifier for the object.
    Long
  • language
    The language that is linked to the object.
    String
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • metaData
    Virtual
    Allow to store additional information about the object.
    Map of String String
  • preferredCurrency
    The customer's preferred currency.
    String
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.2.2Customer Address Details

Properties
  • address
    The actual postal address.
    Customer Postal Address
  • addressType
    Whether the address is for billing or shipping or both.
    Customer Address Type
  • createdOn
    The date and time when the object was created.
    DateTime
  • customer
    The customer that the object belongs to.
    Customer
  • defaultAddress
    Whether this is the customer's default address.
    Boolean
  • id
    A unique identifier for the object.
    Long
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.2.3Customer Address Type

Fields
  • BILLING
    Billing
  • SHIPPING
    Shipping
  • BOTH
    Both

4.2.4Customer Comment Details

Properties
  • content
    ≤ 262,144 chars
    The comment's actual content.
    String
  • createdBy
    The ID of the user the comment was created by.
    Long
    User
  • createdOn
    The date and time when the object was created.
    DateTime
  • customer
    The customer that the object belongs to.
    Long
    Customer
  • editedBy
    The ID of the user the comment was last updated by.
    Long
    User
  • editedOn
    The date and time when the comment was last updated.
    DateTime
  • id
    A unique identifier for the object.
    Long
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • pinned
    Whether the comment is pinned to the top.
    Boolean
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.2.5Customer Postal Address Details

Properties
  • city
    ≤ 100 chars
    The city, town or village.
    String
  • commercialRegisterNumber
    ≤ 100 chars
    The commercial registration number of the organization.
    String
  • country
    The two-letter country code (ISO 3166 format).
    String
  • dateOfBirth
    The date of birth.
    Date
  • dependentLocality
    ≤ 100 chars
    The dependent locality which is a sub-division of the state.
    String
  • emailAddress
    Email
    ≤ 254 chars
    The email address.
    String
  • familyName
    ≤ 100 chars
    The family or last name.
    String
  • gender
    The gender.
    Gender
  • givenName
    ≤ 100 chars
    The given or first name.
    String
  • legalOrganizationForm
    The legal form of the organization.
    Legal Organization Form
  • mobilePhoneNumber
    ≤ 100 chars
    The phone number of a mobile phone.
    String
  • organizationName
    ≤ 100 chars
    The organization's name.
    String
  • phoneNumber
    ≤ 100 chars
    The phone number.
    String
  • postalState
    The name of the region, typically a state, county, province or prefecture.
    String
  • postcode
    ≤ 40 chars
    The postal code, also known as ZIP, postcode, etc.
    String
  • salesTaxNumber
    ≤ 100 chars
    The sales tax number of the organization.
    String
  • salutation
    ≤ 20 chars
    The salutation e.g. Mrs, Mr, Dr.
    String
  • socialSecurityNumber
    ≤ 100 chars
    The social security number.
    String
  • sortingCode
    ≤ 100 chars
    The sorting code identifying the post office where the PO Box is located.
    String
  • street
    ≤ 300 chars
    The street or PO Box.
    String

4.3Document

4.3.1Document Template Type Details

Properties

4.3.2Document Template Type Group Details

Properties
  • id
    A unique identifier for the object.
    Long
  • title
    Map of String String

4.3.3Rendered Document Details

Properties

4.4Entity Query

4.4.1Entity Export Request Details

The entity property export request contains the information required to create an export of a list of entities.

Properties
  • properties
    *
    The properties is a list of property paths which should be exported.
    Collection of String
  • query
    The query limits the returned entries. The query allows to restrict the entries to return and it allows to control the order of them.
    Entity Query

4.4.2Entity Query Details

The entity query allows to search for specific entities by providing filters. This is similar to a SQL query.

Properties
  • filter
    The filter node defines the root filter node of the query. The root node may contain multiple sub nodes with different filters in it.
    Entity Query Filter
  • language
    The language is applied to the ordering of the entities returned. Some entity fields are language dependent and hence the language is required to order them.
    String
  • numberOfEntities
    The number of entities defines how many entities should be returned. There is a maximum of 100 entities.
    Integer
  • orderBys
    The order bys allows to define the ordering of the entities returned by the search.
    Collection of Entity Query Order By
  • startingEntity
    The 'starting entity' defines the entity number at which the returned result should start. The entity number is the consecutive number of the entity as returned and it is not the entity id.
    Integer

4.4.3Entity Query Filter Details

The query filter allows to restrict the entities which are returned.

Properties
  • children
    The 'children' can contain other filter nodes which are applied to the query. This property is only applicable on filter types 'OR' and 'AND'.
    Collection of Entity Query Filter
  • fieldName
    The 'fieldName' indicates the property on the entity which should be filtered. This property is only applicable on filter type 'LEAF'.
    String
  • operator
    The 'operator' indicates what kind of filtering on the 'fieldName' is executed on. This property is only applicable on filter type 'LEAF'.
    Criteria Operator
  • type
    *
    The filter type controls how the query node is interpreted. I.e. if the node acts as leaf node or as a filter group.
    Entity Query Filter Type
  • value
    The 'value' is used to compare with the 'fieldName' as defined by the 'operator'. This property is only applicable on filter type 'LEAF'.
    Object

4.4.4Entity Query Filter Type

The filter type defines how the filter is interpreted. Depending of the type different properties are relevant on the filter itself.

Fields
  • LEAF
    Leaf
    The leaf node defines a restriction on the result set.
  • OR
    OR
    The OR node defines a group of nodes which are combined with a logical OR.
  • AND
    AND
    The AND node defines a group of nodes which are combined with a logical AND.

4.4.5Entity Query Order By Details

The 'order by' allows to order the returned entities.

Properties

4.4.6Order By Type

The 'order by' type specifies how the result is sorted.

Fields
  • DESC
    Descending
    Sorts the result descending.
  • ASC
    Ascending
    Sorts the result ascending.

4.5Error

4.5.1Client Error Details

An error that is returned as the result of a bad user request or a misconfiguration.

Properties
  • date
    Date when an error has occurred.
    String
  • defaultMessage
    The error message which is translated into the default language (i.e. English).
    String
  • id
    Unique identifier of an error.
    String
  • message
    The error message which is translated in into the language of the client.
    String
  • type
    The type of the client error.
    Client Error Type

4.5.2Client Error Type

The type of Client Errors which can be returned by a service.

Fields
  • END_USER_ERROR
    User Error
    User error is the result of a direct user input.
  • CONFIGURATION_ERROR
    Configuration Error
    A configuration Error indicates that there is an application configuration which is configured incorrectly.
  • DEVELOPER_ERROR
    Developer Error
    A developer Error indicates that there is a bad API request.

4.5.3Server Error Details

This error is thrown when something unexpected happens on our side.

Properties
  • date
    Date when an error has occurred.
    String
  • id
    Unique identifier of an error.
    String
  • message
    This message describes an error.
    String

4.6Internationalization

4.6.1Address Format Details

Properties
  • postCodeExamples
    A list of sample post codes.
    Collection of String
  • postCodeRegex
    The regular expression to validate post codes.
    String
  • requiredFields
    The fields that are required in the address format.
    Collection of Address Format Field
  • usedFields
    The fields that are used in the address format.
    Collection of Address Format Field

4.6.2Address Format Field

Fields
  • GIVEN_NAME
    Given Name
  • FAMILY_NAME
    Family Name
  • ORGANIZATION_NAME
    Organization Name
  • STREET
    Street
  • DEPENDENT_LOCALITY
    Dependent Locality
  • CITY
    City
  • POSTAL_STATE
    Postal State
  • POST_CODE
    Post Code
  • SORTING_CODE
    Sorting Code
  • COUNTRY
    Country

4.6.3Country Details

Properties
  • addressFormat
    Specifies the country's way of formatting addresses.
    Address Format
  • isoCode2
    The country's two-letter code (ISO 3166-1 alpha-2 format).
    String
  • isoCode3
    The country's three-letter code (ISO 3166-1 alpha-3 format).
    String
  • name
    The name of the country.
    String
  • numericCode
    The country's three-digit code (ISO 3166-1 numeric format).
    String
  • stateCodes
    The codes of all regions (e.g. states, provinces) of the country (ISO 3166-2 format).
    Collection of String

4.6.4Currency Details

Properties
  • currencyCode
    The currency's three-letter code (ISO 4217 format).
    String
  • fractionDigits
    The currency's number of decimals. When calculating amounts in this currency, the fraction digits determine the accuracy.
    Integer
  • name
    The name of the currency.
    String
  • numericCode
    The currency's three-digit code (ISO 4217 format).
    Integer

4.6.5Language Details

Properties
  • countryCode
    The two-letter code of the language's region (ISO 3166-1 alpha-2 format).
    String
  • ietfCode
    The language's IETF tag consisting of the two-letter ISO code and region e.g. en-US, de-CH.
    String
  • iso2Code
    The language's two-letter code (ISO 639-1 format).
    String
  • iso3Code
    The language's three-letter code (ISO 639-2/T format).
    String
  • name
    The name of the language.
    String
  • pluralExpression
    The expression to determine the plural index for a given number of items used to find the proper plural form for translations.
    String
  • primaryOfGroup
    Whether this is the primary language in a group of languages.
    Boolean

4.6.6Legal Organization Form Details

Properties
  • country
    The two-letter code of the country the legal organization form is used in (ISO 3166-1 alpha-2 format).
    String
  • description
    The localized descriptions of the legal organization form.
    Collection of Localized String
  • englishDescription
    The English name of the legal organization form.
    String
  • id
    A unique identifier for the object.
    Long
  • shortcut
    The localized shortcuts of the legal organization form.
    Collection of Localized String

4.6.7Localized String Details

Properties
  • language
    The term's language.
    String
  • string
    The localized term.
    String

4.6.8State Details

Properties
  • code
    The state's code used within addresses.
    String
  • country
    String
  • countryCode
    The two-letter code of the state's country (ISO 3166-1 alpha-2 format).
    String
  • id
    The state's code in ISO 3166-2 format.
    String
  • name
    The name of the state.
    String

4.7Label

4.7.1Label Details

Properties
  • content
    Object
  • contentAsString
    String
  • descriptor
    Label Descriptor
  • id
    A unique identifier for the object.
    Long
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.7.2Label Descriptor Details

Properties
  • category
    The label's category.
    Label Descriptor Category
  • description
    The localized description of the object.
    Map of String String
  • features
    The features that this label belongs to.
    Collection of Long
    Feature
  • group
    The group that this label belongs to.
    Long
    Label Descriptor Group
  • id
    A unique identifier for the object.
    Long
  • name
    The localized name of the object.
    Map of String String
  • type
    The type of the label's value.
    Long
    Label Descriptor Type
  • weight
    When listing labels, they can be sorted by this number.
    Integer

4.7.3Label Descriptor Category

Fields
  • HUMAN
    Human
  • APPLICATION
    Application

4.7.4Label Descriptor Group Details

Properties
  • description
    The localized description of the object.
    Map of String String
  • id
    A unique identifier for the object.
    Long
  • name
    The localized name of the object.
    Map of String String
  • weight
    When listing label groups, they can be sorted by this number.
    Integer

4.7.5Label Descriptor Type Details

Properties
  • description
    The localized description of the object.
    Map of String String
  • id
    A unique identifier for the object.
    Long
  • name
    The localized name of the object.
    Map of String String

4.7.6Static Value Details

Properties
  • description
    The localized description of the object.
    Map of String String
  • features
    Collection of Long
    Feature
  • id
    A unique identifier for the object.
    Long
  • name
    The localized name of the object.
    Map of String String

4.8Manual Task

4.8.1Manual Task Details

A manual task requires the manual intervention of a human.

Properties
  • actions
    The actions that can be triggered to handle the manual task.
    Collection of Long
    Manual Task Action
  • contextEntityId
    The ID of the entity the manual task is linked to.
    Long
  • createdOn
    The date and time when the object was created.
    DateTime
  • expiresOn
    The date and time until when the manual task has to be handled.
    DateTime
  • id
    A unique identifier for the object.
    Long
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • plannedPurgeDate
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
    DateTime
  • state
    The object's current state.
    Manual Task State
  • type
    The manual task's type.
    Long
    Manual Task Type

4.8.2Manual Task Action Details

Properties
  • id
    A unique identifier for the object.
    Long
  • label
    The action's label.
    Map of String String
  • style
    The action's style.
    Manual Task Action Style
  • taskType
    The type of manual tasks this action belongs to.
    Long
    Manual Task Type

4.8.3Manual Task Action Style

Fields
  • DEFAULT
    Default
  • PRIMARY
    Primary
  • DANGER
    Danger

4.8.4Manual Task State

Fields
  • OPEN
    Open
  • DONE
    Done
  • EXPIRED
    Expired

4.8.5Manual Task Type Details

The manual task type indicates what kind of manual task is required to be executed by the human.

Properties
  • description
    The localized description of the object.
    Map of String String
  • features
    The features that this type belongs to.
    Collection of Long
    Feature
  • id
    A unique identifier for the object.
    Long
  • name
    The localized name of the object.
    Map of String String

4.9Payment

4.9.1Charge Details

Properties
  • createdOn
    The date on which the charge was created on.
    DateTime
  • failureReason
    Failure Reason
  • id
    A unique identifier for the object.
    Long
  • language
    The language that is linked to the object.
    String
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • plannedPurgeDate
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
    DateTime
  • spaceViewId
    Long
    Space View
  • state
    The object's current state.
    Charge State
  • timeZone
    String
  • timeoutOn
    DateTime
  • transaction
    Transaction
  • type
    Charge Type
  • userFailureMessage
    The failure message describes for an end user why the charge is failed in the language of the user. This is only provided when the charge is marked as failed.
    String
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.9.2Charge Attempt Details

Properties
  • charge
    Charge
  • completionBehavior
    Transaction Completion Behavior
  • connectorConfiguration
    Connector Configuration
  • createdOn
    The date and time when the object was created.
    DateTime
  • customersPresence
    The customers presence indicates which kind of customer interaction was used during the charge attempt.
    Customers Presence
  • environment
    Charge Attempt Environment
  • failedOn
    DateTime
  • failureReason
    Failure Reason
  • id
    A unique identifier for the object.
    Long
  • initializingTokenVersion
    Boolean
  • invocation
    Connector Invocation
  • labels
    Collection of Label
  • language
    The language that is linked to the object.
    String
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • linkedTransaction
    Virtual
    Long
    Transaction
  • nextUpdateOn
    DateTime
  • plannedPurgeDate
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
    DateTime
  • redirectionUrl
    String
  • salesChannel
    Long
    Sales Channel
  • spaceViewId
    Long
    Space View
  • state
    The object's current state.
    Charge Attempt State
  • succeededOn
    DateTime
  • terminal
    Payment Terminal
  • timeZone
    String
  • timeoutOn
    DateTime
  • tokenVersion
    Token Version
  • userFailureMessage
    ≤ 2,000 chars
    The user failure message contains the message for the user in case the attempt failed. The message is localized into the language specified on the transaction.
    String
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer
  • wallet
    Wallet Type

4.9.3Charge Attempt Environment

Fields
  • PRODUCTION
    Production
  • TEST
    Test

4.9.4Charge Attempt State

Fields
  • PROCESSING
    Processing
  • FAILED
    Failed
  • SUCCESSFUL
    Successful

4.9.5Charge Flow Details

Properties
  • conditions
    If a transaction meets all selected conditions, the charge flow will be used to process the transaction. If the conditions are not met the next charge flow in line will be chosen according to the priorities.
    Collection of Long
    Condition
  • id
    A unique identifier for the object.
    Long
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • name
    The charge flow name is used internally to identify the configuration in administrative interfaces. For example it is used within search fields and hence it should be distinct and descriptive.
    String
  • plannedPurgeDate
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
    DateTime
  • priority
    The priority orders the charge flows. As such the priority determines together with the conditions the charge flow the selection mechanism for a particular transaction. A change of the priority affects all future selections.
    Integer
  • state
    The object's current state.
    Creation Entity State
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.9.6Charge Flow Level Details

Properties
  • asynchronousCharge
    Long
    Charge
  • configuration
    Charge Flow Level Configuration
  • createdOn
    The date and time when the object was created.
    DateTime
  • id
    A unique identifier for the object.
    Long
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • linkedTransaction
    Virtual
    Long
    Transaction
  • plannedPurgeDate
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
    DateTime
  • state
    The object's current state.
    Charge Flow Level State
  • synchronousCharge
    Long
    Charge
  • timeoutOn
    DateTime
  • tokenCharge
    Long
    Charge
  • transaction
    Transaction
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.9.7Charge Flow Level Configuration Details

Properties
  • flow
    The charge flow level configuration to which the flow is associated.
    Charge Flow
  • id
    A unique identifier for the object.
    Long
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • name
    ≤ 100 chars
    The charge flow level configuration name is used internally to identify the charge flow level configuration. For example the name is used within search fields and hence it should be distinct and descriptive.
    String
  • period
    The duration of the level before switching to the next one.
    String
  • plannedPurgeDate
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
    DateTime
  • priority
    The priority indicates the sort order of the level configurations. A low value indicates that the level configuration is executed before any level with a higher value. Any change to this value affects future level configuration selections.
    Integer
  • state
    The object's current state.
    Creation Entity State
  • type
    The type determines how the payment link is delivered to the customer. Once the type is defined it cannot be changed anymore.
    Long
    Charge Flow Level Configuration Type
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.9.8Charge Flow Level Configuration Type Details

Properties
  • description
    The localized description of the object.
    Map of String String
  • id
    A unique identifier for the object.
    Long
  • label
    Map of String String
  • name
    The localized name of the object.
    Map of String String

4.9.9Charge Flow Level Payment Link Details

Properties
  • chargeFlowLevel
    Charge Flow Level
  • id
    A unique identifier for the object.
    Long
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • paymentLink
    Virtual
    String

4.9.10Charge Flow Level State

Fields
  • PENDING
    Pending
  • FAILED
    Failed
  • SUCCESSFUL
    Successful

4.9.11Charge State

Fields
  • PENDING
    Pending
  • FAILED
    Failed
  • SUCCESSFUL
    Successful

4.9.12Charge Type

Fields
  • ASYNCHRONOUS
    Asynchronous
  • SYNCHRONOUS
    Synchronous
  • TOKEN
    Token
  • TERMINAL
    Terminal

4.9.13Condition Details

A condition configuration controls under which condition a payment connector is applied to a transaction.

Properties
  • conditionType
    The selected condition type defines how the configuration is applied to the transactions.
    Long
    Condition Type
  • id
    A unique identifier for the object.
    Long
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • name
    ≤ 100 chars
    The condition name is used internally to identify the condition. For example the name is used within search fields and hence it should be distinct and descriptive.
    String
  • plannedPurgeDate
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
    DateTime
  • state
    The object's current state.
    Creation Entity State
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.9.14Condition Type Details

Properties
  • description
    The localized description of the object.
    Map of String String
  • id
    A unique identifier for the object.
    Long
  • name
    The localized name of the object.
    Map of String String

4.9.15Connector Configuration Details

Properties
  • applicableForTransactionProcessing
    Virtual
    This property indicates if the connector is currently used for processing transactions. In case either the payment method configuration or the processor configuration is not active the connector will not be used even though the connector state is active.
    Boolean
  • conditions
    If a transaction meet all selected conditions the connector configuration will be used to process the transaction otherwise the next connector configuration in line will be chosen according to the priorities.
    Collection of Long
    Condition
  • connector
    Long
    Payment Connector
  • enabledSalesChannels
    Defines the sales channels the connector configuration is enabled for. In case the set is empty, the connector configuration is enabled for all sales channels.
    Collection of Sales Channel
  • enabledSpaceViews
    The connector configuration is only enabled for the selected space views. In case the set is empty the connector configuration is enabled for all space views.
    Collection of Long
  • id
    A unique identifier for the object.
    Long
  • imagePath
    String
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • name
    ≤ 100 chars
    The connector configuration name is used internally to identify the configuration in administrative interfaces. For example it is used within search fields and hence it should be distinct and descriptive.
    String
  • paymentMethodConfiguration
    Payment Method Configuration
  • plannedPurgeDate
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
    DateTime
  • priority
    The priority will define the order of choice of the connector configurations. The lower the value, the higher the priority is going to be. This value can also be a negative number in case you are adding a new configuration that you want to have a high priority and you dont want to change the priority of all the other configurations.
    Integer
  • processorConfiguration
    Processor Configuration
  • state
    The object's current state.
    Creation Entity State
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.9.16Connector Invocation Details

Properties
  • createdOn
    The date and time when the object was created.
    DateTime
  • id
    A unique identifier for the object.
    Long
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • plannedPurgeDate
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
    DateTime
  • stage
    Connector Invocation Stage
  • timeTookInMilliseconds
    Long
  • transaction
    Long
    Transaction
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.9.17Connector Invocation Stage

Fields
  • PAYMENT_METHOD_LIST
    Payment Method List
  • FORM_GENERATION
    Form Generation
  • VALIDATION
    Validation
  • AUTHORIZATION
    Authorization

4.9.18Customers Presence

Fields
  • NOT_PRESENT
    Not Present
  • VIRTUAL_PRESENT
    Virtual Present
  • PHYSICAL_PRESENT
    Physical Present

4.9.19Data Collection Type

Fields
  • ONSITE
    Onsite
  • OFFSITE
    Offsite

4.9.20Final Balance Transaction Sums Details

Properties
  • brand
    String
  • dccTipAmount
    Decimal
  • dccTransactionAmount
    Decimal
  • dccTransactionCount
    Integer
  • id
    A unique identifier for the object.
    Long
  • product
    String
  • transactionAmount
    Decimal
  • transactionCount
    Integer
  • transactionCurrency
    String
  • transactionTipAmount
    Decimal
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.9.21One Click Payment Mode

Fields
  • DISABLED
    Disabled
  • ALLOW
    Allow
  • FORCE
    Force

4.9.22Payment Connector Details

Properties

4.9.23Payment Connector Feature Details

Properties
  • displayName
    String
  • feature
    Feature
  • id
    A unique identifier for the object.
    Long

4.9.24Payment Contract Details

Properties
  • account
    Account
  • activatedOn
    DateTime
  • contractIdentifier
    String
  • contractType
    Payment Contract Type
  • createdBy
    User
  • createdOn
    The date and time when the object was created.
    DateTime
  • externalId
    A client generated nonce which identifies the entity to be created. Subsequent creation requests with the same external ID will not create new entities but return the initially created entity instead.
    String
  • id
    A unique identifier for the object.
    Long
  • lastModifiedDate
    The date and time when the object was last modified.
    DateTime
  • rejectedOn
    DateTime
  • rejectionReason
    Failure Reason
  • startTerminatingOn
    DateTime
  • state
    The object's current state.
    Payment Contract State
  • terminatedBy
    User
  • terminatedOn
    DateTime
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.9.25Payment Contract State

Fields
  • PENDING
    Pending
  • ACTIVE
    Active
  • TERMINATING
    Terminating
  • TERMINATED
    Terminated
  • REJECTED
    Rejected

4.9.26Payment Contract Type Details

Properties
  • description
    The localized description of the object.
    Map of String String
  • feature
    Feature
  • id
    A unique identifier for the object.
    Long
  • name
    The localized name of the object.
    Map of String String

4.9.27Payment Information Hash Details

A payment information hash is calculated based on the information entered by the user. The same input leads to the same hash. The hash is collision free.

Properties

4.9.28Payment Information Hash Type Details

Properties
  • id
    A unique identifier for the object.
    Long
  • name
    Map of String String

4.9.29Payment Method Details

Properties
  • dataCollectionTypes
    Collection of Data Collection Type
  • description
    The localized description of the object.
    Map of String String
  • id
    A unique identifier for the object.
    Long
  • imagePath
    String
  • merchantDescription
    Map of String String
  • name
    The localized name of the object.
    Map of String String
  • supportedCurrencies
    Collection of String

4.9.30Payment Method Brand Details

Properties
  • description
    The localized description of the object.
    Map of String String
  • grayImagePath
    String
  • id
    A unique identifier for the object.
    Long
  • imagePath
    String
  • name
    The localized name of the object.
    Map of String String
  • paymentMethod
    Long
    Payment Method

4.9.31Payment Method Configuration Details

The payment method configuration builds the base to connect with different payment method connectors.

Properties
  • dataCollectionType
    The data collection type determines who is collecting the payment information. This can be done either by the processor (offsite) or by our application (onsite).
    Data Collection Type
  • description
    The payment method configuration description can be used to show a text during the payment process. Choose an appropriate description as it will be displayed to your customer.
    Map of String String
  • id
    A unique identifier for the object.
    Long
  • imageResourcePath
    The image of the payment method configuration overrides the default image of the payment method.
    Resource Path
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • name
    ≤ 100 chars
    The payment method configuration name is used internally to identify the payment method configuration. For example the name is used within search fields and hence it should be distinct and descriptive.
    String
  • oneClickPaymentMode
    When the buyer is present on the payment page or within the iFrame the payment details can be stored automatically. The buyer will be able to use the stored payment details for subsequent transactions. When the transaction already contains a token one-click payments are disabled anyway
    One Click Payment Mode
  • paymentMethod
    Long
    Payment Method
  • plannedPurgeDate
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
    DateTime
  • resolvedDescription
    Virtual
    The resolved description uses the specified description or the default one when it is not overridden.
    Map of String String
  • resolvedImageUrl
    Virtual
    The resolved URL of the image to use with this payment method.
    String
  • resolvedTitle
    Virtual
    The resolved title uses the specified title or the default one when it is not overridden.
    Map of String String
  • sortOrder
    The sort order of the payment method determines the ordering of the methods shown to the user during the payment process.
    Integer
  • spaceId
    ≥ 1
    Long
  • state
    The object's current state.
    Creation Entity State
  • title
    The title of the payment method configuration is used within the payment process. The title is visible to the customer.
    Map of String String
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.9.32Payment Processor Details

Properties
  • companyName
    Map of String String
  • description
    The localized description of the object.
    Map of String String
  • feature
    Long
    Feature
  • headquartersLocation
    Map of String String
  • id
    A unique identifier for the object.
    Long
  • logoPath
    String
  • name
    The localized name of the object.
    Map of String String
  • productName
    Map of String String

4.9.33Payment Terminal Details

Properties
  • configurationVersion
    Payment Terminal Configuration Version
  • defaultCurrency
    Virtual
    String
  • deviceSerialNumber
    String
  • externalId
    A client generated nonce which identifies the entity to be created. Subsequent creation requests with the same external ID will not create new entities but return the initially created entity instead.
    String
  • id
    A unique identifier for the object.
    Long
  • identifier
    The identifier uniquely identifies the terminal. Normally it is visible on the device or in the display of the device.
    String
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • locationVersion
    Payment Terminal Location Version
  • name
    ≤ 100 chars
    The terminal name is used internally to identify the terminal in administrative interfaces. For example it is used within search fields and hence it should be distinct and descriptive.
    String
  • plannedPurgeDate
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
    DateTime
  • state
    The object's current state.
    Payment Terminal State
  • type
    Payment Terminal Type
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.9.34Payment Terminal Address Details

Properties
  • city
    The city, town or village.
    String
  • country
    The two-letter country code (ISO 3166 format).
    String
  • dependentLocality
    ≤ 100 chars
    The dependent locality which is a sub-division of the state.
    String
  • emailAddress
    Email
    ≤ 254 chars
    The email address.
    String
  • familyName
    The family or last name.
    String
  • givenName
    The given or first name.
    String
  • mobilePhoneNumber
    ≤ 100 chars
    The phone number of a mobile phone.
    String
  • organizationName
    The organization's name.
    String
  • phoneNumber
    The phone number.
    String
  • postalState
    The name of the region, typically a state, county, province or prefecture.
    String
  • postcode
    The postal code, also known as ZIP, postcode, etc.
    String
  • salutation
    ≤ 20 chars
    The salutation e.g. Mrs, Mr, Dr.
    String
  • sortingCode
    ≤ 100 chars
    The sorting code identifying the post office where the PO Box is located.
    String
  • street
    The street or PO Box.
    String

4.9.35Payment Terminal Configuration Details

Properties
  • id
    A unique identifier for the object.
    Long
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • name
    ≤ 100 chars
    The terminal configuration name is used internally to identify the terminal in administrative interfaces. For example it is used within search fields and hence it should be distinct and descriptive.
    String
  • plannedPurgeDate
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
    DateTime
  • state
    The object's current state.
    Payment Terminal Configuration State
  • type
    Payment Terminal Type
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.9.36Payment Terminal Configuration State

Fields
  • CREATE
    Create
  • ACTIVE
    Active
  • DELETING
    Deleting
  • DELETED
    Deleted

4.9.37Payment Terminal Configuration Version Details

Properties
  • configuration
    Payment Terminal Configuration
  • connectorConfigurations
    Collection of Long
    Connector Configuration
  • createdBy
    Long
  • createdOn
    The date and time when the object was created.
    DateTime
  • defaultCurrency
    The currency is derived by default from the terminal location. By setting a specific currency the derived currency is overridden.
    String
  • id
    A unique identifier for the object.
    Long
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • maintenanceWindowDuration
    String
  • maintenanceWindowStart
    String
  • plannedPurgeDate
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
    DateTime
  • state
    The object's current state.
    Payment Terminal Configuration Version State
  • timeZone
    String
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer
  • versionAppliedImmediately
    Boolean

4.9.38Payment Terminal Configuration Version State

Fields
  • PENDING
    Pending
  • SCHEDULING
    Scheduling
  • ACTIVE
    Active
  • DELETING
    Deleting
  • DELETED
    Deleted

4.9.39Payment Terminal Location Details

Properties
  • externalId
    A client generated nonce which identifies the entity to be created. Subsequent creation requests with the same external ID will not create new entities but return the initially created entity instead.
    String
  • id
    A unique identifier for the object.
    Long
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • name
    ≤ 100 chars
    The terminal location name is used internally to identify the terminal in administrative interfaces. For example it is used within search fields and hence it should be distinct and descriptive.
    String
  • plannedPurgeDate
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
    DateTime
  • state
    The object's current state.
    Payment Terminal Location State
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.9.40Payment Terminal Location State

Fields
  • CREATE
    Create
  • ACTIVE
    Active
  • DELETING
    Deleting
  • DELETED
    Deleted

4.9.41Payment Terminal Location Version Details

Properties
  • address
    Payment Terminal Address
  • contactAddress
    Payment Terminal Address
  • createdBy
    Long
  • createdOn
    The date and time when the object was created.
    DateTime
  • id
    A unique identifier for the object.
    Long
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • location
    Payment Terminal Location
  • plannedPurgeDate
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
    DateTime
  • state
    The object's current state.
    Payment Terminal Location Version State
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer
  • versionAppliedImmediately
    Boolean

4.9.42Payment Terminal Location Version State

Fields
  • PENDING
    Pending
  • SCHEDULING
    Scheduling
  • ACTIVE
    Active
  • DELETING
    Deleting
  • DELETED
    Deleted

4.9.43Payment Terminal Receipt Type Details

Properties
  • description
    The localized description of the object.
    Map of String String
  • id
    A unique identifier for the object.
    Long
  • name
    The localized name of the object.
    Map of String String

4.9.44Payment Terminal State

Fields
  • CREATE
    Create
  • PREPARING
    Preparing
  • ACTIVE
    Active
  • INACTIVE
    Inactive
  • DECOMMISSIONING
    Decommissioning
  • DECOMMISSIONED
    Decommissioned

4.9.45Payment Terminal Type Details

Properties
  • description
    The localized description of the object.
    Map of String String
  • id
    A unique identifier for the object.
    Long
  • name
    The localized name of the object.
    Map of String String

4.9.46Primary Risk Taker

The primary risk taker will have the main loss when one party of the contract does not fulfill the contractual duties.

Fields
  • CUSTOMER
    Customer
  • MERCHANT
    Merchant
  • THIRD_PARTY
    Third Party

4.9.47Processor Configuration Details

Properties
  • applicationManaged
    The configuration is managed by the application and cannot be changed via the user interface.
    Boolean
  • contractId
    The contract links the processor configuration with the contract that is used to process payments.
    Long
    Payment Contract
  • id
    A unique identifier for the object.
    Long
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • name
    ≤ 100 chars
    The processor configuration name is used internally to identify a specific processor configuration. For example the name is used within search fields and hence it should be distinct and descriptive.
    String
  • plannedPurgeDate
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
    DateTime
  • processor
    A processor handles the connection to a third part company (a Payment Service Provider) that technically manages the transaction and therefore processes the payment. For the same processor multiple processor configuration can be setup.
    Long
    Payment Processor
  • state
    The object's current state.
    Creation Entity State
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.9.48Receipt Format

Fields
  • PDF
    Pdf
  • TXT
    Txt

4.9.49Refund Details

The refund represents a credit back to the customer. It can be issued by the merchant or by the customer (reversal).

Properties
  • amount
    Decimal
  • baseLineItems
    Collection of Line Item
  • completion
    Long
    Transaction Completion
  • createdBy
    Long
    User
  • createdOn
    The date and time when the object was created.
    DateTime
  • environment
    Environment
  • externalId
    1 - 100 chars
    The external id helps to identify duplicate calls to the refund service. As such the external ID has to be unique per transaction.
    String
  • failedOn
    DateTime
  • failureReason
    Failure Reason
  • id
    A unique identifier for the object.
    Long
  • labels
    Collection of Label
  • language
    The language that is linked to the object.
    String
  • lineItems
    Virtual
    Collection of Line Item
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • merchantReference
    ≤ 100 chars
    String
  • nextUpdateOn
    DateTime
  • plannedPurgeDate
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
    DateTime
  • processingOn
    DateTime
  • processorReference
    ≤ 150 chars
    String
  • reducedLineItems
    Collection of Line Item
  • reductions
    Collection of Line Item Reduction
  • state
    The object's current state.
    Refund State
  • succeededOn
    DateTime
  • taxes
    Collection of Tax
  • timeZone
    String
  • timeoutOn
    DateTime
  • totalAppliedFees
    The total applied fees is the sum of all fees that have been applied so far.
    Decimal
  • totalSettledAmount
    The total settled amount is the total amount which has been settled so far.
    Decimal
  • transaction
    Transaction
  • type
    Refund Type
  • updatedInvoice
    Long
    Transaction Invoice
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.9.50Refund Comment Details

Properties
  • content
    ≤ 262,144 chars
    The comment's actual content.
    String
  • createdBy
    The ID of the user the comment was created by.
    Long
    User
  • createdOn
    The date and time when the object was created.
    DateTime
  • editedBy
    The ID of the user the comment was last updated by.
    Long
    User
  • editedOn
    The date and time when the comment was last updated.
    DateTime
  • id
    A unique identifier for the object.
    Long
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • pinned
    Whether the comment is pinned to the top.
    Boolean
  • refund
    Long
    Refund
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.9.51Refund State

Fields
  • CREATE
    Create
  • SCHEDULED
    Scheduled
  • PENDING
    Pending
  • MANUAL_CHECK
    Manual Check
  • FAILED
    Failed
  • SUCCESSFUL
    Successful

4.9.52Refund Type

Fields
  • MERCHANT_INITIATED_ONLINE
    Merchant Initiated Online
  • MERCHANT_INITIATED_OFFLINE
    Merchant Initiated Offline
  • CUSTOMER_INITIATED_AUTOMATIC
    Customer Initiated Automatic
  • CUSTOMER_INITIATED_MANUAL
    Customer Initiated Manual

4.9.53Rendered Terminal Receipt Details

Properties
  • data
    The data property contains the binary data of the receipt document encoded as base 64 encoded string.
    Collection of Byte
  • mimeType
    The mime type indicates the format of the receipt document. The mime type depends on the requested receipt format.
    String
  • printed
    The terminal might or might not print the receipt. This property is set to true when the configuration of the terminal forces the printing and the device supports the receipt printing.
    Boolean
  • receiptType
    Each receipt has a different usage. The receipt type indicates for what resp. for whom the document is for.
    Payment Terminal Receipt Type

4.9.54Rendered Terminal Transaction Summary Details

Properties
  • data
    The data property contains the binary data of the receipt document encoded as base 64 encoded string.
    Collection of Byte
  • mimeType
    The mime type indicates the format of the receipt document. The mime type depends on the requested receipt format.
    String

4.9.55Sales Channel Details

Properties
  • description
    The localized description of the object.
    Map of String String
  • icon
    String
  • id
    A unique identifier for the object.
    Long
  • name
    The localized name of the object.
    Map of String String
  • parent
    Sales Channel
  • sortOrder
    Integer

4.9.56Terminal Receipt Fetch Request Details

The receipt fetch request allows to retrieve the receipt documents for a terminal transaction.

Properties
  • format
    *
    The format determines in what format the receipt will be returned in.
    Receipt Format
  • summaryId
    *
    The id of the transaction summary receipt whose content should be returned.
    Long
  • width
    The width controls how width the document will be rendered. In case of the PDF format the width is in mm. In case of the text format the width is in the number of chars per line.
    Integer

4.9.57Terminal Receipt Fetch Request Details

The receipt fetch request allows to retrieve the receipt documents for a terminal transaction.

Properties
  • format
    *
    The format determines in what format the receipts will be returned in.
    Receipt Format
  • transaction
    *
    Provide here the ID of the transaction for which the receipts should be fetched.
    Long
    Transaction
  • width
    The width controls how width the document will be rendered. In case of the PDF format the width is in mm. In case of the text format the width is in the number of chars per line.
    Integer

4.9.58Token Details

Properties
  • createdOn
    The date and time when the object was created.
    DateTime
  • customerEmailAddress
    ≤ 150 chars
    The customer email address is the email address of the customer.
    String
  • customerId
    The customer ID identifies the customer in the merchant system. In case the customer ID has been provided it has to correspond with the customer ID provided on the transaction. The customer ID will not be changed automatically. The merchant system has to provide it.
    String
  • enabledForOneClickPayment
    When a token is enabled for one-click payments the buyer will be able to select the token within the iFrame or on the payment page to pay with the token. The usage of the token will reduce the number of steps the buyer has to go through. The buyer is linked via the customer ID on the transaction with the token. Means the token will be visible for buyers with the same customer ID. Additionally the payment method has to be configured to allow the one-click payments.
    Boolean
  • externalId
    A client generated nonce which identifies the entity to be created. Subsequent creation requests with the same external ID will not create new entities but return the initially created entity instead.
    String
  • id
    A unique identifier for the object.
    Long
  • language
    The language that is linked to the object.
    String
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • plannedPurgeDate
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
    DateTime
  • state
    The object's current state.
    Creation Entity State
  • timeZone
    The time zone defines in which time zone the customer is located in. The time zone may affects how dates are formatted when interacting with the customer.
    String
  • tokenReference
    ≤ 100 chars
    Use something that it is easy to identify and may help you find the token (e.g. customer id, email address).
    String
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.9.59Token Version Details

Properties
  • activatedOn
    DateTime
  • billingAddress
    Address
  • createdOn
    The date and time when the object was created.
    DateTime
  • environment
    Charge Attempt Environment
  • expiresOn
    The expires on date indicates when token version expires. Once this date is reached the token version is marked as obsolete.
    DateTime
  • iconUrl
    Virtual
    String
  • id
    A unique identifier for the object.
    Long
  • labels
    Collection of Label
  • language
    Virtual
    The language that is linked to the object.
    String
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • name
    ≤ 150 chars
    String
  • obsoletedOn
    DateTime
  • paymentConnectorConfiguration
    Connector Configuration
  • paymentInformationHashes
    The payment information hash set contains hashes of the payment information represented by this token version.
    Collection of Payment Information Hash
  • paymentMethod
    Long
    Payment Method
  • paymentMethodBrand
    Long
    Payment Method Brand
  • plannedPurgeDate
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
    DateTime
  • processorToken
    ≤ 150 chars
    String
  • shippingAddress
    Address
  • state
    The object's current state.
    Token Version State
  • token
    Token
  • type
    The token version type determines what kind of token it is and by which payment connector the token can be processed by.
    Token Version Type
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.9.60Token Version State

Fields
  • UNINITIALIZED
    Uninitialized
  • ACTIVE
    Active
  • OBSOLETE
    Obsolete

4.9.61Token Version Type Details

Properties
  • description
    The localized description of the object.
    Map of String String
  • feature
    Feature
  • id
    A unique identifier for the object.
    Long
  • name
    The localized name of the object.
    Map of String String

4.9.62Tokenization Mode

The tokenization mode controls how the tokenization of payment information is applied on the transaction.

Fields
  • FORCE_UPDATE
    Force Update
  • FORCE_CREATION
    Force Creation
  • FORCE_CREATION_WITH_ONE_CLICK_PAYMENT
    Force Creation With One Click Payment
  • ALLOW_ONE_CLICK_PAYMENT
    Allow One Click Payment

4.9.63Transaction Details

Properties
  • acceptHeader
    String
  • acceptLanguageHeader
    The accept language contains the header which indicates the language preferences of the buyer.
    String
  • allowedPaymentMethodBrands
    Collection of Long
    Payment Method Brand
  • allowedPaymentMethodConfigurations
    Collection of Long
    Payment Method Configuration
  • authorizationAmount
    Decimal
  • authorizationEnvironment
    The environment in which this transaction was successfully authorized.
    Charge Attempt Environment
  • authorizationSalesChannel
    The sales channel through which the transaction was placed.
    Long
    Sales Channel
  • authorizationTimeoutOn
    This is the time on which the transaction will be timed out when it is not at least authorized. The timeout time may change over time.
    DateTime
  • authorizedOn
    DateTime
  • autoConfirmationEnabled
    When auto confirmation is enabled the transaction can be confirmed by the user and does not require an explicit confirmation through the web service API.
    Boolean
  • billingAddress
    Address
  • chargeRetryEnabled
    When the charging of the customer fails we can retry the charging. This implies that we redirect the user back to the payment page which allows the customer to retry. By default we will retry.
    Boolean
  • completedAmount
    The completed amount is the total amount which has been captured so far.
    Decimal
  • completedOn
    DateTime
  • completionBehavior
    The completion behavior controls when the transaction is completed.
    Transaction Completion Behavior
  • completionTimeoutOn
    DateTime
  • confirmedBy
    Long
  • confirmedOn
    DateTime
  • createdBy
    Long
  • createdOn
    The date and time when the object was created.
    DateTime
  • currency
    String
  • customerEmailAddress
    ≤ 254 chars
    The customer email address is the email address of the customer. If no email address is provided on the shipping or billing address this address is used.
    String
  • customerId
    String
  • customersPresence
    The customer's presence indicates what kind of authentication method was finally used during authorization of the transaction. If no value is provided, 'Virtually Present' is used by default.
    Customers Presence
  • deliveryDecisionMadeOn
    This date indicates when the decision has been made if a transaction should be delivered or not.
    DateTime
  • deviceSessionIdentifier
    10 - 40 chars
    ([[a-z][A-Z][0-9]-_])*
    The device session identifier links the transaction with the session identifier provided in the URL of the device data JavaScript. This allows to link the transaction with the collected device data of the buyer.
    String
  • emailsDisabled
    Flag indicating whether email sending is disabled for this particular transaction. Defaults to false.
    Boolean
  • endOfLife
    The transaction's end of life indicates the date from which on no operation can be carried out anymore.
    DateTime
  • environment
    Environment
  • environmentSelectionStrategy
    The environment selection strategy determines how the environment (test or production) for processing the transaction is selected.
    Transaction Environment Selection Strategy
  • failedOn
    DateTime
  • failedUrl
    9 - 2,000 options
    URL
    Virtual
    The user will be redirected to failed URL when the transaction could not be authorized or completed. In case no failed URL is specified a default failed page will be displayed.
    String
  • failureReason
    The failure reason describes why the transaction failed. This is only provided when the transaction is marked as failed.
    Failure Reason
  • group
    Transaction Group
  • id
    A unique identifier for the object.
    Long
  • internetProtocolAddress
    The Internet Protocol (IP) address identifies the device of the buyer.
    String
  • internetProtocolAddressCountry
    String
  • invoiceMerchantReference
    ≤ 100 chars
    String
  • javaEnabled
    Boolean
  • language
    The language that is linked to the object.
    String
  • lineItems
    Collection of Line Item
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • merchantReference
    ≤ 100 chars
    String
  • metaData
    Virtual
    Allow to store additional information about the object.
    Map of String String
  • parent
    Long
    Transaction
  • paymentConnectorConfiguration
    Connector Configuration
  • plannedPurgeDate
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
    DateTime
  • processingOn
    DateTime
  • refundedAmount
    The refunded amount is the total amount which has been refunded so far.
    Decimal
  • screenColorDepth
    String
  • screenHeight
    String
  • screenWidth
    String
  • shippingAddress
    Address
  • shippingMethod
    ≤ 200 chars
    String
  • spaceViewId
    Long
    Space View
  • state
    The object's current state.
    Transaction State
  • successUrl
    9 - 2,000 options
    URL
    Virtual
    The user will be redirected to success URL when the transaction could be authorized or completed. In case no success URL is specified a default success page will be displayed.
    String
  • terminal
    The terminal on which the payment was processed.
    Payment Terminal
  • timeZone
    The time zone defines in which time zone the customer is located in. The time zone may affects how dates are formatted when interacting with the customer.
    String
  • token
    Token
  • tokenizationMode
    The tokenization mode controls if and how the tokenization of payment information is applied to the transaction.
    Tokenization Mode
  • totalAppliedFees
    The total applied fees is the sum of all fees that have been applied so far.
    Decimal
  • totalSettledAmount
    The total settled amount is the total amount which has been settled so far.
    Decimal
  • userAgentHeader
    The user agent header provides the exact string which contains the user agent of the buyer.
    String
  • userFailureMessage
    The failure message describes for an end user why the transaction is failed in the language of the user. This is only provided when the transaction is marked as failed.
    String
  • userInterfaceType
    The user interface type defines through which user interface the transaction has been processed resp. created.
    Transaction User Interface Type
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer
  • windowHeight
    String
  • windowWidth
    String
  • yearsToKeep
    The number of years the transaction will be stored after it has been authorized.
    Integer

4.9.64Transaction Aware Entity Details

Properties
  • id
    A unique identifier for the object.
    Long
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • linkedTransaction
    Virtual
    Long
    Transaction

4.9.65Transaction Comment Details

Properties
  • content
    ≤ 262,144 chars
    The comment's actual content.
    String
  • createdBy
    The ID of the user the comment was created by.
    Long
    User
  • createdOn
    The date and time when the object was created.
    DateTime
  • editedBy
    The ID of the user the comment was last updated by.
    Long
    User
  • editedOn
    The date and time when the comment was last updated.
    DateTime
  • id
    A unique identifier for the object.
    Long
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • pinned
    Whether the comment is pinned to the top.
    Boolean
  • transaction
    Long
    Transaction
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.9.66Transaction Completion Details

Properties
  • amount
    The amount which is captured. The amount represents sum of line items including taxes.
    Decimal
  • baseLineItems
    The base line items on which the completion is applied on.
    Collection of Line Item
  • createdBy
    Long
  • createdOn
    The date and time when the object was created.
    DateTime
  • externalId
    1 - 100 chars
    The external ID helps to identify the entity and a subsequent creation of an entity with the same ID will not create a new entity.
    String
  • failedOn
    DateTime
  • failureReason
    Failure Reason
  • id
    A unique identifier for the object.
    Long
  • invoiceMerchantReference
    ≤ 100 chars
    String
  • labels
    Collection of Label
  • language
    The language that is linked to the object.
    String
  • lastCompletion
    Indicates if this is the last completion. After the last completion is created the transaction cannot be completed anymore.
    Boolean
  • lineItemVersion
    Transaction Line Item Version
  • lineItems
    The line items which are captured.
    Collection of Line Item
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • linkedTransaction
    Virtual
    Long
    Transaction
  • mode
    Transaction Completion Mode
  • nextUpdateOn
    DateTime
  • paymentInformation
    String
  • plannedPurgeDate
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
    DateTime
  • processingOn
    DateTime
  • processorReference
    String
  • remainingLineItems
    Virtual
    Collection of Line Item
  • spaceViewId
    Long
    Space View
  • state
    The object's current state.
    Transaction Completion State
  • statementDescriptor
    ≤ 80 options
    [a-zA-Z0-9\s\.\,\_\-\?\+\/]*
    The statement descriptor explain charges or payments on bank statements.
    String
  • succeededOn
    DateTime
  • taxAmount
    The total sum of all taxes of line items.
    Decimal
  • timeZone
    String
  • timeoutOn
    DateTime
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.9.67Transaction Completion Behavior

Fields
  • COMPLETE_IMMEDIATELY
    Complete Immediately
  • COMPLETE_DEFERRED
    Complete Deferred
  • USE_CONFIGURATION
    Use Configuration

4.9.68Transaction Completion Mode

Fields
  • DIRECT
    Direct
  • ONLINE
    Online
  • OFFLINE
    Offline

4.9.69Transaction Completion State

Fields
  • CREATE
    Create
  • SCHEDULED
    Scheduled
  • PENDING
    Pending
  • FAILED
    Failed
  • SUCCESSFUL
    Successful

4.9.70Transaction Environment Selection Strategy

Fields
  • FORCE_TEST_ENVIRONMENT
    Force Test Environment
  • FORCE_PRODUCTION_ENVIRONMENT
    Force Production Environment
  • USE_CONFIGURATION
    Use Configuration

4.9.71Transaction Group Details

Properties
  • beginDate
    DateTime
  • customerId
    ≤ 100 chars
    String
  • endDate
    DateTime
  • id
    A unique identifier for the object.
    Long
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • plannedPurgeDate
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
    DateTime
  • state
    The object's current state.
    Transaction Group State
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.9.72Transaction Group State

Fields
  • PENDING
    Pending
  • FAILED
    Failed
  • SUCCESSFUL
    Successful

4.9.73Transaction Invoice Details

The transaction invoice represents the invoice document for a particular transaction.

Properties
  • amount
    Decimal
  • billingAddress
    Address
  • completion
    Transaction Completion
  • createdOn
    The date on which the invoice is created on.
    DateTime
  • derecognizedBy
    The id of the user which marked the invoice as derecognized.
    Long
  • derecognizedOn
    The date on which the invoice is marked as derecognized.
    DateTime
  • dueOn
    The date on which the invoice should be paid on.
    DateTime
  • environment
    Environment
  • externalId
    1 - 100 chars
    The external id helps to identify the entity and a subsequent creation of an entity with the same ID will not create a new entity.
    String
  • id
    A unique identifier for the object.
    Long
  • language
    The language that is linked to the object.
    String
  • lineItems
    Collection of Line Item
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • linkedTransaction
    Virtual
    Long
    Transaction
  • merchantReference
    ≤ 100 chars
    String
  • outstandingAmount
    The outstanding amount indicates how much the buyer owes the merchant. A negative amount indicates that the invoice is overpaid.
    Decimal
  • paidOn
    The date on which the invoice is marked as paid. Eventually this date lags behind of the actual paid date.
    DateTime
  • plannedPurgeDate
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
    DateTime
  • spaceViewId
    Long
    Space View
  • state
    The object's current state.
    Transaction Invoice State
  • taxAmount
    Decimal
  • timeZone
    String
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.9.74Transaction Invoice Comment Details

Properties
  • content
    ≤ 262,144 chars
    The comment's actual content.
    String
  • createdBy
    The ID of the user the comment was created by.
    Long
    User
  • createdOn
    The date and time when the object was created.
    DateTime
  • editedBy
    The ID of the user the comment was last updated by.
    Long
    User
  • editedOn
    The date and time when the comment was last updated.
    DateTime
  • id
    A unique identifier for the object.
    Long
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • pinned
    Whether the comment is pinned to the top.
    Boolean
  • transactionInvoice
    Long
    Transaction Invoice
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.9.75Transaction Invoice Replacement Details

Properties
  • billingAddress
    Address in Create State Create
  • dueOn
    The date on which the invoice should be paid on.
    DateTime
  • externalId
    *
    1 - 100 chars
    The external id helps to identify the entity and a subsequent creation of an entity with the same ID will not create a new entity.
    String
  • lineItems
    *
    Collection of Line Item Create
  • merchantReference
    ≤ 100 chars
    String
  • sentToCustomer
    When the connector is configured to send the invoice to the customer and this property is true the customer will receive an email with the updated invoice. When this property is false no invoice is sent.
    Boolean

4.9.76Transaction Invoice State

Fields
  • CREATE
    Create
  • OPEN
    Open
  • OVERDUE
    Overdue
  • CANCELED
    Canceled
  • PAID
    Paid
  • DERECOGNIZED
    Derecognized
  • NOT_APPLICABLE
    Not Applicable

4.9.77Transaction Line Item Version Details

Properties
  • amount
    Decimal
  • createdBy
    Long
  • createdOn
    The date and time when the object was created.
    DateTime
  • externalId
    A client generated nonce which identifies the entity to be created. Subsequent creation requests with the same external ID will not create new entities but return the initially created entity instead.
    String
  • failedOn
    DateTime
  • failureReason
    Failure Reason
  • id
    A unique identifier for the object.
    Long
  • labels
    Collection of Label
  • language
    The language that is linked to the object.
    String
  • lineItems
    Collection of Line Item
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • linkedTransaction
    Virtual
    Long
    Transaction
  • nextUpdateOn
    DateTime
  • plannedPurgeDate
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
    DateTime
  • processingOn
    DateTime
  • spaceViewId
    Long
    Space View
  • state
    The object's current state.
    Transaction Line Item Version State
  • succeededOn
    DateTime
  • taxAmount
    Decimal
  • timeoutOn
    DateTime
  • transaction
    Transaction
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.9.78Transaction Line Item Version . Create Details

Properties
  • externalId
    *
    A client generated nonce which identifies the entity to be created. Subsequent creation requests with the same external ID will not create new entities but return the initially created entity instead.
    String
  • lineItems
    *
    Collection of Line Item Create
  • transaction
    *
    ID of Transaction

4.9.79Transaction Line Item Version State

Fields
  • CREATE
    Create
  • SCHEDULED
    Scheduled
  • PENDING
    Pending
  • SUCCESSFUL
    Successful
  • FAILED
    Failed

4.9.80Transaction State

Fields
  • CREATE
    Create
  • PENDING
    Pending
  • CONFIRMED
    Confirmed
  • PROCESSING
    Processing
  • FAILED
    Failed
  • AUTHORIZED
    Authorized
  • VOIDED
    Voided
  • COMPLETED
    Completed
  • FULFILL
    Fulfill
  • DECLINE
    Decline

4.9.81Transaction Summary DCC Transaction Sums Details

Properties
  • brand
    String
  • dccAmount
    Decimal
  • dccCurrency
    String
  • id
    A unique identifier for the object.
    Long
  • transactionAmount
    Decimal
  • transactionCount
    Integer
  • transactionCurrency
    String
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.9.82Transaction User Interface Type

Fields
  • IFRAME
    Iframe
  • LIGHTBOX
    Lightbox
  • PAYMENT_PAGE
    Payment Page
  • MOBILE_SDK
    Mobile Sdk
  • TERMINAL
    Terminal

4.9.83Transaction summary Details

Properties

4.9.84Wallet Type Details

Properties
  • description
    The localized description of the object.
    Map of String String
  • id
    A unique identifier for the object.
    Long
  • name
    The localized name of the object.
    Map of String String

4.10Tax

4.10.1Tax Details

Properties
  • rate
    ≤ 100
    Decimal
  • title
    2 - 40 chars
    String

4.11User

4.11.1Application User Details

Properties
  • id
    A unique identifier for the object.
    Long
  • name
    ≤ 256 chars
    The name used to identify the application user.
    String
  • plannedPurgeDate
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
    DateTime
  • primaryAccount
    The primary account that the user belongs to.
    Long
    Account
  • requestLimit
    The maximum number of API requests that are accepted every 2 minutes.
    Long
  • scope
    The scope that the user belongs to.
    Long
    Scope
  • state
    The object's current state.
    Creation Entity State
  • userType
    Virtual
    The user's type which defines its role and capabilities.
    User Type
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.11.2Human User Details

Properties
  • emailAddress
    Email
    ≤ 128 chars
    The user's email address.
    String
  • emailAddressVerified
    Whether the user's email address has been verified.
    Boolean
  • firstname
    ≤ 100 chars
    The user's first name.
    String
  • id
    A unique identifier for the object.
    Long
  • language
    The user's preferred language.
    String
  • lastname
    ≤ 100 chars
    The user's last name.
    String
  • mobilePhoneNumber
    ≤ 30 chars
    The user's mobile phone number.
    String
  • mobilePhoneVerified
    Whether the user's mobile phone number has been verified.
    Boolean
  • plannedPurgeDate
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
    DateTime
  • primaryAccount
    The primary account that the user belongs to.
    Long
    Account
  • scope
    The scope that the user belongs to.
    Long
    Scope
  • state
    The object's current state.
    Creation Entity State
  • timeZone
    The user's time zone. If none is specified, the one provided by the browser will be used.
    String
  • twoFactorEnabled
    Whether two-factor authentication is enabled for this user.
    Boolean
  • twoFactorType
    The type of two-factor authentication that is enabled for the user.
    Two Factor Authentication Type
  • userType
    Virtual
    The user's type which defines its role and capabilities.
    User Type
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.11.3Permission Details

Properties
  • description
    The localized description of the object.
    Map of String String
  • feature
    The feature that this permission belongs to.
    Long
    Feature
  • group
    Whether this is a permission group.
    Boolean
  • id
    A unique identifier for the object.
    Long
  • leaf
    Whether this is a leaf in the tree of permissions, and not a group.
    Boolean
  • name
    The localized name of the object.
    Map of String String
  • parent
    The group that this permission belongs to.
    Long
    Permission
  • pathToRoot
    All parents of this permission up to the root of the permission tree.
    Collection of Long
    Permission
  • title
    The localized name of the object.
    Map of String String
  • twoFactorRequired
    Whether users with this permission are required to enable two-factor authentication.
    Boolean
  • webAppEnabled
    Boolean

4.11.4Role Details

Properties
  • account
    The account the role belongs to. The role can only be assigned within this account.
    Account
  • id
    A unique identifier for the object.
    Long
  • name
    The name used to identify the role.
    Map of String String
  • permissions
    The permissions granted to users with this role.
    Collection of Permission
  • plannedPurgeDate
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
    DateTime
  • state
    The object's current state.
    Role State
  • twoFactorRequired
    Whether users with this role are required to use two-factor authentication.
    Boolean
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.11.5Role State

Fields
  • CREATE
    Create
  • ACTIVE
    Active
  • DELETING
    Deleting
  • DELETED
    Deleted

4.11.6Two Factor Authentication Type Details

Properties
  • description
    The localized description of the object.
    Map of String String
  • feature
    The feature that this type belongs to.
    Long
    Feature
  • icon
    The identifier of the icon representing this type.
    String
  • id
    A unique identifier for the object.
    Long
  • name
    The localized name of the object.
    Map of String String

4.11.7User Details

Properties
  • id
    A unique identifier for the object.
    Long
  • plannedPurgeDate
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
    DateTime
  • scope
    The scope that the user belongs to.
    Long
    Scope
  • state
    The object's current state.
    Creation Entity State
  • userType
    Virtual
    The user's type which defines its role and capabilities.
    User Type
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.11.8User Account Role Details

Properties
  • account
    Long
    Account
  • appliesOnSubAccount
    Boolean
  • id
    A unique identifier for the object.
    Long
  • role
    Long
    Role
  • user
    Long
    User
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.11.9User Space Role Details

Properties
  • id
    A unique identifier for the object.
    Long
  • role
    Long
    Role
  • space
    Long
    Space
  • user
    Long
    User
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.11.10User Type

Fields
  • HUMAN_USER
    Human User
  • SINGLE_SIGNON_USER
    Single Signon User
  • APPLICATION_USER
    Application User
  • ANONYMOUS_USER
    Anonymous User
  • SERVER_USER
    Server User

4.12Webhook

4.12.1Webhook Encryption Public Key Details

The webhook encryption public key is used to verify the webhook content signature.

Properties
  • id
    The ID of encryption key
    String
  • publicKey
    The BASE64 encoded public key
    String