Documentation
Documentation
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.1Core

3.1.1Account Service

3.1.1.1Count

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.2Update

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

POST /api/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.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.4Delete

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.1.5Read

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.6Search

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.2Analytics Query Execution Service

3.1.2.1Fetch Result

Fetches one batch of the result of a query execution.

GET /api/analytics-query/fetch-result View in Client
Query Parameters
  • id
    *
    The ID of the query execution for which to fetch the result.
    Long
  • timeout
    The maximal time in seconds to wait for the result if it is not yet available. Use 0 (the default) to return immediately without waiting.
    Integer
  • maxRows
    The maximum number of rows to return per batch. (Between 1 and 999. The default is 999.)
    Integer
  • nextToken
    The next-token of the preceding batch to get the next result batch or null to get the first result batch.
    String
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Query Result Batch
  • 442
    Error
    This 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.2Execution Status

Returns the current status of a query execution.

GET /api/analytics-query/status View in Client
Query Parameters
  • id
    *
    The ID of the query execution for which to get the status.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Query Execution
  • 442
    Error
    This 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.3Submit Query

Submits a query for execution.

POST /api/analytics-query/submit-query View in Client
Message Body *
The query to submit.
Analytics Query
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Query Execution
  • 442
    Error
    This 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.4Get Schemas

Get the schemas describing the available tables and their columns.

GET /api/analytics-query/schema View in Client
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Analytics Schema Info
  • 442
    Error
    This 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.5Cancel Execution

Cancels the specified query execution.

POST /api/analytics-query/cancel-execution View in Client
Query Parameters
  • id
    *
    The ID of the query execution to cancel.
    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.1.2.6Generate Download URL

Generate a URL from which the results of a query execution can be downloaded in CSV format.

GET /api/analytics-query/generate-download-url View in Client
Query Parameters
  • id
    *
    The ID of the query execution for which to generate the download URL.
    Long
  • timeout
    The maximal time in seconds to wait for the result if it is not yet available. Use 0 (the default) to return immediately without waiting.
    Integer
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.1.3Metric Usage Service

The metric usage service allows to query used resources.

3.1.3.1Calculate

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

POST /api/mertic-usage/calculate View in Client
Query Parameters
  • spaceId
    *
    Long
  • start
    *
    The start date from which on the consumed units should be returned from.
    DateTime
  • end
    *
    The end date to which the consumed units should be returned to. The end date is not included in the result.
    DateTime
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Metric Usage
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.4Space Service

3.1.4.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.4.2Update

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

POST /api/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.4.3Count

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.1.4.4Create

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.4.5Read

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.4.6Delete

Deletes the entity with the given id.

POST /api/space/delete View in Client
Message Body *
Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    No Response Body
  • 409
    Error
    This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.
    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.5Web App Service

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

3.1.5.1Uninstall

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

POST /api/web-app/uninstall View in Client
Query Parameters
  • spaceId
    *
    This parameter identifies the space within which the web app should be uninstalled.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    No Response Body
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.5.2Check Installation

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

GET /api/web-app/check-installation View in Client
Query Parameters
  • spaceId
    *
    This parameter identifies the space which should be checked if the web app is installed.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Boolean
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.5.3Confirm

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

POST /api/web-app/confirm View in Client
Message Body *
Web App Confirmation Request
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Web App Confirmation Response
  • 442
    Error
    This 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.1Delete

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.2Search

Searches for the entities as specified by the given query.

POST /api/customer-address/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the customers which are returned by the search.
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.3selectDefaultAddress

GET /api/customer-address/select-default-address View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the customer address to set as default.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    No Response Body
  • 409
    Error
    This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.
    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.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/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.5Count

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.6Create

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

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.2Update

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

POST /api/customer-comment/update View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The customer object with the properties which should be updated.
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.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.4Create

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.5Count

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

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.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.3Delete

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.4Count

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

POST /api/customer/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
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.3.5Search

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.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/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.3Debt Collection

3.3.1Debt Collection Case Service

3.3.1.1Create

Creates the entity with the given properties.

POST /api/debt-collection-case/create View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The debt collection case object with the properties which should be created.
Debt Collection Case Create
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Debt Collection Case
  • 442
    Error
    This 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.1.2Add Collected Amount

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

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

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

GET /api/debt-collection-case/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the debt collection case which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Debt Collection Case
  • 442
    Error
    This 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.1.4Delete

Deletes the entity with the given id.

POST /api/debt-collection-case/delete View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    No Response Body
  • 409
    Error
    This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.
    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.3.1.5Mark Case As Reviewed

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

POST /api/debt-collection-case/markAsReviewed View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the debt collection case which should be reviewed.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Debt Collection Case
  • 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.3.1.6Search

Searches for the entities as specified by the given query.

POST /api/debt-collection-case/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the cases which are returned by the search.
Entity Query
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Debt Collection Case
  • 442
    Error
    This 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.1.7Documents

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

POST /api/debt-collection-case/documents View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the debt collection case for which the attached documents are returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Debt Collection Case Document
  • 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.3.1.8Attach Document

Attach an additional supporting document to the case.

POST /api/debt-collection-case/attachDocument View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the debt collection case.
    Long
  • fileName
    *
    The file name of the document that is uploaded.
    String
  • contentBase64
    *
    The BASE64 encoded contents of the document.
    String
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Debt Collection Case Document
  • 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.3.1.9Close

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

POST /api/debt-collection-case/close View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the debt collection case which should be closed.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Debt Collection Case
  • 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.3.1.10Mark Case As Prepared

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

POST /api/debt-collection-case/markAsPrepared View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the debt collection case which should be marked as prepared.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Debt Collection Case
  • 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.3.1.11Count

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

POST /api/debt-collection-case/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
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.3.1.12Update

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

POST /api/debt-collection-case/update View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The object with all the properties which should be updated. The id and the version are required properties.
Debt Collection Case Update
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Debt Collection Case
  • 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.3.2Debt Collector Configuration Service

3.3.2.1Search

Searches for the entities as specified by the given query.

POST /api/debt-collector-configuration/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the debt collector configuration which are returned by the search.
Entity Query
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Debt Collector 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.3.2.2Count

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

POST /api/debt-collector-configuration/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
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.3.2.3Read

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

GET /api/debt-collector-configuration/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the debt collector configuration which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Debt Collector 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.3.3Debt Collector Service

3.3.3.1Read

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

GET /api/debt-collector/read View in Client
Query Parameters
  • id
    *
    The id of the collector which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Debt Collector
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.3.2All

This operation returns all entities which are available.

GET /api/debt-collector/all View in Client
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Debt Collector
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.4Document

3.4.1Document Template Service

3.4.1.1Count

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

POST /api/document-template/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
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.4.1.2Read

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

GET /api/document-template/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the document template which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Document Template
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.3Search

Searches for the entities as specified by the given query.

POST /api/document-template/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the document templates which are returned by the search.
Entity Query
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Document Template
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.2Document Template Type

3.4.2.1Read

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

GET /api/document-template-type/read View in Client
Query Parameters
  • id
    *
    The id of the document template type which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Document Template 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.4.2.2All

This operation returns all entities which are available.

GET /api/document-template-type/all View in Client
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Document Template 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.5Installment

3.5.1Installment Payment Service

3.5.1.1Search

Searches for the entities as specified by the given query.

POST /api/installment-payment/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the installment payments which are returned by the search.
Entity Query
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Installment Payment
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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/installment-payment/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The filter which restricts the installment payment which are used to calculate the count.
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.3Read

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

GET /api/installment-payment/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the installment payment which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Installment Payment
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.4Create Installment Payment

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

POST /api/installment-payment/createInstallmentPayment View in Client
Query Parameters
  • spaceId
    *
    Long
  • transactionId
    *
    The transaction which should be converted into an installment payment.
    Long
  • installmentPlanConfiguration
    *
    The installment plan configuration ID which should be applied on the transaction.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Installment Payment
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.2Installment Payment Slice Service

3.5.2.1Search

Searches for the entities as specified by the given query.

POST /api/installment-payment-slice/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the installment payment slices which are returned by the search.
Entity Query
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Installment Payment Slice
  • 442
    Error
    This 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.2.2Count

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

POST /api/installment-payment-slice/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The filter which restricts the installment payment slices which are used to calculate the count.
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.2.3Read

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

GET /api/installment-payment-slice/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the installment payment slice which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Installment Payment Slice
  • 442
    Error
    This 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.3Installment Plan Calculation Service

3.5.3.1Calculate Plans

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

POST /api/installment-plan-calculation/calculatePlans View in Client
Query Parameters
  • spaceId
    *
    Long
  • transactionId
    *
    The transaction for which the plans should be calculated for.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Installment Calculated Plan
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.4Installment Plan Configuration Service

3.5.4.1Read

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

GET /api/installment-plan-configuration/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the installment plan configuration which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Installment Plan
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.4.2Search

Searches for the entities as specified by the given query.

POST /api/installment-plan-configuration/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the installment plan configurations which are returned by the search.
Entity Query
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Installment Plan
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.4.3Count

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

POST /api/installment-plan-configuration/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The filter which restricts the installment plan configurations which are used to calculate the count.
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.5Installment Plan Slice Configuration

3.5.5.1Read

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

GET /api/installment-plan-slice-configuration/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the installment plan slice configuration which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Installment Plan Slice
  • 442
    Error
    This 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.5.2Search

Searches for the entities as specified by the given query.

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

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

POST /api/installment-plan-slice-configuration/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The filter which restricts the installment plan slice configurations which are used to calculate the count.
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.6Internationalization

3.6.1Country Service

3.6.1.1All

This operation returns all countries.

GET /api/country/all View in Client
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Country
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.2Country State Service

3.6.2.1All

This operation returns all states of all countries.

GET /api/country-state/all View in Client
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of State
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.2Find by Country

This operation returns all states for a given country.

GET /api/country-state/country View in Client
Query Parameters
  • code
    *
    The country code in ISO code two letter format for which all states should be returned.
    String
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of State
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.3Currency Service

3.6.3.1All

This operation returns all currencies.

GET /api/currency/all View in Client
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Currency
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.4Language Service

3.6.4.1All

This operation returns all languages.

GET /api/language/all View in Client
Examples 
GET /api/language/all HTTP/1.1
Host: staging-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.6.5Legal Organization Form Service

3.6.5.1Find 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.6.5.2Read

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.6.5.3All

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.7Label

3.7.1Label Descriptor Group Service

3.7.1.1Read

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.7.1.2All

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.7.2Label Descriptor Service

3.7.2.1All

This operation returns all entities which are available.

GET /api/label-description-service/all View in Client
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Label Descriptor
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.2Read

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

GET /api/label-description-service/read View in Client
Query Parameters
  • id
    *
    The id of the label descriptor which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    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.7.3Static Value Service

3.7.3.1All

This operation returns all entities which are available.

GET /api/static-value-service/all View in Client
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Static Value
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.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.8Manual Task

3.8.1Manual Task Service

3.8.1.1Count

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

POST /api/manual-task/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
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.8.1.2Search

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.8.1.3Read

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.9Payment

3.9.1Bank Account Service

3.9.1.1Read

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

GET /api/bank-account/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The ID of the bank account which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Bank Account
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.9.1.2Search

Searches for the entities as specified by the given query.

POST /api/bank-account/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the bank accounts which are returned by the search.
Entity Query
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Bank Account
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.9.1.3Count

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

POST /api/bank-account/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
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.9.2Bank Transaction Service

3.9.2.1Search

Searches for the entities as specified by the given query.

POST /api/bank-transaction/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the bank transactions which are returned by the search.
Entity Query
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Bank Transaction
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.9.2.2Read

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

GET /api/bank-transaction/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The ID of the bank transaction which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Bank Transaction
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.9.2.3Count

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

POST /api/bank-transaction/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
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.9.3Card Processing Service

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

3.9.3.1Process

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

POST /api/card-processing/process View in Client
Query Parameters
  • spaceId
    *
    Long
  • transactionId
    *
    The ID of the transaction which should be processed.
    Long
  • paymentMethodConfigurationId
    *
    The payment method configuration ID which is applied to the transaction.
    Long
Message Body *
The card details as JSON in plain which should be used to authorize the payment.
Authenticated Card Data
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.9.3.2Process With 3-D Secure

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

POST /api/card-processing/processWith3DSecure View in Client
Query Parameters
  • spaceId
    *
    Long
  • transactionId
    *
    The ID of the transaction which should be processed.
    Long
  • paymentMethodConfigurationId
    *
    The payment method configuration ID which is applied to the transaction.
    Long
Message Body *
The card details as JSON in plain which should be used to authorize the payment.
Tokenized Card Data
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    String
  • 409
    Error
    This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.
    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.9.4Charge Attempt Service

3.9.4.1Count

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.9.4.2Search

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.9.4.3Read

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.9.5Charge Bank Transaction Service

3.9.5.1Search

Searches for the entities as specified by the given query.

POST /api/charge-bank-transaction/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the charge bank transactions which are returned by the search.
Entity Query
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Charge Bank Transaction
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.9.5.2Count

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

POST /api/charge-bank-transaction/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
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.9.5.3Read

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

GET /api/charge-bank-transaction/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The ID of the charge bank transaction which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Charge Bank Transaction
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.9.6Charge Flow Level Payment Link Service

3.9.6.1Read

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.9.6.2Search

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.9.6.3Count

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.9.7Charge Flow Level Service

3.9.7.1Send Payment Link

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

POST /api/charge-flow-level/sendMessage View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the charge flow level whose payment link should be sent.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    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.9.7.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.9.7.3Read

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.9.7.4Search

Searches for the entities as specified by the given query.

POST /api/charge-flow-level/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the payment flow levels which are returned by the search.
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.9.8Charge Flow Service

3.9.8.1updateRecipient

POST /api/charge-flow/updateRecipient View in Client
Query Parameters
  • spaceId
    *
    Long
  • transactionId
    *
    The transaction id of the transaction whose recipient should be updated.
    Long
  • type
    *
    The id of the charge flow configuration type to recipient should be updated for.
    Long
  • recipient
    *
    The recipient address that should be used to send the payment URL.
    String
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    No Response Body
  • 409
    Error
    This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.
    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.9.8.2applyFlow

POST /api/charge-flow/applyFlow View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The transaction id of the transaction which should be process asynchronously.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    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.9.8.3Fetch 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.9.8.4Read

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.9.8.5Count

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

POST /api/charge-flow/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
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.9.8.6Search

Searches for the entities as specified by the given query.

POST /api/charge-flow/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the charge flows which are returned by the search.
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.9.8.7Cancel Charge Flow

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

POST /api/charge-flow/cancel-charge-flow View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The ID of the transaction for which the charge flow should be canceled.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    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.9.9Condition Type Service

3.9.9.1Read

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

GET /api/condition-type/read View in Client
Query Parameters
  • id
    *
    The id of the condition type which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Payment 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.9.9.2All

This operation returns all entities which are available.

GET /api/condition-type/all View in Client
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Payment 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.9.10Currency Bank Account Service

3.9.10.1Count

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

POST /api/currency-bank-account/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
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.9.10.2Read

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

GET /api/currency-bank-account/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The ID of the currency bank account which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Currency Bank Account
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.9.10.3Search

Searches for the entities as specified by the given query.

POST /api/currency-bank-account/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the currency bank accounts which are returned by the search.
Entity Query
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Currency Bank Account
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.9.11Delivery Indication Service

3.9.11.1markAsNotSuitable

This operation marks the delivery indication as not suitable.

POST /api/delivery-indication/markAsNotSuitable View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The delivery indication id which should be marked as not suitable.
Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Delivery Indication
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.9.11.2Count

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

POST /api/delivery-indication/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
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.9.11.3Read

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

GET /api/delivery-indication/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the delivery indication which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Delivery Indication
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.9.11.4Search

Searches for the entities as specified by the given query.

POST /api/delivery-indication/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the delivery indications which are returned by the search.
Entity Query
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Delivery Indication
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.9.11.5markAsSuitable

This operation marks the delivery indication as suitable.

POST /api/delivery-indication/markAsSuitable View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The delivery indication id which should be marked as suitable.
Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Delivery Indication
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.9.12External Transfer Bank Transaction Service

3.9.12.1Search

Searches for the entities as specified by the given query.

POST /api/external-transfer-bank-transaction/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the external transfer bank transactions which are returned by the search.
Entity Query
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of External Transfer Bank Transaction
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.9.12.2Read

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

GET /api/external-transfer-bank-transaction/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The ID of the external transfer bank transaction which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    External Transfer Bank Transaction
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.9.12.3Count

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

POST /api/external-transfer-bank-transaction/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
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.9.13Internal Transfer Bank Transaction Service

3.9.13.1Read

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

GET /api/internal-transfer-bank-transaction/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The ID of the internal transfer bank transaction which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Internal Transfer Bank Transaction
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.9.13.2Search

Searches for the entities as specified by the given query.

POST /api/internal-transfer-bank-transaction/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the internal transfer bank transactions which are returned by the search.
Entity Query
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Internal Transfer Bank Transaction
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.9.13.3Count

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

POST /api/internal-transfer-bank-transaction/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
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.9.14Invoice Reconciliation Record Invoice Link Service

This service allows to link Invoice Reconciliation Records with invoices.

3.9.14.1Unlink Invoice

Unlinks the invoice reconciliation record from the provided invoice.

POST /api/invoice-reconciliation-record-invoice-link-service/unlink-transaction View in Client
Query Parameters
  • spaceId
    *
    Long
  • recordId
    *
    The ID of the invoice reconciliation record which should be unlinked.
    Long
  • completionId
    *
    The ID of the completion which should be unlinked.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    No Response Body
  • 409
    Error
    This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.
    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.9.14.2Read

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

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

Links the invoice reconciliation record with the provided invoice.

POST /api/invoice-reconciliation-record-invoice-link-service/link View in Client
Query Parameters
  • spaceId
    *
    Long
  • recordId
    *
    The ID of the invoice reconciliation record which should be linked.
    Long
  • completionId
    *
    The ID of the completion which should be linked.
    Long
  • amount
    The amount of the invoice reconciliation record linked completion which should be changed.
    Decimal
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Invoice Reconciliation Record
  • 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.9.14.4Search

Searches for the entities as specified by the given query.

POST /api/invoice-reconciliation-record-invoice-link-service/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the invoice reconciliation record invoice link which are returned by the search.
Entity Query
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Invoice Reconciliation Record
  • 442
    Error
    This 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.9.14.5Count

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

POST /api/invoice-reconciliation-record-invoice-link-service/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
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.9.15Invoice Reconciliation Record Service

3.9.15.1Search for matchable invoices by query

Searches for transaction invoices by given query.

POST /api/invoice-reconciliation-record-service/search-for-invoices-by-query View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the invoices which are returned by the search.
Entity Query
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Transaction Invoice
  • 409
    Error
    This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.
    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.9.15.2Resolve

Resolves the invoice reconciliation record.

POST /api/invoice-reconciliation-record-service/resolve View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The ID of the invoice reconciliation record which should be resolved.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    No Response Body
  • 409
    Error
    This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.
    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.9.15.3Discard

Discards the invoice reconciliation record.

POST /api/invoice-reconciliation-record-service/discard View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The ID of the invoice reconciliation record which should be discarded.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    No Response Body
  • 409
    Error
    This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.
    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.9.15.4Count

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

POST /api/invoice-reconciliation-record-service/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
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.9.15.5Search

Searches for the entities as specified by the given query.

POST /api/invoice-reconciliation-record-service/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the invoice reconciliation records which are returned by the search.
Entity Query
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Invoice Reconciliation Record
  • 442
    Error
    This 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.9.15.6Read

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

GET /api/invoice-reconciliation-record-service/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The ID of the invoice reconciliation record which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Invoice Reconciliation Record
  • 442
    Error
    This 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.9.16Invoice Reimbursement Service

3.9.16.1Read

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

GET /api/invoice-reimbursement-service/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The ID of the invoice reimbursement which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Invoice Reimbursement
  • 442
    Error
    This 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.9.16.2Update IBAN

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

POST /api/invoice-reimbursement-service/update-iban View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The ID of the invoice reimbursement of which IBANs should be updated.
    Long
  • recipientIban
    String
  • senderIban
    String
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    No Response Body
  • 409
    Error
    This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.
    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.9.16.3Search

Searches for the entities as specified by the given query.

POST /api/invoice-reimbursement-service/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the invoice reimbursements which are returned by the search.
Entity Query
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Invoice Reimbursement
  • 442
    Error
    This 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.9.16.4Count

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

POST /api/invoice-reimbursement-service/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
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.9.16.5Update payment connector configuration

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

POST /api/invoice-reimbursement-service/update-connector View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The ID of the invoice reimbursement of which connector should be updated.
    Long
  • paymentConnectorConfigurationId
    *
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    No Response Body
  • 409
    Error
    This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.
    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.9.17Payment Connector Configuration Service

3.9.17.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 Payment 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.9.17.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.
    Payment 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.9.17.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.9.18Payment Connector Service

3.9.18.1All

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.9.18.2Read

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.9.19Payment Link Service

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

3.9.19.1Search

Searches for the entities as specified by the given query.

POST /api/payment-link/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the payment links which are returned by the search.
Entity Query
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Payment Link
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.9.19.2Update

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

POST /api/payment-link/update View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The object with all the properties which should be updated. The id and the version are required properties.
Payment Link Update
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Payment Link
  • 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.9.19.3Read

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

GET /api/payment-link/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the payment links which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    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.9.19.4Count

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

POST /api/payment-link/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
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.9.19.5Create

Creates the entity with the given properties.

POST /api/payment-link/create View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The payment link object with the properties which should be created.
Payment Link Create
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    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.9.19.6Delete

Deletes the entity with the given id.

POST /api/payment-link/delete View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    No Response Body
  • 409
    Error
    This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.
    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.9.20Payment Method Brand Service

3.9.20.1All

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.9.20.2Read

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.9.21Payment Method Configuration Service

3.9.21.1Read

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.9.21.2Search

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.9.21.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.9.22Payment Method Service

3.9.22.1Read

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.9.22.2All

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.9.23Payment Processor Configuration Service

3.9.23.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.9.23.2Search

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.9.23.3Read

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.9.24Payment Processor Service

3.9.24.1Read

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

GET /api/payment-processor/read View in Client
Query Parameters
  • id
    *
    The id of the processor which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    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.9.24.2All

This operation returns all entities which are available.

GET /api/payment-processor/all View in Client
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Payment Processor
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.9.25Payment Terminal Service

The payment terminal service allows to fetch the configured terminals.

3.9.25.1Search

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.9.25.2Link 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.9.25.3Remotely 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.
    Transaction summary Reference
  • 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.9.25.4Remotely 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.
    Transaction summary Reference
  • 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.9.25.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.9.25.6Unlink 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.9.25.7Read

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.9.26Payment Terminal Till Service

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

3.9.26.1Perform Payment Terminal Transaction

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

GET /api/payment-terminal-till/perform-transaction View in Client
Query Parameters
  • spaceId
    *
    Long
  • transactionId
    *
    The ID of the transaction which is used to process with the terminal.
    Long
  • terminalId
    *
    The ID of the terminal which should be used to process the transaction.
    Long
  • language
    The language in which the messages should be rendered in.
    String
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    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.9.26.2Perform Payment Terminal Transaction (using TID)

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

GET /api/payment-terminal-till/perform-transaction-by-identifier View in Client
Query Parameters
  • spaceId
    *
    Long
  • transactionId
    *
    The ID of the transaction which is used to process with the terminal.
    Long
  • terminalIdentifier
    *
    The identifier (aka TID) of the terminal which should be used to process the transaction.
    String
  • language
    The language in which the messages should be rendered in.
    String
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    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.9.27Payment Terminal Transaction Summary Service

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

3.9.27.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.9.27.2Search

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.9.27.3Read

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

GET /api/payment-terminal-transaction-summary/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the transaction summary report which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    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.9.27.4Fetch 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.9.28Payment Web App Service

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

3.9.28.1Insert or Update Connector

This operation inserts or updates a web app payment connector.

POST /api/payment-web-app/insert-or-update-connector View in Client
Query Parameters
  • spaceId
    *
    The space ID identifies the space into which the connector should be inserted into.
    Long
Message Body *
The connector object contains all the details required to create or update a web app connector.
Payment App Connector Creation Request
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Payment App 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.9.28.2Delete Connector

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

POST /api/payment-web-app/delete-connector View in Client
Query Parameters
  • spaceId
    *
    The space ID identifies the space in which the connector is installed in.
    Long
  • externalId
    *
    The external ID identifies the connector. The external ID corresponds to the ID provided during inserting of the connector.
    String
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    No Response Body
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.9.28.3Insert or Update Processor

This operation inserts or updates a web app payment processor.

POST /api/payment-web-app/insert-or-update-processor View in Client
Query Parameters
  • spaceId
    *
    The space ID identifies the space into which the processor should be inserted into.
    Long
Message Body *
The processor object contains all the details required to create or update a web app processor.
Payment App Processor Creation Request
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Payment App 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.9.28.4Delete Processor

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

POST /api/payment-web-app/delete-processor View in Client
Query Parameters
  • spaceId
    *
    The space ID identifies the space in which the processor is installed in.
    Long
  • externalId
    *
    The external ID identifies the processor. The external ID corresponds to the ID provided during inserting of the processor.
    String
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    No Response Body
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.9.28.5Update Charge Attempt

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

POST /api/payment-web-app/update-charge-attempt View in Client
Query Parameters
  • spaceId
    *
    This is the ID of the space in which the charge attempt is located in.
    Long
Message Body *
The charge attempt update request allows to update the state of a charge attempt.
Payment App Charge Attempt Update Request
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.9.28.6Update Void

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

POST /api/payment-web-app/update-void View in Client
Query Parameters
  • spaceId
    *
    This is the ID of the space in which the void is located in.
    Long
Message Body *
The void update request allows to update the state of a void.
Payment App Void Update Request
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Transaction Void
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.9.28.7Update Completion

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

POST /api/payment-web-app/update-completion View in Client
Query Parameters
  • spaceId
    *
    This is the ID of the space in which the completion is located in.
    Long
Message Body *
The completion update request allows to update the state of a completion.
Payment App Completion Update Request
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Transaction Completion
  • 442
    Error
    This 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.9.28.8Activate Processor for Production

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

POST /api/payment-web-app/activate-processor-for-production View in Client
Query Parameters
  • spaceId
    *
    The space ID identifies the space in which the processor is installed in.
    Long
  • externalId
    *
    The external ID identifies the processor. The external ID corresponds to the ID provided during inserting of the processor.
    String
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Payment App 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.9.28.9Update Refund

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

POST /api/payment-web-app/update-refund View in Client
Query Parameters
  • spaceId
    *
    This is the ID of the space in which the refund is located in.
    Long
Message Body *
The refund update request allows to update the state of a refund.
Payment App Refund Update Request
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Refund
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.9.29Refund Bank Transaction Service

3.9.29.1Read

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

GET /api/refund-bank-transaction/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The ID of the refund bank transaction which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Refund Bank Transaction
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.9.29.2Count

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

POST /api/refund-bank-transaction/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
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.9.29.3Search

Searches for the entities as specified by the given query.

POST /api/refund-bank-transaction/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the refund bank transactions which are returned by the search.
Entity Query
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Refund Bank Transaction
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.9.30Refund Comment Service

3.9.30.1Update

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.9.30.2Find 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.9.30.3Create

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.9.30.4Read

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.9.30.5Delete

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.9.30.6Pin

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.9.30.7Unpin

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.9.31Refund Recovery Bank Transaction Service

3.9.31.1Read

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

GET /api/refund-recovery-bank-transaction/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The ID of the refund recovery bank transaction which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Refund Recovery Bank Transaction
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.9.31.2Search

Searches for the entities as specified by the given query.

POST /api/refund-recovery-bank-transaction/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the refund recovery bank transactions which are returned by the search.
Entity Query
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Refund Recovery Bank Transaction
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.9.31.3Count

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

POST /api/refund-recovery-bank-transaction/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
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.9.32Refund Service

3.9.32.1Search

Searches for the entities as specified by the given query.

POST /api/refund/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the refunds which are returned by the search.
Entity Query
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Refund
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.9.32.2getRefundDocument

Returns the PDF document for the refund with given id.

GET /api/refund/getRefundDocument View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the refund to get the document for.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    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.9.32.3fail

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

POST /api/refund/fail View in Client
Query Parameters
  • spaceId
    *
    Long
  • refundId
    *
    The id of the refund which should be marked as failed.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Refund
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.9.32.4Read

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

GET /api/refund/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the refund which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Refund
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.9.32.5create

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

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

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

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

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

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

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

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

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

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

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

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

import java.math.BigDecimal;

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

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

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

    // Models
    private TransactionCreate transactionPayload;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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


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

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

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

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

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

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

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

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

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

    return transactionPayload;
}

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

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

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

POST /api/refund/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
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.9.32.7getRefundDocumentWithTargetMediaType

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

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

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

POST /api/refund/succeed View in Client
Query Parameters
  • spaceId
    *
    Long
  • refundId
    *
    The id of the refund which should be marked as successful.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Refund
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.9.33Token Service

3.9.33.1Read

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

GET /api/token/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the token which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Payment Token
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.9.33.2Check If Token Creation Is Possible

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

POST /api/token/check-token-creation-possible View in Client
Query Parameters
  • spaceId
    *
    Long
  • transactionId
    *
    The id of the transaction for which we want to check if the token can be created or not.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Boolean
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.9.33.3Create Token

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

POST /api/token/create-token View in Client
Query Parameters
  • spaceId
    *
    Long
  • transactionId
    *
    The id of the transaction for which we want to create the token.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Payment Token
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.9.33.4Create Transaction for Token Update

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

POST /api/token/createTransactionForTokenUpdate View in Client
Query Parameters
  • spaceId
    *
    Long
  • tokenId
    *
    The id of the token which should be updated.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    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.9.33.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/token/update View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The object with all the properties which should be updated. The id and the version are required properties.
Payment Token Update
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Payment Token
  • 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.9.33.6Count

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

POST /api/token/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
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.9.33.7Create Token Based On Transaction And Fill It With Stored Payment Information

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

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

Creates the entity with the given properties.

POST /api/token/create View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The token object with the properties which should be created.
Payment Token Create
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Payment Token
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.9.33.9Delete

Deletes the entity with the given id.

POST /api/token/delete View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    No Response Body
  • 409
    Error
    This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.
    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.9.33.10Process Transaction

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

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

Searches for the entities as specified by the given query.

POST /api/token/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the tokens which are returned by the search.
Entity Query
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Payment Token
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.9.34Token Version Service

3.9.34.1Active Version

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

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

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

POST /api/token-version/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
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.9.34.3Search

Searches for the entities as specified by the given query.

POST /api/token-version/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the token versions which are returned by the search.
Entity Query
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.9.34.4Read

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

GET /api/token-version/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the token version which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    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.9.35Transaction Comment Service

3.9.35.1Create

Creates the comment with the given properties.

POST /api/transaction-comment/create View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The comment object which should be created.
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.9.35.2Unpin

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.9.35.3Find 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.9.35.4Delete

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.9.35.5Pin

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.9.35.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.9.35.7Update

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.9.36Transaction Completion Service

3.9.36.1Read

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

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

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

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

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

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

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

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

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

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

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

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

import java.math.BigDecimal;

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

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

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

    // Models
    private TransactionCreate transactionPayload;

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

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

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

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

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

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

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

        private TransactionCompletionService TransactionCompletionService;
        private TransactionService TransactionService;


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

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

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

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

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

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

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

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

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

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

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

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

    return transactionPayload;
}

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

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

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

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

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

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

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

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

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

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

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

import java.math.BigDecimal;

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

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

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

    // Models
    private TransactionCreate transactionPayload;

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

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

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

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

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

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

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

        private TransactionCompletionService TransactionCompletionService;
        private TransactionService TransactionService;


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

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

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

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

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

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

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

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

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

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

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

    return transactionPayload;
}

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

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

POST /api/transaction-completion/completePartiallyOnline View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
Transaction Completion Request
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Transaction Completion
  • 442
    Error
    This 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.9.36.5Search

Searches for the entities as specified by the given query.

POST /api/transaction-completion/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the transaction completions which are returned by the search.
Entity Query
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Transaction Completion
  • 442
    Error
    This 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.9.36.6completePartiallyOffline

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

POST /api/transaction-completion/completePartiallyOffline View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
Transaction Completion Request
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Transaction Completion
  • 442
    Error
    This 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.9.36.7Count

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

POST /api/transaction-completion/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
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.9.37Transaction Iframe Service

3.9.37.1Build JavaScript URL

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

GET /api/transaction-iframe/javascript-url View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the transaction which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    String
  • 409
    Error
    This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.
    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.9.38Transaction Invoice Comment Service

3.9.38.1Create

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.9.38.2Find by invoice

Returns all comments of the given transaction invoice.

POST /api/transaction-invoice-comment/all View in Client
Query Parameters
  • spaceId
    *
    Long
  • invoiceId
    *
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    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.9.38.3Unpin

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.9.38.4Delete

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.9.38.5Pin

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.9.38.6Read

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.9.38.7Update

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.9.39Transaction Invoice Service

3.9.39.1getInvoiceDocumentWithTargetMediaType

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.9.39.2Search

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.9.39.3Count

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

POST /api/transaction-invoice/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
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.9.39.4Mark 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.9.39.5Mark 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.9.39.6Read

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.9.39.7isReplacementPossible

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.9.39.8replace

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.9.39.9getInvoiceDocument

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.9.40Transaction Lightbox Service

3.9.40.1Build JavaScript URL

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

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

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

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

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

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

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

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

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

import java.math.BigDecimal;

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

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

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

    // Models
    private TransactionCreate transactionPayload;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    }

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

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

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

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

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

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

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

    return transactionPayload;
}

// Fetch lightbox javascript url
transactionService.create(config.space_id, getTransactionPayload())
    .then((response: { response: http.IncomingMessage, body: Wallee.model.Transaction }) => {
        let transaction: Wallee.model.Transaction = response.body;
        return transactionLightboxService.javascriptUrl(config.space_id, <number>transaction.id);
    })
    .done((response: { response: http.IncomingMessage, body: string }) => {
        let javascriptUrl: string = response.body;
        // expect javascriptUrl to be a string
        // expect javascriptUrl to include https://
    });
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the transaction which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    String
  • 409
    Error
    This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.
    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.9.41Transaction Line Item Version Service

3.9.41.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.9.41.2Read

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.9.41.3Search

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.9.41.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.9.42Transaction Mobile SDK Service

3.9.42.1Build Mobile SDK URL

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

GET /api/transaction-mobile-sdk/payment-form-url View in Client
Query Parameters
  • credentials
    *
    The credentials identifies the transaction and contains the security details which grants the access this operation.
    String
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    String
  • 409
    Error
    This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.
    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.9.43Transaction Payment Page Service

3.9.43.1Build Payment Page URL

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

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

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

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

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

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

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

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

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

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

import java.math.BigDecimal;

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

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

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

    // Models
    private TransactionCreate transactionPayload;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    return transactionPayload;
}

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

3.9.44.1getInvoiceDocument

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.9.44.2Export

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.9.44.3Process 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.9.44.4getLatestSuccessfulTransactionLineItemVersion

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.9.44.5Create 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.9.44.6Fetch 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.9.44.7getPackingSlip

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.9.44.8Update

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.9.44.9Read

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.9.44.10Fetch 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.9.44.11Delete One-Click Token with Credentials

This operation removes the given token.

POST /api/transaction/deleteOneClickTokenWithCredentials View in Client
Query Parameters
  • credentials
    *
    The credentials identifies the transaction and contains the security details which grants the access this operation.
    String
  • tokenId
    *
    The token ID will be used to find the token which should be removed.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    No Response Body
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.9.44.12Read 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.9.44.13Create

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: staging-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.9.44.14Fetch 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.9.44.15Count

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.9.44.16Process 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.9.44.17Confirm

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: staging-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.9.44.18Search

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.9.45Transaction Terminal Service

3.9.45.1Create Till Connection Credentials

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

POST /api/transaction-terminal/till-connection-credentials View in Client
Query Parameters
  • spaceId
    *
    Long
  • transactionId
    *
    The ID of the transaction which is used to process with the terminal.
    Long
  • terminalId
    *
    The ID of the terminal which should be used to process the transaction.
    Long
  • language
    The language in which the messages should be rendered in.
    String
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    String
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.9.45.2Fetch Receipts

Returns all receipts for the requested terminal transaction.

POST /api/transaction-terminal/fetch-receipts View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
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.9.46Transaction Void Service

3.9.46.1voidOnline

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

POST /api/transaction-void/voidOnline View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the transaction which should be voided.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Transaction Void
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.9.46.2Read

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

GET /api/transaction-void/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the transaction voids which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Transaction Void
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.9.46.3Count

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

POST /api/transaction-void/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
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.9.46.4voidOffline

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

POST /api/transaction-void/voidOffline View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the transaction which should be voided.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Transaction Void
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.9.46.5Search

Searches for the entities as specified by the given query.

POST /api/transaction-void/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the transaction voids which are returned by the search.
Entity Query
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Transaction Void
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.10Shopify

3.10.1Shopify Recurring Order Service

3.10.1.1Count

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

POST /api/shopify-recurring-order/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
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.10.1.2Read

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

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

This operation allows to update a Shopify recurring order.

POST /api/shopify-recurring-order/update View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
Shopify Recurring Order Update Request
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.10.1.4Search

Searches for the entities as specified by the given query.

POST /api/shopify-recurring-order/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the Shopify recurring orders which are returned by the search.
Entity Query
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Shopify Recurring Order
  • 442
    Error
    This 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.10.2Shopify Subscriber Service

3.10.2.1Count

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

POST /api/shopify-subscriber/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
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.10.2.2Read

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

GET /api/shopify-subscriber/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the Shopify subscriber which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Shopify Subscriber
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.10.2.3Search

Searches for the entities as specified by the given query.

POST /api/shopify-subscriber/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the Shopify subscribers which are returned by the search.
Entity Query
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Shopify Subscriber
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.10.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/shopify-subscriber/update View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The Shopify subscriber object with all the properties which should be updated. The id and the version are required properties.
Shopify Subscriber . Active Active
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Shopify Subscriber
  • 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.10.3Shopify Subscription Product Service

3.10.3.1Search

Searches for the entities as specified by the given query.

POST /api/shopify-subscription-product/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the Shopify subscription products which are returned by the search.
Entity Query
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Shopify Subscription Product
  • 442
    Error
    This 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.10.3.2Read

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

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

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

POST /api/shopify-subscription-product/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
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.10.3.4Update

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

POST /api/shopify-subscription-product/update View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The Shopify subscription product object with all the properties which should be updated. The id and the version are required properties.
Shopify Subscription Product Obsolete
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Shopify Subscription Product
  • 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.10.3.5Create

Creates the entity with the given properties.

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

3.10.4.1Count

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

POST /api/shopify-subscription/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
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.10.4.2Terminate

This operation allows to terminate a Shopify subscription.

POST /api/shopify-subscription/terminate View in Client
Query Parameters
  • spaceId
    *
    Long
  • subscriptionId
    *
    The ID identifies the Shopify subscription which should be terminated.
    Long
  • respectTerminationPeriod
    *
    The respect termination period controls whether the termination period configured on the product version should be respected or if the operation should take effect immediately.
    Boolean
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    No Response Body
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.10.4.3Create

This operation allows to create a Shopify subscription.

POST /api/shopify-subscription/create View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
Shopify Subscription Creation Request
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Shopify Subscription 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.10.4.4Read

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

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

Searches for the entities as specified by the given query.

POST /api/shopify-subscription/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the Shopify subscriptions which are returned by the search.
Entity Query
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Shopify Subscription
  • 442
    Error
    This 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.10.4.6Update Addresses

This operation allows to update a Shopify subscription addresses.

POST /api/shopify-subscription/update-addresses View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
Shopify Subscription Update Addresses Request
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Shopify Subscription 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.10.4.7Update

This operation allows to update a Shopify subscription.

POST /api/shopify-subscription/update View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
Shopify Subscription Update Request
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Shopify Subscription 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.10.5Shopify Subscription Suspension Service

3.10.5.1Suspend

This operation allows to suspend a Shopify subscription.

POST /api/shopify-subscription-suspension/suspend View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
Shopify Subscription Suspension . Create Create
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Shopify Subscription Suspension
  • 442
    Error
    This 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.10.5.2Read

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

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

Searches for the entities as specified by the given query.

POST /api/shopify-subscription-suspension/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the Shopify subscription suspensions which are returned by the search.
Entity Query
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Collection of Shopify Subscription Suspension
  • 442
    Error
    This 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.10.5.4Reactivate

This operation allows to reactivate a suspended Shopify subscription.

POST /api/shopify-subscription-suspension/reactivate View in Client
Query Parameters
  • spaceId
    *
    Long
  • subscriptionId
    *
    The ID identifies the suspended Shopify subscription which should be reactivated.
    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.10.5.5Count

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

POST /api/shopify-subscription-suspension/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
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.10.6Shopify Subscription Version Service

3.10.6.1Count

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

POST /api/shopify-subscription-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.10.6.2Read

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

GET /api/shopify-subscription-version/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the Shopify subscription version which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Shopify Subscription 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.10.6.3Search

Searches for the entities as specified by the given query.

POST /api/shopify-subscription-version/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the Shopify subscription 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 Shopify Subscription 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.10.7Shopify Transaction Service

3.10.7.1Read

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

GET /api/shopify-transaction/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the Shopify transaction which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Shopify 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.10.7.2Count

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

POST /api/shopify-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.10.7.3Search

Searches for the entities as specified by the given query.

POST /api/shopify-transaction/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the Shopify 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 Shopify 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.11Subscription

3.11.1Subscriber Service

3.11.1.1Create

Creates the entity with the given properties.

POST /api/subscriber/create View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The customer object with the properties which should be created.
Subscriber . Create Create
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Subscriber
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.11.1.2Delete

Deletes the entity with the given id.

POST /api/subscriber/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.11.1.3Count

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

POST /api/subscriber/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.11.1.4Search

Searches for the entities as specified by the given query.

POST /api/subscriber/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the customer 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 Subscriber
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.11.1.5Read

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

GET /api/subscriber/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.
    Subscriber
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.11.1.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/subscriber/update View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The customer with all the properties which should be updated. The id and the version are required properties.
Subscriber . Update Update
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Subscriber
  • 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.11.2Subscription Affiliate Service

3.11.2.1Delete

Deletes the entity with the given id.

POST /api/subscription-affiliate/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.11.2.2Search

Searches for the entities as specified by the given query.

POST /api/subscription-affiliate/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the affiliates 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 Subscription Affiliate
  • 442
    Error
    This 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.11.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/subscription-affiliate/update View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The object with all the properties which should be updated. The id and the version are required properties.
Subscription Affiliate Update
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Subscription Affiliate
  • 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.11.2.4Read

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

GET /api/subscription-affiliate/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the subscription affiliate case which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Subscription Affiliate
  • 442
    Error
    This 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.11.2.5Count

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

POST /api/subscription-affiliate/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.11.2.6Create

Creates the entity with the given properties.

POST /api/subscription-affiliate/create View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The subscription affiliate object with the properties which should be created.
Subscription Affiliate Create
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Subscription Affiliate
  • 442
    Error
    This 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.11.3Subscription Charge Service

3.11.3.1Count

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

POST /api/subscription-charge/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.11.3.2Create

The create operation creates a new subscription charge.

POST /api/subscription-charge/create View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
Subscription Charge . Create Create
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Subscription Charge
  • 442
    Error
    This 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.11.3.3discard

This operation allows to discard a scheduled charge.

POST /api/subscription-charge/discard View in Client
Query Parameters
  • spaceId
    *
    Long
  • chargeId
    *
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Subscription Charge
  • 442
    Error
    This 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.11.3.4Read

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

GET /api/subscription-charge/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the subscription charge which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Subscription Charge
  • 442
    Error
    This 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.11.3.5Search

Searches for the entities as specified by the given query.

POST /api/subscription-charge/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the subscription charges 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 Subscription Charge
  • 442
    Error
    This 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.11.4Subscription Metric Service

3.11.4.1Create

Creates the entity with the given properties.

POST /api/subscription-metric/create View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The metric object with the properties which should be created.
Metric Create
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Metric
  • 442
    Error
    This 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.11.4.2Delete

Deletes the entity with the given id.

POST /api/subscription-metric/delete View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The id of the metric which should be deleted.
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.11.4.3Search

Searches for the entities as specified by the given query.

POST /api/subscription-metric/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the metric 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 Metric
  • 442
    Error
    This 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.11.4.4Read

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

GET /api/subscription-metric/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the metric which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Metric
  • 442
    Error
    This 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.11.4.5Count

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

POST /api/subscription-metric/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.11.4.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/subscription-metric/update View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The products metric with all the properties which should be updated. The id and the version are required properties.
Metric Active
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Metric
  • 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.11.5Subscription Metric Usage Report Service

3.11.5.1Create

This operation creates a new metric usage report.

POST /api/subscription-metric-usage/create View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The usage report which should be created.
Metric Usage Report Create
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Metric Usage Report
  • 442
    Error
    This 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.11.5.2Count

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

POST /api/subscription-metric-usage/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.11.5.3Search

Searches for the entities as specified by the given query.

POST /api/subscription-metric-usage/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the usage 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 Metric Usage Report
  • 442
    Error
    This 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.11.5.4Read

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

GET /api/subscription-metric-usage/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the usage report which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Metric Usage Report
  • 442
    Error
    This 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.11.6Subscription Period Bill Service

3.11.6.1Count

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

POST /api/subscription-period-bill/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.11.6.2Search

Searches for the entities as specified by the given query.

POST /api/subscription-period-bill/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the subscription period bills 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 Subscription Period Bill
  • 442
    Error
    This 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.11.6.3Read

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

GET /api/subscription-period-bill/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the subscription period bill which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Subscription Period Bill
  • 442
    Error
    This 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.11.7Subscription Product Component Group Service

3.11.7.1Create

Creates the entity with the given properties.

POST /api/subscription-product-component-group/create View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The product component group object with the properties which should be created.
Product Component Group Update
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Product Component 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.11.7.2Read

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

GET /api/subscription-product-component-group/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the product component group which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Product Component 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.11.7.3Delete

Deletes the entity with the given id.

POST /api/subscription-product-component-group/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.11.7.4Search

Searches for the entities as specified by the given query.

POST /api/subscription-product-component-group/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the product component groups 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 Product Component 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.11.7.5Count

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

POST /api/subscription-product-component-group/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.11.7.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/subscription-product-component-group/update View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The product component group object with all the properties which should be updated. The id and the version are required properties.
Product Component Group Update
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Product Component Group
  • 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.11.8Subscription Product Component Service

3.11.8.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/subscription-product-component/update View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The product component object with all the properties which should be updated. The id and the version are required properties.
Product Component Update
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Product Component
  • 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.11.8.2Create

Creates the entity with the given properties.

POST /api/subscription-product-component/create View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The product component object with the properties which should be created.
Product Component Update
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Product Component
  • 442
    Error
    This 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.11.8.3Count

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

POST /api/subscription-product-component/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.11.8.4Read

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

GET /api/subscription-product-component/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the product component which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Product Component
  • 442
    Error
    This 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.11.8.5Delete

Deletes the entity with the given id.

POST /api/subscription-product-component/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.11.8.6Search

Searches for the entities as specified by the given query.

POST /api/subscription-product-component/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the product component 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 Product Component
  • 442
    Error
    This 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.11.9Subscription Product Metered Fee Service

3.11.9.1Delete

Deletes the entity with the given id.

POST /api/subscription-product-metered-fee/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.11.9.2Count

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

POST /api/subscription-product-metered-fee/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.11.9.3Search

Searches for the entities as specified by the given query.

POST /api/subscription-product-metered-fee/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the metered fees 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 Product Metered Fee
  • 442
    Error
    This 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.11.9.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/subscription-product-metered-fee/update View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The metered fee object with all the properties which should be updated. The id and the version are required properties.
Product Metered Fee Update
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Product Metered Fee
  • 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.11.9.5Read

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

GET /api/subscription-product-metered-fee/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the metered fee which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Product Metered Fee
  • 442
    Error
    This 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.11.9.6Create

Creates the entity with the given properties.

POST /api/subscription-product-metered-fee/create View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The metered fee object with the properties which should be created.
Product Metered Fee Update
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Product Metered Fee
  • 442
    Error
    This 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.11.10Subscription Product Metered Tier Fee Service

3.11.10.1Count

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

POST /api/subscription-product-fee-tier/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.11.10.2Search

Searches for the entities as specified by the given query.

POST /api/subscription-product-fee-tier/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the metered fee tiers 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 Product Metered Fee Tier
  • 442
    Error
    This 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.11.10.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/subscription-product-fee-tier/update View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The metered fee tier object with all the properties which should be updated. The id and the version are required properties.
Product Metered Fee Tier Update
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Product Metered Fee Tier
  • 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.11.10.4Create

Creates the entity with the given properties.

POST /api/subscription-product-fee-tier/create View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The metered fee tier object with the properties which should be created.
Product Metered Fee Tier Update
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Product Metered Fee Tier
  • 442
    Error
    This 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.11.10.5Read

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

GET /api/subscription-product-fee-tier/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the metered fee tier which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Product Metered Fee Tier
  • 442
    Error
    This 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.11.10.6Delete

Deletes the entity with the given id.

POST /api/subscription-product-fee-tier/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.11.11Subscription Product Period Fee Service

3.11.11.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/subscription-product-period-fee/update View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The period fee object with all the properties which should be updated. The id and the version are required properties.
Product Period Fee Update
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Product Period Fee
  • 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.11.11.2Read

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

GET /api/subscription-product-period-fee/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the period fee which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Product Period Fee
  • 442
    Error
    This 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.11.11.3Create

Creates the entity with the given properties.

POST /api/subscription-product-period-fee/create View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The period fee object with the properties which should be created.
Product Period Fee Update
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Product Period Fee
  • 442
    Error
    This 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.11.11.4Count

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

POST /api/subscription-product-period-fee/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.11.11.5Delete

Deletes the entity with the given id.

POST /api/subscription-product-period-fee/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.11.11.6Search

Searches for the entities as specified by the given query.

POST /api/subscription-product-period-fee/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the period fees 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 Product Period Fee
  • 442
    Error
    This 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.11.12Subscription Product Retirement Service

3.11.12.1Read

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

GET /api/subscription-product-retirement/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the retirement which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Product Retirement
  • 442
    Error
    This 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.11.12.2Count

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

POST /api/subscription-product-retirement/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.11.12.3Search

Searches for the entities as specified by the given query.

POST /api/subscription-product-retirement/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the product retirements 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 Product Retirement
  • 442
    Error
    This 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.11.12.4Create

The create operation creates a new product retirement.

POST /api/subscription-product-retirement/create View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
Product Retirement Create
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Product Retirement
  • 442
    Error
    This 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.11.13Subscription Product Service

3.11.13.1Create

Creates the entity with the given properties.

POST /api/subscription-product/create View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The product object with the properties which should be created.
Subscription Product . Create Create
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Subscription Product
  • 442
    Error
    This 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.11.13.2Read

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

GET /api/subscription-product/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the product which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Subscription Product
  • 442
    Error
    This 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.11.13.3Search

Searches for the entities as specified by the given query.

POST /api/subscription-product/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the products 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 Subscription Product
  • 442
    Error
    This 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.11.13.4Count

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

POST /api/subscription-product/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
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.11.13.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/subscription-product/update View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The products object with all the properties which should be updated. The id and the version are required properties.
Subscription Product . Active Active
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Subscription Product
  • 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.11.14Subscription Product Setup Fee Service

3.11.14.1Read

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

GET /api/subscription-product-setup-fee/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the setup fee which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Product Setup Fee
  • 442
    Error
    This 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.11.14.2Delete

Deletes the entity with the given id.

POST /api/subscription-product-setup-fee/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.11.14.3Count

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

POST /api/subscription-product-setup-fee/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.11.14.4Search

Searches for the entities as specified by the given query.

POST /api/subscription-product-setup-fee/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the setup fees 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 Product Setup Fee
  • 442
    Error
    This 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.11.14.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/subscription-product-setup-fee/update View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The setup fee object with all the properties which should be updated. The id and the version are required properties.
Product Setup Fee Update
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Product Setup Fee
  • 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.11.14.6Create

Creates the entity with the given properties.

POST /api/subscription-product-setup-fee/create View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The setup fee object with the properties which should be created.
Product Setup Fee Update
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Product Setup Fee
  • 442
    Error
    This 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.11.15Subscription Product Version Retirement Service

3.11.15.1Read

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

GET /api/subscription-product-version-retirement/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the retirement which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Product Version Retirement
  • 442
    Error
    This 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.11.15.2Create

The create operation creates a new product version retirement.

POST /api/subscription-product-version-retirement/create View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
Product Version Retirement Create
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Product Version Retirement
  • 442
    Error
    This 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.11.15.3Count

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

POST /api/subscription-product-version-retirement/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.11.15.4Search

Searches for the entities as specified by the given query.

POST /api/subscription-product-version-retirement/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the product version retirements 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 Product Version Retirement
  • 442
    Error
    This 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.11.16Subscription Product Version Service

3.11.16.1Create

Creates the entity with the given properties.

POST /api/subscription-product-version/create View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The product version object with the properties which should be created.
Product Version Pending
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Product 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.11.16.2Search

Searches for the entities as specified by the given query.

POST /api/subscription-product-version/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the product 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 Product 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.11.16.3Count

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

POST /api/subscription-product-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.11.16.4Read

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

GET /api/subscription-product-version/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the product version which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Product 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.11.16.5activate

This operation activates a new product version.

POST /api/subscription-product-version/activate View in Client
Query Parameters
  • spaceId
    *
    Long
  • productVersionId
    *
    The product version id identifies the product version which should be activated.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Product 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.11.16.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/subscription-product-version/update View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The product version object with all the properties which should be updated. The id and the version are required properties.
Product Version Pending
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Product Version
  • 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.11.17Subscription Service

3.11.17.1update product version

The update product version operation updates the product version of the subscription to the latest active product version.

POST /api/subscription/updateProductVersion View in Client
Query Parameters
  • spaceId
    *
    Long
  • subscriptionId
    *
    The subscription id identifies the subscription which should be updated to the latest version.
    Long
  • respectTerminationPeriod
    *
    The subscription version may be retired. The respect termination period controls whether the termination period configured on the product version should be respected or if the operation should take effect immediately.
    Boolean
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Subscription Version
  • 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.11.17.2update

This operation allows to update the subscription.

POST /api/subscription/update View in Client
Query Parameters
  • spaceId
    *
    Long
  • subscriptionId
    *
    Long
Message Body *
Subscription Update Request
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Subscription
  • 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.11.17.3Count

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

POST /api/subscription/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.11.17.4Search Subscription Invoices

This operation allows to search for subscription invoices.

POST /api/subscription/searchSubscriptionInvoices View in Client
Query Parameters
  • spaceId
    *
    Long
  • subscriptionId
    *
    The id of the subscription for which the invoices should be searched for.
    Long
Message Body *
The query restricts the 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.11.17.5Create

The create operation creates a new subscription and a corresponding subscription version.

POST /api/subscription/create View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
Subscription Create Request
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Subscription 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.11.17.6initializeSubscriberPresent

The initialize operation initializes a subscription when the subscriber is present. The method will initialize a transaction which has to be completed by using the transaction service.

POST /api/subscription/initializeSubscriberPresent View in Client
Query Parameters
  • spaceId
    *
    Long
  • subscriptionId
    *
    Long
  • successUrl
    The subscriber will be redirected to the success URL when the transaction is successful.
    String
  • failedUrl
    The subscriber will be redirected to the fail URL when the transaction fails.
    String
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Subscription Charge
  • 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.11.17.7terminate

This operation allows to terminate a subscription.

POST /api/subscription/terminate View in Client
Query Parameters
  • spaceId
    *
    Long
  • subscriptionId
    *
    The subscription id identifies the subscription which should be terminated.
    Long
  • respectTerminationPeriod
    *
    The respect termination period controls whether the termination period configured on the product version should be respected or if the operation should take effect immediately.
    Boolean
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    No Response Body
  • 442
    Error
    This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
    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.11.17.8Read

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

GET /api/subscription/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the subscription which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Subscription
  • 442
    Error
    This 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.11.17.9apply changes

This operation allows to apply changes on a subscription.

POST /api/subscription/applyChanges View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
Subscription Change Request
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Subscription Version
  • 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.11.17.10Search

Searches for the entities as specified by the given query.

POST /api/subscription/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the subscriptions 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 Subscription
  • 442
    Error
    This 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.11.17.11initialize

The initialize operation initializes a subscription. This method uses charge flows to carry out the transaction.

POST /api/subscription/initialize View in Client
Query Parameters
  • spaceId
    *
    Long
  • subscriptionId
    *
    The provided subscription id will be used to lookup the subscription which should be initialized.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Subscription Charge
  • 442
    Error
    This 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.11.18Subscription Suspension Service

3.11.18.1Search

Searches for the entities as specified by the given query.

POST /api/subscription-suspension/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the subscription suspensions 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 Suspension
  • 442
    Error
    This 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.11.18.2Count

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

POST /api/subscription-suspension/count View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body
The filter which restricts the entities which are used to calculate the count.
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.11.18.3Read

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

GET /api/subscription-suspension/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the suspension which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Suspension
  • 442
    Error
    This 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.11.18.4Create

The create operation creates a new subscription suspension.

POST /api/subscription-suspension/create View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
Suspension Create
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Suspension
  • 442
    Error
    This 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.11.18.5terminate

The create operation creates a new subscription suspension.

POST /api/subscription-suspension/terminate View in Client
Query Parameters
  • spaceId
    *
    Long
  • suspensionId
    *
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Suspension
  • 442
    Error
    This 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.11.19Subscription Version Service

3.11.19.1Read

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

GET /api/subscription-version/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the subscription which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Subscription 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.11.19.2Count

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

POST /api/subscription-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.11.19.3Search

Searches for the entities as specified by the given query.

POST /api/subscription-version/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the subscriptions 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 Subscription 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.11.20Subscription ledger entry Service

3.11.20.1Create

The create operation creates a new subscription ledger entry.

POST /api/subscription-ledger-entry/create View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
Subscription Ledger Entry Create
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Subscription Ledger Entry
  • 442
    Error
    This 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.11.20.2Count

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

POST /api/subscription-ledger-entry/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.11.20.3Search

Searches for the entities as specified by the given query.

POST /api/subscription-ledger-entry/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the subscription charges 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 Subscription Ledger Entry
  • 442
    Error
    This 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.11.20.4Read

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

GET /api/subscription-ledger-entry/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the subscription charge which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Subscription Ledger Entry
  • 442
    Error
    This 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.12User

3.12.1Application User Service

3.12.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/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.12.1.2Count

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.12.1.3Create

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.12.1.4Delete

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.12.1.5Search

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.12.1.6Read

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.12.2Human User Service

3.12.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.12.2.2Create

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.12.2.3Delete

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.12.2.4Search

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.12.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.12.2.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/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.12.2.7Count

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.12.3Permission Service

3.12.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.12.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.12.4User Account Role Service

3.12.4.1Add 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.12.4.2Remove 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.12.4.3List 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.12.5User Space Role Service

3.12.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.12.5.2Add 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.12.5.3List 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.13Webhook

3.13.1Webhook Encryption Service

3.13.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

3.13.2Webhook Listener Service

3.13.2.1Create

Creates the entity with the given properties.

POST /api/webhook-listener/create View in Client
Examples 
use Wallee\Sdk\ApiClient;
use Wallee\Sdk\Model\CreationEntityState;
use Wallee\Sdk\Model\TransactionState;
use Wallee\Sdk\Model\WebhookUrlCreate;
use Wallee\Sdk\Model\WebhookListenerCreate;

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

$apiClient = new ApiClient($userId, $secret);

$data = [
// Transaction entity id
    'id' => '1472041829003',
    'name' => 'Shopname::WebHook::Transaction',
    'states' => [
        TransactionState::DECLINE,
        TransactionState::FULFILL
    ],
    'notifyEveryChange' => false,
];

// Create webhook Url
$webHookName = 'Shopname: Webhook name';
$webHookUrl = 'https://yourdomain.com/webhook/action';

$entity = (new WebhookUrlCreate())
   ->setName($webHookName)
   ->setUrl($webHookUrl)
   ->setState(CreationEntityState::ACTIVE);

$webHookUrl = $apiClient->getWebhookUrlService()->create($spaceId, $entity);

// Create a transaction webhook for transactions
// Transaction state flow is documented here: https://app-wallee.com/en/doc/payment/transaction-process
$entity = (new WebhookListenerCreate())
    ->setName($data['name'])
    ->setEntity($data['id'])
    ->setNotifyEveryChange($data['notifyEveryChange'])
    ->setState(CreationEntityState::CREATE)
    ->setEntityStates($data['states'])
    ->setUrl($webhookUrl->getId());

$apiClient->getWebhookListenerService()->create($spaceId, $entity);
package com.wallee.walleesdk;

import com.wallee.sdk.ApiClient;
import com.wallee.sdk.model.WebhookListener;
import com.wallee.sdk.model.WebhookListenerCreate;
import com.wallee.sdk.model.WebhookUrl;
import com.wallee.sdk.model.WebhookUrlCreate;
import com.wallee.sdk.service.WebhookListenerService;
import com.wallee.sdk.service.WebhookUrlService;
import org.junit.Test;

import java.util.List;

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

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


    // Services
    private ApiClient apiClient;
    private WebhookUrlService webhookUrlService;
    private WebhookListenerService webhookListenerService;

    // Models
    private WebhookUrlCreate webhookUrlPayload;
    private WebhookListenerCreate webhookListenerPayload;

    public WebhookListenerServiceTest() {
        this.apiClient = new ApiClient(applicationUserId, authenticationKey);
        this.webhookUrlService = new WebhookUrlService(this.apiClient);
        this.webhookListenerService = new WebhookListenerService(this.apiClient);
    }

    /**
     * Get webhook url payload
     *
     * @return WebHookUrlCreate
     */
    private WebhookUrlCreate getWebhookUrlPayload() {
        if (this.webhookUrlPayload == null) {
            // Web url
            WebhookUrlCreate urlCreate = new WebhookUrlCreate();
            urlCreate
                    .name("Transaction webhook url")
                    .url("http://transactions.callback-url.com");

            this.webhookUrlPayload = urlCreate;
        }
        return this.webhookUrlPayload;
    }

    /**
     * Get webhook listener payload.
     * This specific example is for transactions.
     * Transaction state flow is documented here: <a href="https://app-wallee.com/en/doc/payment/transaction-process">Transactions</a>
     *
     * @param webhookUrlId - id of an existing webhook url
     * @return WebhookListener create
     */
    private WebhookListenerCreate getWebhookListenerPayload(Long webhookUrlId) {
        if (this.webhookListenerPayload == null) {
            // Webhook listener
            WebhookListenerCreate listenerCreate  = new WebhookListenerCreate();
            listenerCreate
                    .url(webhookUrlId)
                    // Transaction entity ID
                    .entity(1472041829003L)
                    .name("Transaction webhook listener")
                    .entityStates(List.of("FULFILL", "DECLINE"))
                    .notifyEveryChange(false);

            this.webhookListenerPayload = listenerCreate;
        }
        return this.webhookListenerPayload;
    }


    /**
     * create
     *
     *
     * This operation creates a listener entity, that will listen for state changes.
     */
    public void create() {
        try {
            final WebhookUrl webhookUrl = this.webhookUrlService.create(spaceId, getWebhookUrlPayload());
            final WebhookListener webhookListener = this.webhookListenerService.create(spaceId, getWebhookListenerPayload(webhookUrl.getId()));
            // expect webhookListener.getId() to not be null
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

}
Query Parameters
  • spaceId
    *
    Long
Message Body *
The webhook listener object with the properties which should be created.
Webhook Listener Create
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Webhook Listener
  • 442
    Error
    This 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.13.2.2Delete

Deletes the entity with the given id.

POST /api/webhook-listener/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.13.2.3Search

Searches for the entities as specified by the given query.

POST /api/webhook-listener/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the webhook listeners 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 Webhook Listener
  • 442
    Error
    This 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.13.2.4Count

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

POST /api/webhook-listener/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.13.2.5Read

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

GET /api/webhook-listener/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the webhook listener which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Webhook Listener
  • 442
    Error
    This 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.13.2.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/webhook-listener/update View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The webhook listener object with all the properties which should be updated. The id and the version are required properties.
Webhook Listener Update
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Webhook Listener
  • 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.13.3Webhook Url Service

3.13.3.1Create

Creates the entity with the given properties.

POST /api/webhook-url/create View in Client
Examples 
use Wallee\Sdk\ApiClient;
use Wallee\Sdk\Model\CreationEntityState;
use Wallee\Sdk\Model\WebhookUrlCreate;

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

$apiClient = new ApiClient($userId, $secret);


// Create webhook Url
$webHookName = 'Shopname: Webhook name';
$webHookUrl = 'https://yourdomain.com/webhook/action';

$entity = (new WebhookUrlCreate())
   ->setName($webHookName)
   ->setUrl($webHookUrl)
   ->setState(CreationEntityState::ACTIVE);

$apiClient->getWebhookUrlService()->create($spaceId, $entity);
package com.wallee.walleesdk;

import com.wallee.sdk.ApiClient;
import com.wallee.sdk.model.WebhookUrl;
import com.wallee.sdk.model.WebhookUrlCreate;
import com.wallee.sdk.service.WebhookUrlService;

/**
 * API tests for WebhookUrlService
 */
public class WebhookUrlServiceTest {

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


    // Services
    private ApiClient apiClient;
    private WebhookUrlService webhookUrlService;

    // Models
    private WebhookUrlCreate webhookUrlPayload;

    public WebhookUrlServiceTest() {
        this.apiClient = new ApiClient(applicationUserId, authenticationKey);
        this.webhookUrlService = new WebhookUrlService(this.apiClient);
    }

    /**
     * Get webhook url payload
     *
     * @return WebhookUrlCreate
     */
    private WebhookUrlCreate getWebhookUrlPayload() {
        if (this.webhookUrlPayload == null) {
            // Webhook url
            WebhookUrlCreate urlCreate = new WebhookUrlCreate();
            urlCreate
                    .name("Transaction webhook url")
                    .url("http://transactions.callback-url.com");

            this.webhookUrlPayload = urlCreate;
        }
        return this.webhookUrlPayload;
    }

    /**
     * create
     *
     *
     * This operation creates a webhook url entity, that will be used for posting.
     */
    public void create() {
        try {
            final WebhookUrl webhookUrl = this.webhookUrlService.create(spaceId, getWebhookUrlPayload());
            // expect webhookUrl.getUrl() to be a URL beginning with https://
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

}
Query Parameters
  • spaceId
    *
    Long
Message Body *
The webhook url object with the properties which should be created.
Webhook URL Create
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Webhook URL
  • 442
    Error
    This 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.13.3.2Read

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

GET /api/webhook-url/read View in Client
Query Parameters
  • spaceId
    *
    Long
  • id
    *
    The id of the webhook url which should be returned.
    Long
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Webhook URL
  • 442
    Error
    This 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.13.3.3Count

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

POST /api/webhook-url/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.13.3.4Delete

Deletes the entity with the given id.

POST /api/webhook-url/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.13.3.5Search

Searches for the entities as specified by the given query.

POST /api/webhook-url/search View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The query restricts the webhook urls 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 Webhook URL
  • 442
    Error
    This 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.13.3.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/webhook-url/update View in Client
Query Parameters
  • spaceId
    *
    Long
Message Body *
The webhook url object with all the properties which should be updated. The id and the version are required properties.
Webhook URL Update
Responses
  • 200
    OK
    This status code indicates that a client request was successfully received, understood, and accepted.
    Webhook URL
  • 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

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

4.1.1Analytics Query Details

Properties
  • accountId
    *
    The ID of the account in which the query is to be executed.
    Long
  • externalId
    A client-generated nonce which uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.
    String
  • maxCacheAge
    The maximum age (in minutes) of queries already executed that are to be taken into account. If an equivalent query is already available and not older than the specified age, its result will be returned instead of re-executing it. To force a new execution, specify a new, unique external ID and no maximum cache age.
    Integer
  • queryString
    1 - 4,096 options
    The PrestoDB/Athena SQL statement to be executed.
    String
  • scannedDataLimit
    The maximum amount of data that the query is allowed to scan. After the limit is reached, the query will be canceled.
    Decimal
  • spaceIds
    ≤ 5 options
    The IDs of the spaces belonging to the specified account in which the query is to be executed. Do not provide any value to query all spaces in the specified account.
    Collection of Long

4.1.2Analytics Schema Column Info Details

Meta information about a column within a table.

Properties
  • aliasName
    The name of the alias defined for the column in the query or null if none is defined.
    String
  • columnName
    The name of the column in the table or null if this is a synthetic column which is the result of some SQL expression.
    String
  • description
    The localized description of the property contained in this column or null if this is a synthetic column which is the result of some SQL expression.
    Map of String String
  • precision
    The precision (maximal number of digits) for decimal data types, otherwise 0.
    Integer
  • referencedTable
    The name of the referenced table if this column represents a foreign-key relation to another table, otherwise null.
    String
  • scale
    The scale (maximal number of digits in the fractional part) in case of a decimal data type, otherwise 0.
    Integer
  • tableName
    The name of the table that the column belongs to.
    String
  • type
    The ORC data type of the column value.
    String

4.1.3Analytics Schema Info Details

The schema of a single table in Analytics.

Properties
  • columns
    The schemas of all columns of the table.
    Collection of Analytics Schema Column Info
  • description
    The localized description of the table.
    Map of String String
  • tableName
    The name of the table.
    String

4.1.4Query Execution Details

Represents the execution of a query which has been submitted to Analytics.

Properties
  • account
    The account in which the query is executed.
    Long
    Account
  • errorMessage
    The error message that describes the reason for the failure of the query execution.
    String
  • externalId
    The external ID of the query if one was specified, otherwise null.
    String
  • failureReason
    The reason for the failure of query execution.
    Failure Reason
  • id
    A unique identifier for the object.
    Long
  • processingEndTime
    The date and time when the processing of the query was completed. Null if the query execution has not yet been completed.
    DateTime
  • processingStartTime
    The date and time when the processing of the query was started.
    DateTime
  • queryString
    The SQL statement which has been submitted for execution.
    String
  • scannedDataInGb
    The amount of data that was scanned when processing the query (in GB).
    Decimal
  • scannedDataLimit
    The maximal amount of data that this query is allowed to scan (in GB). If this limit is reached, the query will be canceled.
    Decimal
  • spaces
    The spaces in which the query is executed. May be empty if all spaces of the specified account have been queried.
    Collection of Long
    Space
  • state
    The current state of the query execution.
    Query Execution State

4.1.5Query Execution State

The state of a query execution.

Fields
  • PROCESSING
    Processing
    The query is being processed.
  • PROCESSED
    Processed
    The query has been successfully processed and the result is ready to be fetched. This is a final state.
  • FAILED
    Failed
    Processing of the query has failed. This is a final state.
  • CANCELED
    Canceled
    Processing of the query has been canceled. This is a final state.

4.1.6Query Result Batch Details

A batch of the result of a query executed in Analytics.

Properties
  • columns
    The schemas of the columns returned by the query (in order).
    Collection of Analytics Schema Column Info
  • nextToken
    The token to fetch the next batch of results. Null if no more results are available.
    String
  • queryExecution
    The query execution that produced the result.
    Query Execution
  • rows
    The resulting rows contained in this batch where each row is a list of column values.
    Collection of Collection of String

4.2Core

4.2.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.2.2Account State

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

4.2.3Account Type

Fields
  • MASTER
    Master
  • REGULAR
    Regular
  • SUBACCOUNT
    Subaccount

4.2.4Creation Entity State

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

4.2.5Criteria 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.2.6Database 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.2.7Environment

Fields
  • LIVE
    Live
  • PREVIEW
    Preview

4.2.8Failure Category

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

4.2.9Failure Reason Details

Properties
  • category
    The category that the failure reason belongs to.
    Failure Category
  • 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.2.10Feature 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.2.11Feature 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.2.12Line 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.2.13Metric Usage Details

The metric usage provides details about the consumption of a particular metric.

Properties
  • consumedUnits
    The number of consumed units.
    Decimal
  • metricDescription
    The description of the consumed unit's metric.
    Map of String String
  • metricId
    The ID of the consumed units' metric.
    Long
  • metricName
    The name of the consumed units' metric.
    Map of String String

4.2.14Resource 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.2.15Resource State

Fields
  • ACTIVE
    Active
  • DELETING
    Deleting
  • DELETED
    Deleted

4.2.16Scope 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.2.17Space 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.2.18Space 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.2.19Space Reference Details

Properties
  • createdOn
    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
  • spaceId
    Long
    Space
  • state
    The object's current state.
    Space Reference State
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.2.20Space Reference State

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

4.2.21Space 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 name used to identify the space view.
    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 that the space 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.2.22Web App Confirmation Request Details

Properties
  • code
    ≤ 100 chars
    The user returns to the web app after granting the permission. The HTTP request contains the code. Provide it here to confirm the web app installation.
    String

4.3Customer

4.3.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.3.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.3.3Customer Address Type

Fields
  • BILLING
    Billing
  • SHIPPING
    Shipping
  • BOTH
    Both

4.3.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.3.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.4Debt Collection

4.4.1Debt Collection Case Details

The debt collection case represents a try to collect the money from the debtor.

Properties
  • amount
    The sum of all unpaid item prices in the case's currency. The amount can no longer be changed once the case has been reviewed.
    Decimal
  • billingAddress
    The billing address that identifies the debtor.
    Address
  • closedOn
    The date and time when the case was closed.
    DateTime
  • collectorConfiguration
    The configuration that the case is processed with.
    Debt Collector Configuration
  • contractDate
    The date and time when the contract with the debtor was signed.
    DateTime
  • createdOn
    The date and time when the object was created.
    DateTime
  • creator
    The ID of the user the case was created by.
    Long
    User
  • currency
    The three-letter code (ISO 4217 format) of the case's currency.
    String
  • dueDate
    The date and time when the claim was due.
    DateTime
  • environment
    The environment in which the case is processed.
    Debt Collection Environment
  • 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
    The date and time when the case failed.
    DateTime
  • failureReason
    The reason for the failure of the case.
    Failure Reason
  • id
    A unique identifier for the object.
    Long
  • labels
    The labels providing additional information about the object.
    Collection of Label
  • language
    The language that is linked to the object.
    String
  • lineItems
    The line items that are subject of this debt collection case.
    Collection of Line Item
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • nextAttemptOn
    The date and time when the next attempt at processing the case will be made.
    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
  • processingStartedOn
    The date and time when the processing of the case was started.
    DateTime
  • processingTimeoutOn
    The date and time when the processing of the case times out.
    DateTime
  • reference
    A unique reference to identify the debt collection case in communication with the debtor.
    String
  • reviewStartedOn
    The date and time when the review of the case was started.
    DateTime
  • reviewedOn
    The date and time when the case was reviewed.
    DateTime
  • reviewer
    The ID of the user the case was reviewed by.
    Long
    User
  • source
    The source of the case stating the origin of the claim.
    Debt Collection Case Source
  • sourceEntityId
    The ID of the object that is the source of the case. Only defined if the case was created by an internal process.
    Long
  • spaceViewId
    The ID of the space view this object is linked to.
    Long
    Space View
  • state
    The object's current state.
    Debt Collection Case State
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.4.2Debt Collection Case Document Details

Properties
  • createdOn
    The date and time when the object was created.
    DateTime
  • debtCollectionCase
    The debt collection case that this document belongs to.
    Long
    Debt Collection Case
  • fileName
    ≤ 100 chars
    The file name of the document.
    String
  • id
    A unique identifier for the object.
    Long
  • labels
    The labels providing additional information about the object.
    Collection of Label
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • mimeType
    The MIME type of the document's content.
    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
  • uniqueId
    ≤ 500 chars
    A unique identifier of the document.
    String
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.4.3Debt Collection Case Source Details

The debt collection case source represents the origin of the case. It allows to understand where the amount receivable is coming from.

Properties
  • description
    The localized description of the object.
    Map of String String
  • forcedPreparingState
    Whether debt collection cases created from this source will skip review and directly enter preparing state.
    Boolean
  • id
    A unique identifier for the object.
    Long
  • name
    The localized name of the object.
    Map of String String

4.4.4Debt Collection Case State

Fields
  • CREATE
    Create
  • PREPARING
    Preparing
  • REVIEWING
    Reviewing
  • PENDING
    Pending
  • PROCESSING
    Processing
  • CLOSED
    Closed
  • FAILED
    Failed

4.4.5Debt Collection Environment

Fields
  • PRODUCTION
    Production
  • TEST
    Test

4.4.6Debt Collection Receipt Details

Properties
  • amount
    The amount that was collected.
    Decimal
  • createdBy
    The ID of the user the receipt was created by.
    Long
    User
  • createdOn
    The date and time when the object was created.
    DateTime
  • debtCollectionCase
    The debt collection case that this document belongs to.
    Long
    Debt Collection Case
  • externalId
    1 - 100 chars
    A client-generated nonce which uniquely identifies the receipt.Subsequent requests with the same external ID do not lead to the creation of another receipt, but return the original one.
    String
  • 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
  • source
    The source stating where the receipt is coming from.
    Long
    Debt Collection Receipt Source
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.4.7Debt Collection Receipt Source Details

The debt collection receipt source represents the origin of a particular part of the collected amount. It allows to understand from where the amount is coming from, e.g. if it was added manually or in some other way.

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.4.8Debt Collector Details

The debt collector connects to an external service to process debt collection cases and directs the debt collection process.

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.4.9Debt Collector Condition Details

A condition controls under which circumstances a collector configuration is applied to a debt collection case.

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 name used to identify the condition.
    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
  • type
    The condition type determines the criteria that a debt collection case must fulfill in order for a debt collector configuration to be considered for handling the case.
    Long
    Debt Collector Condition Type
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.4.10Debt Collector Condition 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.4.11Debt Collector Configuration Details

The debt collector configuration defines the behavior of the collection process for a particular collector.

Properties
  • collector
    The debt collector that the configuration is for.
    Long
    Debt Collector
  • conditions
    Conditions allow to define criteria that a debt collection case must fulfill in order for the debt collector configuration to be considered for processing the case.
    Collection of Long
    Debt Collector Condition
  • enabledSpaceViews
    The space views for which the debt collector configuration is enabled. If empty, it is enabled for all space views.
    Collection of Long
  • 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 name used to identify the debt collector configuration.
    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 that determines the order in which debt collector configurations are taken into account when processing a case. Low values are considered first.
    Integer
  • skipReviewEnabled
    Whether the review of debt collection cases is skipped.
    Boolean
  • 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.5Document

4.5.1Document Template Details

A document template contains the customizations for a particular document template type.

Properties
  • defaultTemplate
    Whether this is the default document template which is used whenever no specific template is specified for the same template type.
    Boolean
  • deliveryEnabled
    Whether documents of this template should be delivered.
    Boolean
  • 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 name used to identify the document template.
    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
    The ID of the space this object belongs to.
    Long
    Space
  • state
    The object's current state.
    Creation Entity State
  • templateResource
    The resource path to a custom template to be used to generate PDF documents.
    Resource Path
  • type
    The document template's type.
    Long
    Document Template Type
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.5.2Document Template Type Details

Properties
  • description
    The localized description of the document template type.
    Map of String String
  • feature
    The feature that this document template type belongs to.
    Long
    Feature
  • group
    The group that this document template type belongs to.
    Document Template Type Group
  • id
    A unique identifier for the object.
    Long
  • title
    The localized title of the document template type.
    Map of String String

4.5.3Document Template Type Group Details

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

4.5.4Rendered Document Details

Properties

4.6Entity Query

4.6.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.6.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.6.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.6.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.6.5Entity Query Order By Details

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

Properties

4.6.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.7Error

4.7.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.7.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.7.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.8Installment

4.8.1Installment Calculated Plan Details

Properties

4.8.2Installment Calculated Slice Details

Properties
  • amountIncludingTax
    Decimal
  • dueOn
    DateTime
  • lineItems
    Collection of Line Item

4.8.3Installment Payment Details

An installment payment represents a payment paid in multiple slices.

Properties
  • createdOn
    The date and time when the object was created.
    DateTime
  • id
    A unique identifier for the object.
    Long
  • initialTransaction
    Transaction
  • lineItems
    Collection of Line Item
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • planConfiguration
    Long
    Installment Plan
  • 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.
    Installment Payment State
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.8.4Installment Payment Slice Details

An installment payment slice represents a single transaction of money from the buyer to the merchant.

Properties
  • chargeOn
    DateTime
  • createdOn
    The date and time when the object was created.
    DateTime
  • id
    A unique identifier for the object.
    Long
  • installmentPayment
    Installment Payment
  • lineItems
    Collection of Line Item
  • 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.
    Installment Payment Slice State
  • transaction
    Transaction
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.8.5Installment Payment Slice State

Fields
  • CREATE
    Create
  • SCHEDULED
    Scheduled
  • CANCELED
    Canceled
  • PREPARE_PROCESSING
    Prepare Processing
  • PROCESSING
    Processing
  • FAILED
    Failed
  • SUCCESSFUL
    Successful

4.8.6Installment Payment State

Fields
  • CREATE
    Create
  • CONFIRMED
    Confirmed
  • AUTHORIZED
    Authorized
  • REJECTED
    Rejected
  • COMPLETED
    Completed
  • RUNNING
    Running
  • DONE
    Done
  • DEFAULTED
    Defaulted

4.8.7Installment Plan Details

The installment plan allows to setup a template for an installment.

Properties
  • baseCurrency
    The base currency in which the installment fee and minimal amount are defined.
    String
  • conditions
    If a transaction meets all selected conditions the installment plan will be available to the customer to be selected.
    Collection of Long
    Payment Connector Condition
  • id
    A unique identifier for the object.
    Long
  • installmentFee
    The installment fee is a fixed amount that is charged additionally when applying this installment plan.
    Decimal
  • interestRate
    The interest rate is a percentage of the total amount that is charged additionally when applying this installment plan.
    Decimal
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • minimalAmount
    The installment plan can only be applied if the order's total is at least the defined minimal amount.
    Decimal
  • name
    ≤ 100 chars
    The installment plan name is used internally to identify the plan in administrative interfaces.For example it is used within search fields and hence it should be distinct and descriptive.
    String
  • paymentMethodConfigurations
    A installment plan can be enabled only for specific payment method configurations. Other payment methods will not be selectable by the buyer.
    Collection of Long
    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
  • sortOrder
    The sort order controls in which order the installation plans are listed. The sort order is used to order the plans in ascending order.
    Integer
  • spaceReference
    Space Reference
  • state
    The object's current state.
    Creation Entity State
  • taxClass
    The tax class determines the taxes which are applicable on all fees linked to the installment plan.
    Tax Class
  • termsAndConditions
    The terms and conditions will be displayed to the customer when he or she selects this installment plan.
    Resource Path
  • title
    The title of the installment plan is used within the payment process. The title is visible to the buyer.
    Map of String String
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.8.8Installment Plan Slice Details

The installment plan slice defines a single slice of an installment plan.

Properties
  • id
    A unique identifier for the object.
    Long
  • lineItemTitle
    The title of this slice's line items. The title is visible to the buyer.
    Map of String String
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • period
    The period defines how much time passes between the last slice and this slice. The charge is triggered at the end of the period. When the slice should be charged immediately the period needs to be zero.
    String
  • plan
    The installment plan this slice belongs to.
    Installment Plan
  • 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 controls in which order the slices are applied. The lower the value the higher the precedence.
    Integer
  • proportion
    ≥ 1
    The proportion defines how much of the total installment payment has to be paid in this slice. The value is summed up with the other slices and the ratio of all proportions compared to proportion of this slice determines how much the buyer has to pay in this slice.
    Decimal
  • 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.9Internationalization

4.9.1Address 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.9.2Address 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.9.3Address 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.9.4Country 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.9.5Currency 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.9.6Gender

Fields
  • MALE
    Male
  • FEMALE
    Female

4.9.7Language 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.9.8Legal 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.9.9Localized String Details

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

4.9.10Persistable Currency Amount Details

Properties
  • amount
    Decimal
  • currency
    String

4.9.11State 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.10Label

4.10.1Label Details

Properties
  • content
    The label's actual content.
    Object
  • contentAsString
    The label's content formatted as string.
    String
  • descriptor
    The descriptor that describes what information the label provides.
    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.10.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.10.3Label Descriptor Category

Fields
  • HUMAN
    Human
  • APPLICATION
    Application

4.10.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.10.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.10.6Static Value Details

Properties
  • description
    The localized description of the object.
    Map of String String
  • features
    The features that this static value 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.11Line Item

4.11.1Line Item Details

Properties
  • aggregatedTaxRate
    Virtual
    The total tax rate applied to the item, calculated from the rates of all tax lines.
    Decimal
  • amountExcludingTax
    Virtual
    The line item price with discounts applied, excluding taxes.
    Decimal
  • amountIncludingTax
    Virtual
    The line item price with discounts applied, including taxes.
    Decimal
  • attributes
    A map of custom information for the item.
    Map of String Line Item Attribute
  • discountExcludingTax
    Virtual
    The discount allocated to the item, excluding taxes.
    Decimal
  • discountIncludingTax
    The discount allocated to the item, including taxes.
    Decimal
  • name
    1 - 150 chars
    The name of the product, ideally in the customer's language.
    String
  • quantity
    Positive
    The number of items that were purchased.
    Decimal
  • shippingRequired
    Whether the item required shipping.
    Boolean
  • sku
    ≤ 200 chars
    The SKU (stock-keeping unit) of the product.
    String
  • taxAmount
    Virtual
    The sum of all taxes applied to the item.
    Decimal
  • taxAmountPerUnit
    Virtual
    The calculated tax amount per unit.
    Decimal
  • taxes
    A set of tax lines, each of which specifies a tax applied to the item.
    Collection of Tax
  • type
    The type of the line item.
    Line Item Type
  • undiscountedAmountExcludingTax
    Virtual
    The line item price with discounts not applied, excluding taxes.
    Decimal
  • undiscountedAmountIncludingTax
    Virtual
    The line item price with discounts not applied, including taxes.
    Decimal
  • undiscountedUnitPriceExcludingTax
    Virtual
    The calculated price per unit with discounts not applied, excluding taxes.
    Decimal
  • undiscountedUnitPriceIncludingTax
    Virtual
    The calculated price per unit with discounts not applied, including taxes.
    Decimal
  • uniqueId
    ≤ 200 chars
    The unique identifier of the line item within the set of line items.
    String
  • unitPriceExcludingTax
    Virtual
    The calculated price per unit with discounts applied, excluding taxes.
    Decimal
  • unitPriceIncludingTax
    Virtual
    The calculated price per unit with discounts applied, including taxes.
    Decimal

4.11.2Line Item Attribute Details

Properties
  • label
    ≤ 512 chars
    The label describing the line item attribute.
    String
  • value
    ≤ 512 chars
    The value of the line item attribute.
    String

4.11.3Line Item Type

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

4.12Manual Task

4.12.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.12.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.12.3Manual Task Action Style

Fields
  • DEFAULT
    Default
  • PRIMARY
    Primary
  • DANGER
    Danger

4.12.4Manual Task State

Fields
  • OPEN
    Open
  • DONE
    Done
  • EXPIRED
    Expired

4.12.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.13Payment

4.13.1Address Handling Mode

The address handling mode controls if the address is required and how it is enforced to be provided.

Fields
  • NOT_REQUIRED
    Not Required
  • REQUIRED_IN_URL
    Required In Url
  • REQUIRED_ON_PAYMENT_PAGE
    Required On Payment Page

4.13.2Authenticated Card Data Details

This model holds the card data and optional cardholder authentication details.

Properties
  • cardHolderName
    ≤ 100 chars
    The card holder name is the name printed onto the card. It identifies the person who owns the card.
    String
  • cardVerificationCode
    3 - 4 chars
    ([0-9 ]+)
    The card verification code (CVC) is a 3 to 4 digit code typically printed on the back of the card. It helps to ensure that the card holder is authorizing the transaction. For card not-present transactions this field is optional.
    String
  • cardholderAuthentication
    The cardholder authentication information. The authentication is optional and can be provided if the cardholder has been already authenticated (e.g. in 3-D Secure system).
    Cardholder Authentication
  • cryptogram
    The additional authentication value used to secure the tokenized card transactions.
    Card Cryptogram
  • expiryDate
    ([0-9]{4})\-(11|12|10|0[1-9]{1})
    The card expiry date indicates when the card expires. The format is the format yyyy-mm where yyyy is the year (e.g. 2019) and the mm is the month (e.g. 09).
    String
  • panType
    Pan Type
  • primaryAccountNumber
    *
    10 - 30 chars
    ([0-9 ]+)
    The primary account number (PAN) identifies the card. The number is numeric and typically printed on the front of the card.
    String
  • recurringIndicator
    Recurring Indicator
  • schemeTransactionReference
    ≤ 100 chars
    String
  • tokenRequestorId
    String

4.13.3Authenticated Card Data Details

This model holds the card data and optional cardholder authentication details.

Properties
  • cardHolderName
    ≤ 100 chars
    The card holder name is the name printed onto the card. It identifies the person who owns the card.
    String
  • cardVerificationCode
    3 - 4 chars
    ([0-9 ]+)
    The card verification code (CVC) is a 3 to 4 digit code typically printed on the back of the card. It helps to ensure that the card holder is authorizing the transaction. For card not-present transactions this field is optional.
    String
  • cardholderAuthentication
    The cardholder authentication information. The authentication is optional and can be provided if the cardholder has been already authenticated (e.g. in 3-D Secure system).
    Cardholder Authentication
  • cryptogram
    The additional authentication value used to secure the tokenized card transactions.
    Card Cryptogram
  • expiryDate
    ([0-9]{4})\-(11|12|10|0[1-9]{1})
    The card expiry date indicates when the card expires. The format is the format yyyy-mm where yyyy is the year (e.g. 2019) and the mm is the month (e.g. 09).
    String
  • initialRecurringTransaction
    Boolean
  • panType
    Pan Type
  • primaryAccountNumber
    10 - 30 chars
    ([0-9 ]+)
    The primary account number (PAN) identifies the card. The number is numeric and typically printed on the front of the card.
    String
  • recurringIndicator
    Recurring Indicator
  • schemeTransactionReference
    ≤ 100 chars
    String
  • tokenRequestorId
    String

4.13.4Bank Account Details

Properties
  • description
    ≤ 100 chars
    The optional description is shown along the identifier. The intention of the description is to give an alternative name to the bank account.
    String
  • id
    A unique identifier for the object.
    Long
  • identifier
    ≤ 100 chars
    The bank account identifier is responsible to uniquely identify the bank account.
    String
  • linkedSpaceId
    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.
    Bank Account State
  • type
    Long
    Bank Account Type
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.13.5Bank Account Environment

Fields
  • PRODUCTION
    Production
  • TEST
    Test

4.13.6Bank Account State

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

4.13.7Bank Account Type Details

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

4.13.8Bank Transaction Details

Properties
  • adjustments
    The adjustments applied on this bank transaction.
    Collection of Payment Adjustment
  • createdBy
    The created by indicates the user which has created the bank transaction.
    Long
    User
  • createdOn
    The date and time when the object was created.
    DateTime
  • currencyBankAccount
    The currency bank account which is used to handle money flow.
    Currency Bank Account
  • externalId
    1 - 100 chars
    String
  • flowDirection
    Virtual
    Bank Transaction Flow Direction
  • id
    A unique identifier for the object.
    Long
  • linkedSpaceId
    The ID of the space this object belongs to.
    Long
    Space
  • paymentDate
    The payment date describes the date when the transaction was made.
    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
  • postingAmount
    The posting amount indicates the amount including adjustments.
    Decimal
  • reference
    String
  • source
    Long
    Bank Transaction Source
  • state
    The object's current state.
    Bank Transaction State
  • totalAdjustmentAmountIncludingTax
    Virtual
    Decimal
  • type
    Long
    Bank Transaction Type
  • valueAmount
    Decimal
  • valueDate
    The value date describes the date the amount is effective on the account.
    DateTime
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.13.9Bank Transaction Flow Direction

Fields
  • INFLOW
    Inflow
  • OUTFLOW
    Outflow

4.13.10Bank Transaction Source 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.13.11Bank Transaction State

Fields
  • UPCOMING
    Upcoming
  • SETTLED
    Settled

4.13.12Bank Transaction 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.13.13Card Authentication Response

Fields
  • FULLY_AUTHENTICATED
    Fully Authenticated
  • AUTHENTICATION_NOT_REQUIRED
    Authentication Not Required
  • NOT_ENROLLED
    Not Enrolled
  • ENROLLMENT_ERROR
    Enrollment Error
  • AUTHENTICATION_ERROR
    Authentication Error

4.13.14Card Authentication Version

This model defines the card authentication versions.

Fields
  • V1
    V1
  • V2
    V2

4.13.15Card Cryptogram Details

This model holds the additional card authentication.

Properties
  • eci
    String
  • value
    *
    String

4.13.16Card Cryptogram Details

This model holds the additional card authentication.

Properties
  • eci
    String
  • value
    String

4.13.17Cardholder Authentication Details

This model holds the cardholder authentication data (e.g. 3-D Secure authentication).

Properties
  • authenticationIdentifier
    The authentication identifier as assigned by authentication system (e.g. XID or DSTransactionID).
    String
  • authenticationResponse
    *
    Card Authentication Response
  • authenticationValue
    The cardholder authentication value. Also known as Cardholder Authentication Verification Value (CAVV).
    String
  • electronicCommerceIndicator
    The Electronic Commerce Indicator (ECI) value. The ECI is returned by authentication system and indicates the outcome/status of authentication.
    String

4.13.18Cardholder Authentication Details

This model holds the cardholder authentication data (e.g. 3-D Secure authentication).

Properties
  • authenticationIdentifier
    The authentication identifier as assigned by authentication system (e.g. XID or DSTransactionID).
    String
  • authenticationResponse
    Card Authentication Response
  • authenticationValue
    The cardholder authentication value. Also known as Cardholder Authentication Verification Value (CAVV).
    String
  • electronicCommerceIndicator
    The Electronic Commerce Indicator (ECI) value. The ECI is returned by authentication system and indicates the outcome/status of authentication.
    String
  • version
    Card Authentication Version

4.13.19Charge 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
    The ID of the space view this object is linked to.
    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.13.20Charge Attempt Details

Properties
  • charge
    Charge
  • completionBehavior
    Transaction Completion Behavior
  • connectorConfiguration
    Payment Connector Configuration
  • createdOn
    The date and time when the object was created.
    DateTime
  • customersPresence
    The customer's presence indicates which kind of customer interaction was used during the charge attempt.
    Customer's Presence
  • environment
    Charge Attempt Environment
  • failedOn
    DateTime
  • failureReason
    Failure Reason
  • id
    A unique identifier for the object.
    Long
  • initializingTokenVersion
    Boolean
  • invocation
    Connector Invocation
  • labels
    The labels providing additional information about the object.
    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
    The ID of the space view this object is linked to.
    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.13.21Charge Attempt Environment

Fields
  • PRODUCTION
    Production
  • TEST
    Test

4.13.22Charge Attempt State

Fields
  • PROCESSING
    Processing
  • FAILED
    Failed
  • SUCCESSFUL
    Successful

4.13.23Charge Bank Transaction Details

Properties
  • bankTransaction
    Bank Transaction
  • completion
    Long
    Transaction Completion
  • 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
  • linkedTransaction
    Virtual
    Long
    Transaction
  • spaceViewId
    The ID of the space view this object is linked to.
    Long
    Space View
  • transaction
    Transaction
  • transactionCurrencyAmount
    Specify the posting amount in the transaction's currency.
    Decimal
  • transactionCurrencyValueAmount
    Virtual
    Decimal
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.13.24Charge 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
    Payment Connector 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.13.25Charge 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.13.26Charge 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.13.27Charge 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.13.28Charge 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.13.29Charge Flow Level State

Fields
  • PENDING
    Pending
  • FAILED
    Failed
  • SUCCESSFUL
    Successful

4.13.30Charge State

Fields
  • PENDING
    Pending
  • FAILED
    Failed
  • SUCCESSFUL
    Successful

4.13.31Charge Type

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

4.13.32Completion Line Item Details

Properties
  • amount
    The total amount of the line item including any tax.
    Decimal
  • quantity
    Positive
    The quantity of the line item which should be completed.
    Decimal
  • uniqueId
    ≤ 200 chars
    The unique id identifies the line item on which the capture is applied on.
    String

4.13.33Connector 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.13.34Connector Invocation Stage

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

4.13.35Currency Bank Account Details

Properties
  • bankAccount
    Bank Account
  • currency
    String
  • environment
    Bank Account Environment
  • id
    A unique identifier for the object.
    Long
  • linkedSpaceId
    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.13.36Customer's Presence

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

4.13.37Data Collection Type

Fields
  • ONSITE
    Onsite
  • OFFSITE
    Offsite

4.13.38Delivery Indication Details

Properties
  • automaticDecisionReason
    Delivery Indication Decision Reason
  • automaticallyDecidedOn
    DateTime
  • completion
    Long
    Transaction Completion
  • 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
  • manualDecisionTimeoutOn
    DateTime
  • manuallyDecidedBy
    Long
  • manuallyDecidedOn
    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
  • state
    The object's current state.
    Delivery Indication State
  • timeoutOn
    DateTime
  • transaction
    Transaction

4.13.39Delivery Indication Decision Reason 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.13.40Delivery Indication State

Fields
  • PENDING
    Pending
  • NOT_SUITABLE
    Not Suitable
  • MANUAL_CHECK_REQUIRED
    Manual Check Required
  • SUITABLE
    Suitable

4.13.41External Transfer Bank Transaction Details

Properties
  • bankTransaction
    Bank Transaction
  • externalAccountIdentifier
    String
  • externalAccountType
    String
  • externalBankName
    String
  • id
    A unique identifier for the object.
    Long
  • linkedSpaceId
    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.13.42Final 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.13.43Internal Transfer Bank Transaction Details

Properties
  • id
    A unique identifier for the object.
    Long
  • linkedSpaceId
    The ID of the space this object belongs to.
    Long
    Space
  • sourceBankTransaction
    Bank Transaction
  • targetBankTransaction
    Bank Transaction
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.13.44Invoice Reconciliation Record Details

Properties

4.13.45Invoice Reconciliation Record Details

Properties
  • address
    String
  • amount
    Decimal
  • city
    String
  • country
    String
  • createdOn
    The date and time when the object was created.
    DateTime
  • currency
    String
  • discardedBy
    Long
  • discardedOn
    The discarded on date indicates when the bank transaction has been discarded.
    DateTime
  • environment
    Charge Attempt Environment
  • familyName
    String
  • givenName
    String
  • iban
    ≤ 100 chars
    String
  • id
    A unique identifier for the object.
    Long
  • lastResolutionFailure
    Failure Reason
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • linkedTransaction
    Virtual
    Long
    Transaction
  • participantNumber
    ≤ 100 chars
    String
  • paymentFeeAmount
    Decimal
  • paymentFeeCurrency
    String
  • paymentReason
    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
  • postCode
    String
  • referenceNumber
    ≤ 255 chars
    String
  • rejectionStatus
    Invoice Reconciliation Record Rejection Status
  • resolvedBy
    Long
  • resolvedOn
    The resolved on date indicates when the bank transaction has been resolved.
    DateTime
  • senderBankAccount
    String
  • state
    The object's current state.
    Invoice Reconciliation Record State
  • street
    String
  • type
    Invoice Reconciliation Record Type
  • uniqueId
    ≤ 500 chars
    String
  • valueDate
    DateTime
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.13.46Invoice Reconciliation Record Rejection Status

Fields
  • NONE
    None
  • REJECTED
    Rejected
  • BULK_REJECTED
    Bulk Rejected

4.13.47Invoice Reconciliation Record State

Fields
  • CREATE
    Create
  • PENDING
    Pending
  • UNRESOLVED
    Unresolved
  • RESOLVED
    Resolved
  • DISCARDED
    Discarded

4.13.48Invoice Reconciliation Record 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.13.49Invoice Reimbursement Details

Properties
  • amount
    Decimal
  • createdOn
    The date and time when the object was created.
    DateTime
  • currency
    String
  • discardedBy
    Long
  • discardedOn
    DateTime
  • id
    A unique identifier for the object.
    Long
  • linkedSpaceId
    The ID of the space this object belongs to.
    Long
    Space
  • paymentConnectorConfiguration
    Payment Connector Configuration
  • paymentInitiationAdviceFile
    Payment Initiation Advice File
  • processedBy
    Long
  • processedOn
    DateTime
  • recipientCity
    String
  • recipientCountry
    String
  • recipientFamilyName
    String
  • recipientGivenName
    String
  • recipientIban
    String
  • recipientOrganizationName
    String
  • recipientPostcode
    String
  • recipientStreet
    String
  • senderIban
    String
  • state
    The object's current state.
    Invoice Reimbursement State
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.13.50Invoice Reimbursement Details

Properties
  • amount
    Decimal
  • createdOn
    The date and time when the object was created.
    DateTime
  • currency
    String
  • discardedBy
    Long
  • discardedOn
    DateTime
  • id
    A unique identifier for the object.
    Long
  • linkedSpaceId
    The ID of the space this object belongs to.
    Long
    Space
  • paymentConnectorConfiguration
    Payment Connector Configuration
  • paymentInitiationAdviceFile
    Payment Initiation Advice File
  • processedBy
    Long
  • processedOn
    DateTime
  • recipientCity
    String
  • recipientCountry
    String
  • recipientFamilyName
    String
  • recipientGivenName
    String
  • recipientIban
    String
  • recipientOrganizationName
    String
  • recipientPostcode
    String
  • recipientStreet
    String
  • refundMerchantReference
    String
  • senderIban
    String
  • state
    The object's current state.
    Invoice Reimbursement State
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.13.51Invoice Reimbursement State

Fields
  • PENDING
    Pending
  • MANUAL_REVIEW
    Manual Review
  • PROCESSING
    Processing
  • PROCESSED
    Processed
  • DISCARDED
    Discarded

4.13.52One Click Payment Mode

Fields
  • DISABLED
    Disabled
  • ALLOW
    Allow
  • FORCE
    Force

4.13.53Pan Type

Fields
  • PLAIN
    Plain
  • SCHEME_TOKEN
    Scheme Token
  • SCHEME_TOKEN_CLICK_TO_PAY
    Scheme Token Click To Pay
  • DEVICE_TOKEN_APPLE_PAY
    Device Token Apple Pay
  • DEVICE_TOKEN_GOOGLE_PAY
    Device Token Google Pay
  • DEVICE_TOKEN_SAMSUNG_PAY
    Device Token Samsung Pay
  • DEVICE_TOKEN_ANDROID_PAY
    Device Token Android Pay

4.13.54Payment Adjustment Details

Properties
  • amountExcludingTax
    Virtual
    Decimal
  • amountIncludingTax
    The total amount of this adjustment including taxes.
    Decimal
  • id
    A unique identifier for the object.
    Long
  • rateInPercentage
    ≤ 100
    The rate in percentage is the rate on which the adjustment amount was calculated with.
    Decimal
  • tax
    Tax
  • type
    Long
    Payment Adjustment Type

4.13.55Payment Adjustment 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.13.56Payment App Charge Attempt Target State

The target state indicates the state that should be set on the charge attempt.

Fields
  • SUCCESSFUL
    Successful
  • FAILED
    Failed

4.13.57Payment App Charge Attempt Update Request Details

The charge attempt update request allows to change the state of a charge attempt. The charge attempt must be linked with a processor that was created by the payment Web App that invokes the operation.

Properties
  • chargeAttemptId
    This is the ID of the charge attempt that should be updated.
    Long
    Charge Attempt
  • endUserFailureMessage
    ≤ 2,000 chars
    The end user failure message indicates to the end user (buyer) why the payment failed. The message has to be in the language of the end user. The language is provided within the payment page invocation URL.
    String
  • failureReasonId
    The failure reason indicates why the charge attempt failed. It is required when the target state is FAILED.
    Long
    Failure Reason
  • reference
    ≤ 100 chars
    The reference identifies the charge attempt within the systems of the external service provider. It is required when the target state is SUCCESSFUL.
    String
  • targetState
    The target state defines the state into which the charge attempt should be switched into. Once the charge attempt changed the state it will not be possible to change it again.
    Payment App Charge Attempt Target State

4.13.58Payment App Completion Configuration Details

Properties
  • completionEndpoint
    URL
    The completion endpoint is invoked to request the payment service provider to execute a completion.
    String
  • completionTimeoutInMinutes
    When the completion or the void is triggered we expect a feedback about the state of it. This timeout defines after how long we consider the void resp. completion as failed without receiving a final state update.
    Integer
  • maximalCompletionDelayInDays
    The completion resp. the void can be triggered a while after the authorization of the transaction has been executed. This delay defines how many days after the authorization the void resp. completion must be triggered at the latest.
    Integer
  • multipleCompletionsSupported
    This flag indicates whether the connector supports multiple completions for a single transaction or not.
    Boolean
  • voidEndpoint
    URL
    The void endpoint is invoked to request the payment service provider to execute a void.
    String

4.13.59Payment App Completion Target State

The target state indicates the state that should be set on the completion.

Fields
  • SUCCESSFUL
    Successful
  • FAILED
    Failed

4.13.60Payment App Completion Update Request Details

The completion update request allows to change the state of a completion. The completion must be linked with a processor that was created by the payment Web App that invokes the operation.

Properties
  • completionId
    This is the ID of the completion that should be updated.
    Long
    Transaction Completion
  • failureReasonId
    The failure reason indicates why the completion failed. It is required when the target state is FAILED.
    Long
    Failure Reason
  • reference
    ≤ 100 chars
    The reference identifies the completion within the systems of the external service provider. It is required when the target state is SUCCESSFUL.
    String
  • targetState
    The target state defines the state into which the completion should be switched into. Once the completion changed the state it will not be possible to change it again.
    Payment App Completion Target State

4.13.61Payment App Connector Details

Properties
  • authorizationTimeout
    String
  • completionConfiguration
    The completion configuration defines how the deferred completion is processed. If it is not present it means that deferred completion is not supported by this connector.
    Payment App Completion Configuration
  • connectorConfiguration
    The connector configuration references the configuration that was created as part of this connector within the space. The connector configuration is referenced within transactions created with this connector.
    Payment Connector Configuration
  • createdOn
    The created on date indicates when the connector was added.
    DateTime
  • externalId
    ≤ 40 chars
    The external ID corresponds to the ID provided during inserting of the processor.
    String
  • id
    A unique identifier for the object.
    Long
  • linkedSpaceId
    The ID of the space this object belongs to.
    Long
    Space
  • name
    ≤ 100 chars
    The name of the connector will be displayed within the user interfaces that the merchant is interacting with.
    String
  • paymentPageEndpoint
    The payment page endpoint is invoked to process the transaction. The endpoint is defined by the external service provider.
    String
  • processor
    The processor references the app processor to which this connector belongs to. The relationship is established during the creation of the connector.
    Payment App Processor
  • refundConfiguration
    The refund configuration defines how refunds are processed. If it is not present it means that refunds are not supported by this connector.
    Payment App Refund Configuration
  • state
    The object's current state.
    Payment App Connector State
  • updatedOn
    The updated on date indicates when the last time the connector was updated on.
    DateTime
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.13.62Payment App Connector Creation Request Details

Properties
  • authorizationTimeoutInMinutes
    *
    When the transaction is not authorized within this timeout the transaction is considered as failed.
    Integer
  • completionConfiguration
    The completion configuration allows the connector to support deferred completions on a transaction. If it is not provided the connector will not process transactions in deferred mode.
    Payment App Completion Configuration Create
  • connector
    *
    The ID of the connector identifies which connector that should be linked with this web app connector. The connector defines the payment method.
    Long
    Payment Connector
  • externalId
    *
    1 - 40 chars
    The external ID identifies the connector within the external system. It has to be unique per processor external ID and for any subsequent update the same ID must be sent.
    String
  • name
    *
    ≤ 100 chars
    The name of the connector will be displayed within the user interfaces that the merchant is interacting with.
    String
  • paymentPageEndpoint
    *
    URL
    The payment page endpoint URL will be invoked by the buyer to carry out the authorization of the payment.
    String
  • processorExternalId
    *
    1 - 40 chars
    The external ID of the processor identifies the processor to which this connector belongs to. The processor cannot be changed once it has been set on a connector.
    String
  • refundConfiguration
    The refund configuration allows the connector to support refunds on transactions. In case no refund configuration is provided the connector will not support refunds.
    Payment App Refund Configuration Create

4.13.63Payment App Connector State

Fields
  • ACTIVE
    Active
  • DELETED
    Deleted

4.13.64Payment App Processor Details

Properties
  • configuredEnvironment
    Charge Attempt Environment
  • createdOn
    The created on date is the date when this processor has been added.
    DateTime
  • documentationUrl
    The documentation URL points to a web site that describes how to configure and use the processor.
    String
  • externalId
    ≤ 40 chars
    The external ID corresponds to the ID that was provided during creation of the processor.
    String
  • id
    A unique identifier for the object.
    Long
  • installationId
    The installation ID identifies the Web App installation.
    Long
  • linkedSpaceId
    The ID of the space this object belongs to.
    Long
    Space
  • name
    ≤ 100 chars
    The name of the processor will be displayed within the user interfaces that the merchant is interacting with.
    String
  • processorConfiguration
    This processor configuration is created as part of the app processor. Any transaction created with the processor is linked with this processor configuration.
    Processor Configuration
  • productionModeUrl
    When the user sets the processor into the production mode the user will be forwarded to this URL to configure the production environment. When no URL is provided no redirection will happen.
    String
  • state
    The object's current state.
    Payment App Processor State
  • svgIcon
    ≤ 10,000 chars
    String
  • updatedOn
    The updated on date indicates when the last update on the processor occurred.
    DateTime
  • usableInProduction
    When the processor is ready to be used for transactions in the production environment this flag is set to true.
    Boolean
  • usableInProductionSince
    DateTime
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.13.65Payment App Processor Creation Request Details

Properties
  • documentationUrl
    *
    URL
    The documentation URL has to point to a description of how to configure and use the processor.
    String
  • externalId
    *
    1 - 40 chars
    The external ID identifies the processor within the external system. It has to be unique per space and for any subsequent update the same ID must be sent.
    String
  • name
    *
    ≤ 100 chars
    The name of the processor will be displayed within the user interfaces that the merchant is interacting with.
    String
  • productionModeUrl
    URL
    The production mode URL has to point to a site on which the merchant can set up the production mode for the processor.
    String
  • svgIcon
    *
    ≤ 10,000 chars
    The SVG icon will be displayed to the user to represent this processor.
    String

4.13.66Payment App Processor State

Fields
  • ACTIVE
    Active
  • DELETED
    Deleted

4.13.67Payment App Refund Configuration Details

Properties
  • multipleRefundsSupported
    This flag indicates whether the connector supports multiple refunds for a single transaction or not.
    Boolean
  • refundEndpoint
    URL
    The refund endpoint is invoked to request the payment service provider to execute a refund.
    String
  • refundTimeoutInMinutes
    When the refund is triggered we expect a feedback about the state of it. This timeout defines after how long we consider the refund as failed without receiving a final state update.
    Integer

4.13.68Payment App Refund Target State

The target state indicates the state that should be set on the refund.

Fields
  • SUCCESSFUL
    Successful
  • FAILED
    Failed

4.13.69Payment App Refund Update Request Details

The refund update request allows to change the state of a refund. The refund must be linked with a processor that was created by the payment Web App that invokes the operation.

Properties
  • failureReasonId
    The failure reason indicates why the refund failed. It is required when the target state is FAILED.
    Long
    Failure Reason
  • reference
    ≤ 100 chars
    The reference identifies the refund within the systems of the external service provider. It is required when the target state is SUCCESSFUL.
    String
  • refundId
    This is the ID of the refund that should be updated.
    Long
    Refund
  • targetState
    The target state defines the state into which the refund should be switched into. Once the refund changed the state it will not be possible to change it again.
    Payment App Refund Target State

4.13.70Payment App Void Target State

The target state indicates the state that should be set on the void.

Fields
  • SUCCESSFUL
    Successful
  • FAILED
    Failed

4.13.71Payment App Void Update Request Details

The void update request allows to change the state of a void. The void must be linked with a processor that was created by the payment Web App that invokes the operation.

Properties
  • failureReasonId
    The failure reason indicates why the void failed. It is required when the target state is FAILED.
    Long
    Failure Reason
  • reference
    ≤ 100 chars
    The reference identifies the void within the systems of the external service provider. It is required when the target state is SUCCESSFUL.
    String
  • targetState
    The target state defines the state into which the void should be switched into. Once the void changed the state it will not be possible to change it again.
    Payment App Void Target State
  • voidId
    This is the ID of the void that should be updated.
    Long
    Transaction Void

4.13.72Payment Condition 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.13.73Payment Connector Details

Properties
  • dataCollectionType
    The data collection type specifies how the payment information is collected.
    Data Collection Type
  • deprecated
    Whether the object was deprecated.
    Boolean
  • deprecationReason
    The deprecation reason describes why the object was deprecated.
    Map of String String
  • 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
  • paymentMethod
    The payment method that the connector supports.
    Long
    Payment Method
  • paymentMethodBrand
    The specific brand that this payment connector supports.
    Payment Method Brand
  • primaryRiskTaker
    The entity that bears the main risk in the event that a contracting party fails to meet its obligations.
    Primary Risk Taker
  • processor
    The processor that the connector belongs to.
    Long
    Payment Processor
  • supportedCurrencies
    The currencies that are supported by the connector.
    Collection of String
  • supportedCustomersPresences
    The types of customer's presence that are supported by the connector.
    Collection of Customer's Presence
  • supportedFeatures
    The features that are supported by the connector.
    Collection of Long
    Payment Connector Feature

4.13.74Payment Connector Condition Details

A condition allows you to define a criteria that a transaction must fulfill in order for a connector configuration to be considered for processing the payment.

Properties
  • conditionType
    The condition type determines the criteria that a transaction must fulfill in order for a connector configuration to be considered for processing the payment.
    Long
    Payment 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 name used to identify the condition.
    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.13.75Payment Connector Configuration Details

Properties
  • applicableForTransactionProcessing
    Virtual
    Whether this connector configuration is enabled for processing payments, taking into account the state of the processor and payment method configurations.
    Boolean
  • conditions
    Conditions allow to define criteria that a transaction must fulfill in order for the connector configuration to be considered for processing the payment.
    Collection of Long
    Payment Connector Condition
  • connector
    The connector that the configuration is for.
    Long
    Payment Connector
  • enabledSalesChannels
    The sales channels for which the connector configuration is enabled. If empty, it is enabled for all sales channels.
    Collection of Sales Channel
  • enabledSpaceViews
    The space views for which the connector configuration is enabled. If empty, it is enabled for all space views.
    Collection of Long
  • id
    A unique identifier for the object.
    Long
  • imagePath
    The URL to the connector's image.
    String
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • name
    ≤ 100 chars
    The name used to identify the connector configuration.
    String
  • paymentMethodConfiguration
    The payment method configuration that the connector configuration belongs to.
    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 that determines the order in which connector configurations are taken into account when processing a payment. Low values are considered first.
    Integer
  • processorConfiguration
    The processor configuration that the connector configuration belongs to.
    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.13.76Payment Connector Feature Details

Properties
  • displayName
    The name of the feature.
    String
  • id
    A unique identifier for the object.
    Long

4.13.77Payment Contract Details

Properties
  • account
    This account that the contract belongs to.
    Account
  • activatedOn
    The date and time when the contract was activated.
    DateTime
  • contractIdentifier
    The identifier of the contract.
    String
  • contractType
    The type of the contract.
    Payment Contract Type
  • createdBy
    The ID of the user the contract was created by.
    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
    The date and time when the contract was rejected.
    DateTime
  • rejectionReason
    The reason for rejecting the contract.
    Failure Reason
  • startTerminatingOn
    The date and time when the termination process of the contract was started.
    DateTime
  • state
    The object's current state.
    Payment Contract State
  • terminatedBy
    The ID of the user the contract was terminated by.
    User
  • terminatedOn
    The date and time when the contract was terminated.
    DateTime
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.13.78Payment Contract State

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

4.13.79Payment Contract 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.13.80Payment 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.13.81Payment Information Hash Type Details

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

4.13.82Payment Initiation Advice File Details

Properties
  • createdOn
    The created on date indicates the date on which the entity was stored into the database.
    DateTime
  • failureMessage
    String
  • fileGeneratedOn
    DateTime
  • forwardedOn
    The shipping date indicates the date on which the pain file was transferred to an external processing system.
    DateTime
  • id
    A unique identifier for the object.
    Long
  • linkedSpaceId
    The ID of the space this object belongs to.
    Long
    Space
  • name
    String
  • processedOn
    DateTime
  • processor
    Payment Processor
  • state
    The object's current state.
    Payment Initiation Advice File State

4.13.83Payment Initiation Advice File State

Fields
  • CREATING
    Creating
  • FAILED
    Failed
  • CREATED
    Created
  • OVERDUE
    Overdue
  • UPLOADED
    Uploaded
  • DOWNLOADED
    Downloaded
  • PROCESSED
    Processed

4.13.84Payment Link Details

The payment link defines an URL to automatically create transactions.

Properties
  • allowedPaymentMethodConfigurations
    The allowed payment method configurations restrict the payment methods which can be used with this payment link.
    Collection of Payment Method Configuration
  • appliedSpaceView
    The payment link can be conducted in a specific space view. The space view may apply a specific design to the payment page.
    Long
  • availableFrom
    The available from date defines the earliest date on which the payment link can be used. When no date is specified there will be no restriction.
    DateTime
  • availableUntil
    The available from date defines the latest date on which the payment link can be used to initialize a transaction. When no date is specified there will be no restriction.
    DateTime
  • billingAddressHandlingMode
    The billing address handling mode controls if the address is collected or not and how it is collected.
    Address Handling Mode
  • currency
    The currency defines in which currency the payment is executed in. If no currency is defined it has to be specified within the request parameter 'currency'.
    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
  • language
    The language defines the language of the payment page. If no language is provided it can be provided through the request parameter.
    String
  • lineItems
    The line items allows to define the line items for this payment link. When the line items are defined they cannot be overridden through the request parameters. If no amount for the payment link is defined, the additional checkout page to enter the amount is shown to the consumer.
    Collection of Line Item
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • maximalNumberOfTransactions
    The maximal number of transactions limits the number of transactions which can be created with this payment link.
    Integer
  • name
    ≤ 100 chars
    The payment link name is used internally to identify the payment link. 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
  • protectionMode
    The protection mode determines if the payment link is protected against tampering and in what way.
    Payment Link Protection Mode
  • shippingAddressHandlingMode
    The shipping address handling mode controls if the address is collected or not and how it is collected.
    Address Handling Mode
  • state
    The object's current state.
    Creation Entity State
  • url
    Virtual
    The URL defines the URL to which the user has to be forwarded to initialize the payment.
    String
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.13.85Payment Link Protection Mode

Fields
  • NO_PROTECTION
    No Protection
  • ACCESS_KEY
    Access Key

4.13.86Payment Method Details

Properties
  • dataCollectionTypes
    The data collection types that are supported by the payment method.
    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
    The path to the payment method's image which is displayed to the customer.
    String
  • merchantDescription
    Map of String String
  • name
    The localized name of the object.
    Map of String String
  • supportedCurrencies
    The currencies that are supported by the payment method.
    Collection of String

4.13.87Payment 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
    The path to the payment brand's image which is displayed to the customer.
    String
  • name
    The localized name of the object.
    Map of String String
  • paymentMethod
    The payment method that the brand belongs to.
    Long
    Payment Method

4.13.88Payment Method Configuration Details

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

Properties
  • dataCollectionType
    The data collection type specifies how the payment information is collected.
    Data Collection Type
  • description
    A custom description for the payment method which is displayed to the customer.
    Map of String String
  • id
    A unique identifier for the object.
    Long
  • imageResourcePath
    The resource path to a custom image for the payment method which is displayed to the customer.
    Resource Path
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • name
    ≤ 100 chars
    The name used to identify the payment method configuration.
    String
  • oneClickPaymentMode
    The one-click payment mode determines whether the customer can save their payment details for later payments.
    One Click Payment Mode
  • paymentMethod
    The payment method that the configuration is for.
    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 description for the payment method that is actually displayed to the customer. This is either the custom description, if defined, or otherwise the payment method's default one.
    Map of String String
  • resolvedImageUrl
    Virtual
    The image URL for the payment method that is actually displayed to the customer. This is either the custom image, if defined, or otherwise the payment method's default one.
    String
  • resolvedTitle
    Virtual
    The title for the payment method that is actually displayed to the customer. This is either the custom title, if defined, or otherwise the payment method's default one.
    Map of String String
  • sortOrder
    When listing payment methods, they can be sorted by this number.
    Integer
  • spaceId
    ≥ 1
    The ID of the space this object belongs to.
    Long
  • state
    The object's current state.
    Creation Entity State
  • title
    A custom title for the payment method which is displayed to the customer.
    Map of String String
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.13.89Payment Processor Details

Payment processors handle the connection to third part companies (payment service providers) that technically manage payment transactions and therefore process payments.

Properties
  • companyName
    The name of the company to which the processor belongs.
    Map of String String
  • description
    The localized description of the object.
    Map of String String
  • headquartersLocation
    Where the processor's headquarters are located.
    Map of String String
  • id
    A unique identifier for the object.
    Long
  • logoPath
    The path to the logo image of the processor.
    String
  • name
    The localized name of the object.
    Map of String String
  • productName
    The name of the processor's product.
    Map of String String

4.13.90Payment Terminal Details

Properties
  • configurationVersion
    The configuration that is assigned to the terminal and determines how it works.
    Payment Terminal Configuration Version
  • defaultCurrency
    Virtual
    The default currency of the terminal.
    String
  • deviceName
    The name of the device that is currently linked to the payment terminal.
    String
  • deviceSerialNumber
    The serial number of the device that is currently linked to the payment terminal.
    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 unique identifier of the terminal, that is displayed on the device.
    String
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • locationVersion
    The physical location where the terminal is used.
    Payment Terminal Location Version
  • name
    ≤ 100 chars
    The name used to identify the payment terminal.
    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
    The type of the payment terminal.
    Payment Terminal Type
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.13.91Payment 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.13.92Payment 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 name used to identify the payment terminal configuration.
    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
    The type of payment terminals that this configuration can be assigned to.
    Payment Terminal Type
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.13.93Payment Terminal Configuration State

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

4.13.94Payment Terminal Configuration Version Details

Properties
  • configuration
    The payment terminal configuration that the version belongs to.
    Payment Terminal Configuration
  • connectorConfigurations
    The payment connector configurations that are available on the payment terminal.
    Collection of Long
    Payment Connector Configuration
  • createdBy
    The ID of the user the payment terminal configuration version was created by.
    Long
  • createdOn
    The date and time when the object was created.
    DateTime
  • defaultCurrency
    The default currency that is used if none is set on the payment terminal itself. If it is empty, the currency is derived from the location of the terminal.
    String
  • id
    A unique identifier for the object.
    Long
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • maintenanceWindowDuration
    The permitted duration of the terminal's maintenance window.
    String
  • maintenanceWindowStart
    The start time of the terminal's maintenance window.
    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
    The time zone of the payment terminal used to determine the maintenance window.
    String
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer
  • versionAppliedImmediately
    Whether payment terminals are immediately updated to this configuration version. If not, it will be applied during the maintenance window.
    Boolean

4.13.95Payment Terminal Configuration Version State

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

4.13.96Payment 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 name used to identify the payment terminal location.
    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.13.97Payment Terminal Location State

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

4.13.98Payment Terminal Location Version Details

Properties
  • address
    The postal address of the location where the payment terminals are used.
    Payment Terminal Address
  • contactAddress
    The contact details if the person responsible for the payment terminals at this location.
    Payment Terminal Address
  • createdBy
    The ID of the user the payment terminal location version was created by.
    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
    The payment terminal location that the version belongs to.
    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
    Whether payment terminals are immediately updated to this configuration version. If not, it will be applied during the maintenance window.
    Boolean

4.13.99Payment Terminal Location Version State

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

4.13.100Payment 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.13.101Payment Terminal State

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

4.13.102Payment 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.13.103Payment Token Details

Properties
  • createdOn
    The date and time when the object was created.
    DateTime
  • customerEmailAddress
    ≤ 150 chars
    The customer's email address.
    String
  • customerId
    The unique identifier of the customer in the external system.
    String
  • enabledForOneClickPayment
    Whether the token is enabled for one-click payments, which simplify the payment process for the customer. One-click tokens are linked to customers via the customer ID.
    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 customer's time zone, which affects how dates and times are formatted when communicating with the customer.
    String
  • tokenReference
    ≤ 100 chars
    The reference used to identify the payment token (e.g. the customer's ID or email address).
    String
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.13.104Primary 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.13.105Processor Configuration Details

Properties
  • applicationManaged
    Whether the processor configuration is managed by the application and therefore cannot be changed.
    Boolean
  • contractId
    The ID of the payment contract the processor configuration is linked to.
    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 name used to identify the payment method configuration.
    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
    The payment processor that the configuration is for.
    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.13.106Receipt Format

Fields
  • PDF
    Pdf
  • TXT
    Txt

4.13.107Recurring Indicator

Fields
  • REGULAR_TRANSACTION
    Regular Transaction
  • INITIAL_RECURRING_TRANSACTION
    Initial Recurring Transaction
  • MERCHANT_INITIATED_RECURRING_TRANSACTION
    Merchant Initiated Recurring Transaction
  • CUSTOMER_INITIATED_RECURRING_TRANSACTION
    Customer Initiated Recurring Transaction

4.13.108Refund 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
    The labels providing additional information about the object.
    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.13.109Refund Bank Transaction Details

Properties
  • bankTransaction
    Bank Transaction
  • 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
  • linkedTransaction
    Virtual
    Long
    Transaction
  • refund
    Refund
  • refundCurrencyAmount
    Specify the posting amount in the refund's currency.
    Decimal
  • refundCurrencyValueAmount
    Virtual
    Decimal
  • spaceViewId
    The ID of the space view this object is linked to.
    Long
    Space View
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.13.110Refund 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.13.111Refund Recovery Bank Transaction Details

Properties
  • bankTransaction
    Bank Transaction
  • id
    A unique identifier for the object.
    Long
  • language
    The language that is linked to the object.
    String
  • lineItems
    The line items contain the items which could be recovered.
    Collection of Line Item
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • linkedTransaction
    Virtual
    Long
    Transaction
  • refund
    Refund
  • refundCurrencyAmount
    Specify the posting amount in the refund's currency.
    Decimal
  • refundCurrencyValueAmount
    Virtual
    Decimal
  • spaceViewId
    The ID of the space view this object is linked to.
    Long
    Space View
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.13.112Refund State

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

4.13.113Refund 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.13.114Rendered 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.13.115Rendered 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.13.116Sales Channel 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
  • sortOrder
    When listing sales channels, they can be sorted by this number.
    Integer

4.13.117Terminal 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.13.118Terminal 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.13.119Token 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
    The labels providing additional information about the object.
    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
    Payment 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
    Payment 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.13.120Token Version State

Fields
  • UNINITIALIZED
    Uninitialized
  • ACTIVE
    Active
  • OBSOLETE
    Obsolete

4.13.121Token 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.13.122Tokenization 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.13.123Tokenized Card Data Details

This model holds the card data in plain.

Properties
  • cardHolderName
    ≤ 100 chars
    The card holder name is the name printed onto the card. It identifies the person who owns the card.
    String
  • cardVerificationCode
    3 - 4 chars
    ([0-9 ]+)
    The card verification code (CVC) is a 3 to 4 digit code typically printed on the back of the card. It helps to ensure that the card holder is authorizing the transaction. For card not-present transactions this field is optional.
    String
  • cryptogram
    The additional authentication value used to secure the tokenized card transactions.
    Card Cryptogram
  • expiryDate
    ([0-9]{4})\-(11|12|10|0[1-9]{1})
    The card expiry date indicates when the card expires. The format is the format yyyy-mm where yyyy is the year (e.g. 2019) and the mm is the month (e.g. 09).
    String
  • initialRecurringTransaction
    Boolean
  • panType
    Pan Type
  • primaryAccountNumber
    10 - 30 chars
    ([0-9 ]+)
    The primary account number (PAN) identifies the card. The number is numeric and typically printed on the front of the card.
    String
  • recurringIndicator
    Recurring Indicator
  • schemeTransactionReference
    ≤ 100 chars
    String
  • tokenRequestorId
    String

4.13.124Tokenized Card Data Details

This model holds the card data in plain.

Properties
  • cardHolderName
    ≤ 100 chars
    The card holder name is the name printed onto the card. It identifies the person who owns the card.
    String
  • cardVerificationCode
    3 - 4 chars
    ([0-9 ]+)
    The card verification code (CVC) is a 3 to 4 digit code typically printed on the back of the card. It helps to ensure that the card holder is authorizing the transaction. For card not-present transactions this field is optional.
    String
  • cryptogram
    The additional authentication value used to secure the tokenized card transactions.
    Card Cryptogram
  • expiryDate
    ([0-9]{4})\-(11|12|10|0[1-9]{1})
    The card expiry date indicates when the card expires. The format is the format yyyy-mm where yyyy is the year (e.g. 2019) and the mm is the month (e.g. 09).
    String
  • panType
    Pan Type
  • primaryAccountNumber
    *
    10 - 30 chars
    ([0-9 ]+)
    The primary account number (PAN) identifies the card. The number is numeric and typically printed on the front of the card.
    String
  • recurringIndicator
    Recurring Indicator
  • schemeTransactionReference
    ≤ 100 chars
    String
  • tokenRequestorId
    String

4.13.125Transaction Details

Properties
  • acceptHeader
    The 'Accept' header of the customer's web browser.
    String
  • acceptLanguageHeader
    The 'Accept Language' header of the customer's web browser.
    String
  • allowedPaymentMethodBrands
    The payment method brands that can be used to authorize the transaction.
    Collection of Long
    Payment Method Brand
  • allowedPaymentMethodConfigurations
    The payment method configurations that can be used to authorize the transaction.
    Collection of Long
    Payment Method Configuration
  • authorizationAmount
    The sum of all line item prices including taxes in the transaction's currency.
    Decimal
  • authorizationEnvironment
    The environment in which the transaction was authorized.
    Charge Attempt Environment
  • authorizationSalesChannel
    The sales channel through which the transaction was placed.
    Long
    Sales Channel
  • authorizationTimeoutOn
    The date and time when the transaction must be authorized, otherwise it will canceled.
    DateTime
  • authorizedOn
    The date and time when the transaction was authorized.
    DateTime
  • autoConfirmationEnabled
    Whether the transaction can be confirmed automatically or whether this must be done explicitly via the API. Default is true.
    Boolean
  • billingAddress
    The address associated with the payment method for invoicing and transaction processing purposes.
    Address
  • chargeRetryEnabled
    Whether the customer can make further payment attempts if the first one has failed. Default is true.
    Boolean
  • completedAmount
    The total amount that was completed, in the transaction's currency.
    Decimal
  • completedOn
    The date and time when the transaction was completed.
    DateTime
  • completionBehavior
    The behavior that controls when the transaction is completed.
    Transaction Completion Behavior
  • completionTimeoutOn
    The date and time when the transaction is completed automatically.
    DateTime
  • confirmedBy
    The ID of the user the transaction was confirmed by.
    Long
  • confirmedOn
    The date and time when the transaction was created.
    DateTime
  • createdBy
    The ID of the user the transaction was created by.
    Long
  • createdOn
    The date and time when the object was created.
    DateTime
  • currency
    The three-letter code (ISO 4217 format) of the transaction's currency.
    String
  • customerEmailAddress
    ≤ 254 chars
    The customer's email address.
    String
  • customerId
    The unique identifier of the customer in the external system.
    String
  • customersPresence
    The customer's presence indicates whether and in what way the transaction's customer is present. Default is VIRTUAL_PRESENT.
    Customer's Presence
  • deliveryDecisionMadeOn
    This date and time when the decision was made as to whether the order should be shipped.
    DateTime
  • deviceSessionIdentifier
    10 - 40 chars
    ([a-zA-Z0-9_-])*
    Allows to link the transaction to the data collected from the customer's device.
    String
  • emailsDisabled
    Whether email sending is deactivated for the transaction. Default is false.
    Boolean
  • endOfLife
    The date and time when the transaction reaches its end of live. No further actions can be carried out at this time.
    DateTime
  • environment
    Environment
  • environmentSelectionStrategy
    The strategy for determining whether the transaction is to be processed in the test or production environment.
    Transaction Environment Selection Strategy
  • failedOn
    The date and time when the transaction failed.
    DateTime
  • failedUrl
    9 - 2,000 options
    URL
    Virtual
    The URL to redirect the customer back to after they canceled or failed to authenticated their payment.
    String
  • failureReason
    The reason for the failure of the transaction.
    Failure Reason
  • group
    The group that the transaction belongs to.
    Transaction Group
  • id
    A unique identifier for the object.
    Long
  • internetProtocolAddress
    The IP address of the customer's device.
    String
  • internetProtocolAddressCountry
    The country determined from the IP address of the customer's device.
    String
  • invoiceMerchantReference
    ≤ 100 chars
    The merchant's reference used to identify the invoice.
    String
  • javaEnabled
    Whether Java is enabled on the customer's web browser.
    Boolean
  • language
    The language that is linked to the object.
    String
  • lineItems
    The line items purchased by the customer.
    Collection of Line Item
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • merchantReference
    ≤ 100 chars
    The merchant's reference used to identify the transaction.
    String
  • metaData
    Virtual
    Allow to store additional information about the object.
    Map of String String
  • parent
    The parent transaction which was (partially) replaced by this transaction.
    Long
    Transaction
  • paymentConnectorConfiguration
    The payment connector configuration that was used to authorize the transaction.
    Payment 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
    The date and time when the processing of the transaction was started.
    DateTime
  • refundedAmount
    The total amount that was refunded, in the transaction's currency.
    Decimal
  • screenColorDepth
    The screen color depth of the customer's web browser.
    String
  • screenHeight
    The screen height of the customer's web browser.
    String
  • screenWidth
    The screen width of the customer's web browser.
    String
  • shippingAddress
    The address to where the order will be shipped.
    Address
  • shippingMethod
    ≤ 200 chars
    The name of the shipping method used to ship the products.
    String
  • spaceViewId
    The ID of the space view this object is linked to.
    Long
    Space View
  • state
    The object's current state.
    Transaction State
  • successUrl
    9 - 2,000 options
    URL
    Virtual
    The URL to redirect the customer back to after they successfully authenticated their payment.
    String
  • terminal
    The payment terminal through which the payment was processed.
    Payment Terminal
  • timeZone
    The customer's time zone, which affects how dates and times are formatted when communicating with the customer.
    String
  • token
    The payment token that should be used to charge the customer.
    Payment Token
  • tokenizationMode
    The tokenization mode specifies whether and how the tokenization of payment information is applied to the transaction.
    Tokenization Mode
  • totalAppliedFees
    The total of all fees charged, in the transaction's currency.
    Decimal
  • totalSettledAmount
    The total amount that was settled, in the transaction's currency.
    Decimal
  • userAgentHeader
    The 'User Agent' header of the customer's web browser.
    String
  • userFailureMessage
    The message that can be displayed to the customer explaining why the transaction failed, in the customer's language.
    String
  • userInterfaceType
    The type of user interface the customer used to provide the payment information.
    Transaction User Interface Type
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer
  • windowHeight
    The window height of the customer's web browser.
    String
  • windowWidth
    The window width of the customer's web browser.
    String
  • yearsToKeep
    The number of years the transaction is kept after its authorization.
    Integer

4.13.126Transaction 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.13.127Transaction 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.13.128Transaction 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
    The labels providing additional information about the object.
    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
    The ID of the space view this object is linked to.
    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.13.129Transaction Completion Behavior

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

4.13.130Transaction Completion Mode

Fields
  • DIRECT
    Direct
  • ONLINE
    Online
  • OFFLINE
    Offline

4.13.131Transaction Completion Request Details

Properties
  • 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
  • invoiceMerchantReference
    ≤ 100 chars
    String
  • lastCompletion
    *
    The last completion flag indicates if this is the last completion. After the last completion is created no further completions can be issued.
    Boolean
  • lineItems
    The line items which will be used to complete the transaction.
    Collection of Completion Line Item . Create Create
  • statementDescriptor
    ≤ 80 options
    [a-zA-Z0-9\s.,_?+/-]*
    The statement descriptor explain charges or payments on bank statements.
    String
  • transactionId
    *
    The ID of the transaction which should be completed.
    Long

4.13.132Transaction Completion State

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

4.13.133Transaction Environment Selection Strategy

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

4.13.134Transaction Group Details

Properties
  • beginDate
    The date and time when the initial transaction in the group was created.
    DateTime
  • customerId
    ≤ 100 chars
    The unique identifier of the customer in the external system.
    String
  • endDate
    The date and time when the final transaction in the group 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
  • 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.13.135Transaction Group State

Fields
  • PENDING
    Pending
  • FAILED
    Failed
  • SUCCESSFUL
    Successful

4.13.136Transaction 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
    The ID of the space view this object is linked to.
    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.13.137Transaction 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.13.138Transaction 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.13.139Transaction Invoice State

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

4.13.140Transaction 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
    The labels providing additional information about the object.
    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
    The ID of the space view this object is linked to.
    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.13.141Transaction 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.13.142Transaction Line Item Version State

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

4.13.143Transaction State

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

4.13.144Transaction 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.13.145Transaction User Interface Type

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

4.13.146Transaction Void Details

Properties
  • createdBy
    Long
  • createdOn
    The date and time when the object was created.
    DateTime
  • failedOn
    DateTime
  • failureReason
    Failure Reason
  • id
    A unique identifier for the object.
    Long
  • labels
    The labels providing additional information about the object.
    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
  • mode
    Transaction Void Mode
  • 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
  • processorReference
    String
  • spaceViewId
    The ID of the space view this object is linked to.
    Long
    Space View
  • state
    The object's current state.
    Transaction Void State
  • succeededOn
    DateTime
  • timeoutOn
    DateTime
  • transaction
    Transaction
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.13.147Transaction Void Mode

Fields
  • ONLINE
    Online
  • OFFLINE
    Offline

4.13.148Transaction Void State

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

4.13.149Transaction summary Details

Properties

4.13.150Transaction summary Reference Details

Properties
  • id
    A unique identifier for the object.
    Long
  • linkedSpaceId
    The ID of the space this object belongs to.
    Long
    Space
  • terminalId
    Long
  • terminalIdentifier
    String

4.13.151Wallet 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.14Shopify

4.14.1Shopify Additional Line Item Data

Fields
  • VENDOR
    Vendor
  • WEIGHT
    Weight

4.14.2Shopify Integration Details

A Shopify Integration allows to connect a Shopify shop.

Properties
  • additionalLineItemData
    Collection of Shopify Additional Line Item Data
  • allowInvoiceDownload
    Boolean
  • allowedPaymentMethodConfigurations
    Collection of Payment Method Configuration
  • currency
    String
  • id
    A unique identifier for the object.
    Long
  • integratedPaymentFormEnabled
    Enabling the integrated payment form will embed the payment form in the Shopify shop. The app needs to be installed for this to be possible.
    Boolean
  • language
    The checkout language forces a specific language in the checkout. Without a checkout language the browser setting of the buyer is used to determine the language.
    String
  • loginName
    ≤ 100 chars
    The login name is used to link a specific Shopify payment gateway to this integration.This login name is to be filled into the appropriate field in the shop's payment gateway configuration.
    String
  • name
    ≤ 100 chars
    The integration name is used internally to identify a specific integration.For example the name is used withinsearch fields and hence it should be distinct and descriptive.
    String
  • paymentAppVersion
    Shopify Integration Payment App Version
  • paymentInstalled
    Boolean
  • paymentProxyPath
    [A-Za-z0-9-_/]*
    Define the path of the proxy URL. This only needs to be changed if the app's proxy URL is overwritten in the Shopify store.
    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
  • replacePaymentMethodImage
    Boolean
  • shopName
    ≤ 100 chars
    ([^\p{C}\p{Cn}\p{Zl}\p{Zp}.]|[ ])*
    The store address is used to link a specific Shopify shop to this integration. This is the name used in the Shopify's admin URL: [storeAddress].myshopify.com
    String
  • showPaymentInformation
    Boolean
  • showSubscriptionInformation
    Boolean
  • spaceId
    ≥ 1
    Long
  • spaceViewId
    The ID of the space view this object is linked to.
    Long
    Space View
  • state
    The object's current state.
    Creation Entity State
  • subscriptionAppVersion
    Shopify Integration Subscription App Version
  • subscriptionInstalled
    Boolean
  • subscriptionProxyPath
    [A-Za-z0-9-_/]*
    Define the path of the proxy URL. This only needs to be changed if the app's proxy URL is overwritten in the Shopify store.
    String
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.14.3Shopify Integration Payment App Version

Fields
  • API_2019_07
    Api 2019 07

4.14.4Shopify Integration Subscription App Version

Fields
  • BASIC
    Basic
  • SUBSCRIPTION
    Subscription
  • API_2019_07
    Api 2019 07

4.14.5Shopify Recurring Order Details

Properties
  • billedOn
    DateTime
  • checkoutToken
    String
  • createdOn
    DateTime
  • failureReason
    Failure Reason
  • 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
  • orderId
    String
  • orderName
    String
  • plannedExecutionDate
    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
  • recurrenceNumber
    Integer
  • shop
    Long
    Shopify Integration
  • startedProcessingOn
    DateTime
  • state
    The object's current state.
    Shopify Recurring Order State
  • subscriptionVersion
    Shopify Subscription Version
  • transaction
    Shopify Transaction

4.14.6Shopify Recurring Order State

Fields
  • PENDING
    Pending
  • ONHOLD
    Onhold
  • PROCESSING
    Processing
  • CANCELED
    Canceled
  • BILLED
    Billed
  • FAILED
    Failed

4.14.7Shopify Recurring Order Update Request Details

Properties
  • executionDate
    DateTime
  • recurringOrderId
    Long

4.14.8Shopify Subscriber Details

Properties
  • createdOn
    DateTime
  • emailAddress
    Email
    ≤ 254 chars
    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
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • phoneNumber
    ≤ 254 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
  • shop
    Long
    Shopify Integration
  • state
    The object's current state.
    Shopify Subscriber State
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.14.9Shopify Subscriber Creation Details

Properties
  • emailAddress
    String
  • phoneNumber
    String
  • shopifyCustomerId
    *
    The customer ID has to correspond to the ID assigned to the customer by Shopify. When the subscriber already exists no new subscriber will be created.
    String

4.14.10Shopify Subscriber State

Fields
  • ACTIVE
    Active
  • DELETING
    Deleting
  • DELETED
    Deleted

4.14.11Shopify Subscription Details

Properties
  • createdBy
    Long
  • createdOn
    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
  • id
    A unique identifier for the object.
    Long
  • initialExecutionDate
    DateTime
  • initialPaymentTransaction
    Long
    Transaction
  • initialShopifyTransaction
    Long
    Shopify Transaction
  • language
    The language that is linked to the object.
    String
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • orderRecurrenceNumber
    Integer
  • shop
    Long
    Shopify Integration
  • state
    The object's current state.
    Shopify Subscription State
  • subscriber
    Shopify Subscriber
  • terminatedBy
    Long
  • terminatedOn
    DateTime
  • terminationRequestDate
    DateTime
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.14.12Shopify Subscription Address Details

Properties
  • city
    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
    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
    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
    The street or PO Box.
    String

4.14.13Shopify Subscription Billing Configuration Details

Properties
  • billingDayOfMonth
    ≥ 1
    ≤ 31
    Define the day of the month on which the recurring orders should be created.
    Integer
  • billingIntervalAmount
    ≥ 1
    Integer
  • billingIntervalUnit
    Define how frequently recurring orders should be created.
    Shopify Subscription Billing Interval Unit
  • billingReferenceDate
    This date will be used as basis to calculate the dates of recurring orders.
    DateTime
  • billingWeekday
    Define the weekday on which the recurring orders should be created.
    Shopify Subscription Weekday
  • maximalBillingCycles
    Positive
    Define the maximum number of orders the subscription will run for.
    Integer
  • maximalSuspendableCycles
    Positive
    Define the maximum number of orders the subscription can be suspended for at a time.
    Integer
  • minimalBillingCycles
    Positive
    Define the minimal number of orders the subscription will run for.
    Integer
  • terminationBillingCycles
    Positive
    Define the number of orders the subscription will keep running for after its termination has been requested.
    Integer

4.14.14Shopify Subscription Billing Interval Unit

Fields
  • MINUTES
    Minutes
  • HOURS
    Hours
  • DAYS
    Days
  • WEEKS
    Weeks
  • MONTHS
    Months
  • YEARS
    Years

4.14.15Shopify Subscription Creation Request Details

Properties

4.14.16Shopify Subscription Item Details

Properties

4.14.17Shopify Subscription Product Details

Properties
  • absolutePriceAdjustment
    Decimal
  • billingDayOfMonth
    ≥ 1
    ≤ 31
    Define the day of the month on which the recurring orders should be created.
    Integer
  • billingIntervalAmount
    ≥ 1
    Integer
  • billingIntervalUnit
    Define how frequently recurring orders should be created.
    Shopify Subscription Billing Interval Unit
  • billingWeekday
    Define the weekday on which the recurring orders should be created.
    Shopify Subscription Weekday
  • fixedPrice
    Decimal
  • id
    A unique identifier for the object.
    Long
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • maximalBillingCycles
    Positive
    Define the maximum number of orders the subscription will run for.
    Integer
  • maximalSuspendableCycles
    Positive
    Define the maximum number of orders the subscription can be suspended for at a time.
    Integer
  • minimalBillingCycles
    Positive
    Define the minimal number of orders the subscription will run for.
    Integer
  • 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
  • pricingOption
    Shopify Subscription Product Pricing Option
  • productId
    The ID of the Shopify product that is enabled to be ordered as subscription.
    String
  • productName
    String
  • productPrice
    Decimal
  • productSku
    String
  • productVariantId
    String
  • productVariantName
    String
  • relativePriceAdjustment
    Decimal
  • shippingRequired
    Boolean
  • shop
    Long
    Shopify Integration
  • state
    The object's current state.
    Shopify Subscription Product State
  • stockCheckRequired
    Boolean
  • storeOrderConfirmationEmailEnabled
    Define whether the order confirmation email of the Shopify shop is sent to the customer for recurring orders.
    Boolean
  • subscriberSuspensionAllowed
    Define whether the customer is allowed to suspend subscriptions.
    Boolean
  • terminationBillingCycles
    Positive
    Define the number of orders the subscription will keep running for after its termination has been requested.
    Integer
  • updatedAt
    DateTime
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.14.18Shopify Subscription Product Pricing Option

Fields
  • CURRENT_PRICE
    Current Price
  • ORIGINAL_PRICE
    Original Price
  • FIXED_PRICE
    Fixed Price
  • RELATIVE_ADJUSTMENT
    Relative Adjustment
  • ABSOLUTE_ADJUSTMENT
    Absolute Adjustment

4.14.19Shopify Subscription Product State

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

4.14.20Shopify Subscription State

Fields
  • INITIATING
    Initiating
  • FAILED
    Failed
  • ACTIVE
    Active
  • SUSPENDED
    Suspended
  • TERMINATING
    Terminating
  • TERMINATED
    Terminated

4.14.21Shopify Subscription Suspension Details

Properties

4.14.22Shopify Subscription Suspension Initiator

Fields
  • MERCHANT
    Merchant
  • CUSTOMER
    Customer

4.14.23Shopify Subscription Suspension State

Fields
  • ACTIVE
    Active
  • ENDED
    Ended

4.14.24Shopify Subscription Suspension Type

Fields
  • REACTIVATE
    Reactivate
  • TERMINATE
    Terminate

4.14.25Shopify Subscription Tax Line Details

Properties
  • rate
    Decimal
  • title
    String

4.14.26Shopify Subscription Update Addresses Request Details

Properties

4.14.27Shopify Subscription Update Request Details

Properties

4.14.28Shopify Subscription Version Details

Properties

4.14.29Shopify Subscription Version Item Details

Properties

4.14.30Shopify Subscription Version Item Price Strategy

Fields
  • INITIALLY_CALCULATED
    Initially Calculated
  • RECALCULATE
    Recalculate

4.14.31Shopify Subscription Version State

Fields
  • CREATE
    Create
  • ACTIVE
    Active
  • DISCHARGED
    Discharged

4.14.32Shopify Subscription Weekday

Fields
  • MONDAY
    Monday
  • TUESDAY
    Tuesday
  • WEDNESDAY
    Wednesday
  • THURSDAY
    Thursday
  • FRIDAY
    Friday
  • SATURDAY
    Saturday
  • SUNDAY
    Sunday

4.14.33Shopify Tax Line Details

Properties
  • fractionRate
    Decimal
  • id
    A unique identifier for the object.
    Long
  • rate
    Decimal
  • title
    String
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.14.34Shopify Transaction Details

Properties
  • checkoutId
    String
  • createdOn
    The date and time when the object was created.
    DateTime
  • id
    A unique identifier for the object.
    Long
  • integration
    Shopify Integration
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • linkedTransaction
    Virtual
    Long
    Transaction
  • orderId
    String
  • orderName
    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
    Shopify Transaction State
  • transaction
    Transaction
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.14.35Shopify Transaction State

Fields
  • PENDING
    Pending
  • AUTHORIZED
    Authorized
  • COMPLETED
    Completed
  • FAILED
    Failed
  • CONFLICTING
    Conflicting

4.15Subscription

4.15.1Metric Details

A metric represents the usage of a resource that can be measured.

Properties
  • description
    The localized description of the metric that is displayed to the customer.
    Map of String String
  • id
    A unique identifier for the object.
    Long
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • name
    The localized name of the metric that is displayed to the customer.
    Map of String 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
  • type
    The type of the metric.
    Subscription Metric Type
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.15.2Metric Usage Report Details

The metric usage is the actual usage of a metric for a particular subscription as collected by an external application.

Properties
  • consumedUnits
    The number of resources consumed, will be charged in the next billing cycle.
    Decimal
  • createdByUserId
    The ID of the user the usage report was created by.
    Long
    User
  • createdOn
    The date and time when the usage report was created.
    DateTime
  • description
    ≤ 100 chars
    A description used to identify the usage report.
    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
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • metric
    The metric that the usage report is recorded for.
    Long
    Metric
  • 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
  • subscription
    The subscription that the usage report is recorded for.
    Long
    Subscription
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.15.3Product Component Details

Properties
  • componentChangeWeight
    If switching from a component with a lower tier to a component with a higher one, this is considered an upgrade and a fee may be applied.
    Integer
  • componentGroup
    The group that the component belongs to.
    Product Component Group
  • defaultComponent
    Whether this is the default component in its group and preselected.
    Boolean
  • description
    The localized description of the component that is displayed to the customer.
    Map of String String
  • id
    A unique identifier for the object.
    Long
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • maximalQuantity
    A maximum of the defined quantity can be selected for this component.
    Decimal
  • minimalQuantity
    A minimum of the defined quantity must be selected for this component.
    Decimal
  • name
    The localized name of the component that is displayed to the customer.
    Map of String String
  • quantityStep
    The quantity step determines the interval in which the quantity can be increased.
    Decimal
  • reference
    The reference is used to link components across different product versions.
    Product Component Reference
  • sortOrder
    When listing components, they can be sorted by this number.
    Integer
  • taxClass
    The tax class to be applied to fees.
    Tax Class
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.15.4Product Component Group Details

Properties
  • id
    A unique identifier for the object.
    Long
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • name
    The localized name of the component group that is displayed to the customer.
    Map of String String
  • optional
    Whether the component group is optional, i.e. the customer does not have to select any component.
    Boolean
  • productVersion
    The product version that the component group belongs to.
    Product Version
  • sortOrder
    When listing component groups, they can be sorted by this number.
    Integer
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.15.5Product Component Reference Details

The product component reference links components from different product versions, which makes it possible to carry out migrations.

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 name used to identify the component reference.
    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.
    Subscription Product Component Reference State
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.15.6Product Fee Type

Fields
  • METERED_FEE
    Metered Fee
  • SETUP_FEE
    Setup Fee
  • PERIOD_FEE
    Period Fee

4.15.7Product Metered Fee Details

Properties
  • component
    The product component that the fee belongs to.
    Product Component
  • description
    The localized description of the fee that is displayed to the customer.
    Map of String String
  • id
    A unique identifier for the object.
    Long
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • metric
    The metric used to determine the resource consumption billed to the customer.
    Metric
  • name
    The localized name of the fee that is displayed to the customer.
    Map of String String
  • tierPricing
    The method used to calculate the tier price.
    Product Metered Tier Pricing
  • type
    The type of the fee.
    Product Fee Type
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.15.8Product Metered Fee Tier Details

Properties
  • fee
    The amount charged to the customer for each consumed unit at the end of a billing cycle.
    Collection of Persistable Currency Amount
  • id
    A unique identifier for the object.
    Long
  • meteredFee
    The metered fee that this tier belongs to.
    Product Metered Fee
  • startRange
    Starting from and including this quantity is contained in the tier.
    Decimal
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.15.9Product Metered Tier Pricing

Fields
  • CHEAPEST_TIER_PRICING
    Cheapest Tier Pricing
  • INCREMENTAL_DISCOUNT_PRICING
    Incremental Discount Pricing

4.15.10Product Period Fee Details

Properties
  • component
    The product component that the fee belongs to.
    Product Component
  • description
    The localized description of the fee that is displayed to the customer.
    Map of String String
  • id
    A unique identifier for the object.
    Long
  • ledgerEntryTitle
    The localized title that be used on ledger entries and invoices.
    Map of String String
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • name
    The localized name of the fee that is displayed to the customer.
    Map of String String
  • numberOfFreeTrialPeriods
    Positive
    The number of subscription billing cycles that count as a trial phase and during which no fees are charged.
    Integer
  • periodFee
    The amount charged to the customer for each billing cycle during the term of a subscription.
    Collection of Persistable Currency Amount
  • type
    The type of the fee.
    Product Fee Type
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.15.11Product Retirement 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
  • product
    The product that is to be retired.
    Subscription Product
  • respectTerminationPeriods
    Whether the subscriptions' termination periods should be respected.
    Boolean
  • targetProduct
    The product to which the subscriptions with the retiring product are to be migrated. If none is defined, the subscriptions are terminated.
    Subscription Product
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.15.12Product Setup Fee Details

Properties
  • component
    The product component that the fee belongs to.
    Product Component
  • description
    The localized description of the fee that is displayed to the customer.
    Map of String String
  • id
    A unique identifier for the object.
    Long
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • name
    The localized name of the fee that is displayed to the customer.
    Map of String String
  • onDowngradeCreditedAmount
    ≥ 1 options
    The amount charged to the customer when a subscription is downgraded.
    Collection of Persistable Currency Amount
  • onUpgradeCreditedAmount
    ≥ 1 options
    The amount charged to the customer when a subscription is upgraded.
    Collection of Persistable Currency Amount
  • setupFee
    ≥ 1 options
    The amount charged to the customer once when they subscribe to a subscription.
    Collection of Persistable Currency Amount
  • type
    The type of the fee.
    Product Fee Type
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.15.13Product Version Details

Properties
  • activatedOn
    The date and time when the product version was activated.
    DateTime
  • billingCycle
    The recurring period of time, typically monthly or annually, for which a subscriber is charged.
    String
  • comment
    A comment that describes the product version and why it was created. It is not disclosed to the subscriber.
    String
  • createdOn
    The date and time when the product version was created.
    DateTime
  • defaultCurrency
    The three-letter code (ISO 4217 format) of the product version's default currency.
    String
  • enabledCurrencies
    The three-letter codes (ISO 4217 format) of the currencies that the product version supports.
    Collection of String
  • id
    A unique identifier for the object.
    Long
  • incrementNumber
    Whenever a new version of a product is created, the number is increased and assigned.
    Integer
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • minimalNumberOfPeriods
    The minimum number of periods the subscription will run before it can be terminated.
    Integer
  • name
    The localized name of the product that is displayed to the customer.
    Map of String String
  • numberOfNoticePeriods
    The number of periods the subscription will keep running after its termination was requested.
    Integer
  • obsoletedOn
    The date and time when the product version was made obsolete.
    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
  • product
    The product that the version belongs to.
    Subscription Product
  • reference
    ≤ 125 chars
    The reference used to identify the product version.
    String
  • retiringFinishedOn
    The date and time when the product version was retired.
    DateTime
  • retiringStartedOn
    The date and time when the product version's retirement was started.
    DateTime
  • state
    The object's current state.
    Subscription Product Version State
  • taxCalculation
    The way taxes are calculated for fees.
    Tax Calculation
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.15.14Product Version Retirement 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
  • productVersion
    The product version that is to be retired.
    Product Version
  • respectTerminationPeriods
    Whether the subscriptions' termination periods should be respected.
    Boolean
  • targetProduct
    The product to which the subscriptions with the retiring product version are to be migrated. If none is defined, the subscriptions are terminated.
    Subscription Product
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.15.15Subscriber Details

A subscriber represents everyone who is subscribed to a product.

Properties
  • additionalAllowedPaymentMethodConfigurations
    Allow the subscriber to use these payment methods even if subscription products do not accept them.
    Collection of Long
    Payment Method Configuration
  • billingAddress
    The address associated with the subscriber for invoicing and transaction processing purposes.
    Address
  • description
    ≤ 200 chars
    The description used to identify the subscriber.
    String
  • disallowedPaymentMethodConfigurations
    Prevent the subscriber from using these payment methods even if subscription products do accept them.
    Collection of Long
    Payment Method Configuration
  • emailAddress
    ≤ 254 chars
    The email address that is used to communicate with the subscriber. There can be only one subscriber per space with the same email address.
    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
  • language
    The language that is used when communicating with the subscriber via emails and documents.
    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
  • 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
  • reference
    ≤ 100 chars
    The merchant's reference used to identify the subscriber.
    String
  • shippingAddress
    The address to where orders will be shipped.
    Address
  • 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.15.16Subscription Details

Properties
  • activatedOn
    The date and time when the subscription was activate.
    DateTime
  • affiliate
    The affiliate that led to the creation of the subscription.
    Subscription Affiliate
  • createdOn
    The date and time when the subscription was created.
    DateTime
  • currentProductVersion
    The version of the product that the subscription is currently linked to.
    Product Version
  • description
    ≤ 200 chars
    A description used to identify the subscription.
    String
  • id
    A unique identifier for the object.
    Long
  • initializedOn
    The date and time when the subscription was initialized.
    DateTime
  • 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
  • plannedTerminationDate
    The date and time when the subscription is planned to be terminated.
    DateTime
  • reference
    ≤ 100 chars
    The merchant's reference used to identify the subscription.
    String
  • state
    The object's current state.
    Subscription State
  • subscriber
    The subscriber that the subscription belongs to.
    Subscriber
  • terminatedBy
    The ID of the user the subscription was terminated by.
    Long
    User
  • terminatedOn
    The date and time when the subscription was terminated.
    DateTime
  • terminatingOn
    The date and time when the termination of the subscription started.
    DateTime
  • terminationScheduledOn
    The date and time when the subscription was scheduled to be terminated.
    DateTime
  • token
    The payment token that is used to charge the customer.
    Payment Token
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.15.17Subscription Affiliate 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
  • 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
  • name
    3 - 255 chars
    The name used to identify the affiliate.
    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
  • reference
    3 - 100 chars
    The reference used to identify the affiliate.
    String
  • 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.15.18Subscription Change Request Details

The subscription change request allows to change a subscription.

Properties

4.15.19Subscription Charge Details

The subscription charge represents a single charge carried out for a particular subscription.

Properties
  • createdOn
    The date and time when the charge was created.
    DateTime
  • discardedBy
    The ID of the user the charge was discarded by.
    Long
    User
  • discardedOn
    The date and time when the charge was discarded.
    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
    The date and time when the charge failed.
    DateTime
  • failedUrl
    9 - 500 options
    URL
    Virtual
    The URL to redirect the customer back to after they canceled or failed to authenticated their payment.
    String
  • id
    A unique identifier for the object.
    Long
  • language
    The language that is linked to the object.
    String
  • ledgerEntries
    The ledger entries that belong to the charge.
    Collection of Subscription Ledger Entry
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • plannedExecutionDate
    The date and time when the execution of the charge is planned.
    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
  • processingType
    The processing type specifies how the charge is to be processed.
    Subscription Charge Processing Type
  • reference
    ≤ 100 chars
    The merchant's reference used to identify the charge.
    String
  • state
    The object's current state.
    Subscription Charge State
  • subscription
    The subscription that the charge belongs to.
    Subscription
  • succeedOn
    The date and time when the charge succeeded.
    DateTime
  • successUrl
    9 - 500 options
    URL
    Virtual
    The URL to redirect the customer back to after they successfully authenticated their payment.
    String
  • transaction
    The transaction used to process the charge.
    Transaction
  • type
    The type specified how the charge was initiated.
    Subscription Charge Type
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.15.20Subscription Charge Processing Type

Fields
  • SYNCHRONOUS
    Synchronous
  • CHARGE_FLOW
    Charge Flow

4.15.21Subscription Charge State

Fields
  • SCHEDULED
    Scheduled
  • DISCARDED
    Discarded
  • PROCESSING
    Processing
  • SUCCESSFUL
    Successful
  • FAILED
    Failed

4.15.22Subscription Charge Type

Fields
  • MANUAL
    Manual
  • AUTOMATIC
    Automatic

4.15.23Subscription Component Configuration Details

Properties
  • component
    The component that is being configured.
    Long
    Product Component
  • id
    A unique identifier for the object.
    Long
  • linkedSpaceId
    The ID of the space this object belongs to.
    Long
    Space
  • quantity
    The quantity that should be applied to the component.
    Decimal
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.15.24Subscription Component Reference Configuration Details

The component reference configuration adjusts the product component for a particular subscription.

Properties
  • productComponentReferenceId
    The ID of the component reference that is being configured.
    Long
  • quantity
    The quantity that should be applied to the component.
    Decimal

4.15.25Subscription Create Request Details

The subscription create request holds all the data required to create a new subscription.

Properties

4.15.26Subscription Ledger Entry Details

The subscription ledger entry represents a single change on the subscription balance.

Properties
  • aggregatedTaxRate
    The total tax rate applied to the ledger entry, calculated from the rates of all tax lines.
    Decimal
  • amountExcludingTax
    The leger entry's amount with discounts applied, excluding taxes.
    Decimal
  • amountIncludingTax
    The leger entry's amount with discounts applied, including taxes.
    Decimal
  • createdBy
    The ID of the user the ledger entry was created by.
    Long
    User
  • createdOn
    The date and time when the object was created.
    DateTime
  • discountIncludingTax
    The discount allocated to the ledger entry, including taxes.
    Decimal
  • 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
  • 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
  • proRataCalculated
    Boolean
  • quantity
    The number of items that were consumed.
    Decimal
  • state
    The object's current state.
    Subscription Ledger Entry State
  • subscriptionVersion
    The subscription version that the ledger entry belongs to.
    Long
    Subscription Version
  • taxAmount
    The sum of all taxes applied to the ledger entry.
    Decimal
  • taxes
    A set of tax lines, each of which specifies a tax applied to the ledger entry.
    Collection of Tax
  • title
    1 - 150 chars
    The title that indicates what the ledger entry is about.
    String
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.15.27Subscription Ledger Entry State

Fields
  • OPEN
    Open
  • SCHEDULED
    Scheduled
  • PAID
    Paid

4.15.28Subscription Metric Type Details

The subscription metric type identifies the type of the metric.

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

4.15.29Subscription Period Bill Details

Properties
  • createdOn
    The date and time when the period bill was created.
    DateTime
  • effectivePeriodEndDate
    The date and time when the period actually ended.
    DateTime
  • 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
  • periodStartDate
    The date and time when the period started.
    DateTime
  • plannedPeriodEndDate
    The date and time when the period is planned to end.
    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
  • state
    The object's current state.
    Subscription Period Bill State
  • subscriptionVersion
    The subscription version that the period bill belongs to.
    Subscription Version
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.15.30Subscription Period Bill State

Fields
  • PENDING
    Pending
  • BILLED
    Billed

4.15.31Subscription Product Details

A subscription product represents a product to which a subscriber can subscribe to. A product defines how much the subscription costs and in what cycles the subscribe is charged.

Properties
  • allowedPaymentMethodConfigurations
    The payment methods that can be used to subscribe to this product. If none are selected, no restriction is applied.
    Collection of Long
    Payment Method Configuration
  • failedPaymentSuspensionPeriod
    The period after which a subscription that has been suspended due to a failed payment is terminated.
    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 name used to identify the product.
    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
  • productLocked
    Whether subscriptions can be switched to or from this product, or whether they are locked in.
    Boolean
  • reference
    ≤ 100 chars
    The merchant's reference used to identify the product, e.g. the SKU.
    String
  • sortOrder
    When listing products, they can be sorted by this number.
    Integer
  • spaceId
    The ID of the space this object belongs to.
    Long
    Space
  • state
    The object's current state.
    Subscription Product State
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.15.32Subscription Product Component Reference State

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

4.15.33Subscription Product State

Fields
  • CREATE
    Create
  • ACTIVE
    Active
  • INACTIVE
    Inactive
  • RETIRING
    Retiring
  • RETIRED
    Retired

4.15.34Subscription Product Version State

Fields
  • PENDING
    Pending
  • ACTIVE
    Active
  • OBSOLETE
    Obsolete
  • RETIRING
    Retiring
  • RETIRED
    Retired

4.15.35Subscription State

Fields
  • PENDING
    Pending
  • INITIALIZING
    Initializing
  • FAILED
    Failed
  • ACTIVE
    Active
  • SUSPENDED
    Suspended
  • TERMINATION_SCHEDULED
    Termination Scheduled
  • TERMINATING
    Terminating
  • TERMINATED
    Terminated

4.15.36Subscription Suspension Action

Fields
  • TERMINATE
    Terminate
  • REACTIVATE
    Reactivate

4.15.37Subscription Suspension Reason

Fields
  • FAILED_CHARGE
    Failed Charge
  • SUBSCRIBER_INITIATED_REFUND
    Subscriber Initiated Refund
  • MANUAL
    Manual

4.15.38Subscription Suspension State

Fields
  • RUNNING
    Running
  • ENDED
    Ended

4.15.39Subscription Update Request Details

Properties
  • description
    ≤ 200 chars
    A description used to identify the subscription.
    String

4.15.40Subscription Version Details

Properties
  • activatedOn
    The date and time when the subscription version was activated.
    DateTime
  • billingCurrency
    The three-letter code (ISO 4217 format) of the currency used to invoice the customer. Must be one of the currencies supported by the product.
    String
  • componentConfigurations
    The configurations of the subscription's components.
    Collection of Subscription Component Configuration
  • createdOn
    The date and time when the subscription version was created.
    DateTime
  • expectedLastPeriodEnd
    The date and time when the last period is expected to end.
    DateTime
  • failedOn
    The date and time when the subscription version failed.
    DateTime
  • 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
  • plannedTerminationDate
    The date and time when the termination of the subscription version is planned.
    DateTime
  • productVersion
    The product version that is subscribed to.
    Product Version
  • state
    The object's current state.
    Subscription Version State
  • subscription
    The subscription that this version belongs to.
    Subscription
  • terminatedOn
    The date and time when the subscription version was terminated.
    DateTime
  • terminatingOn
    The date and time when the termination of the subscription version started.
    DateTime
  • terminationIssuedOn
    The date and time when the termination of the subscription version was issued.
    DateTime
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.15.41Subscription Version State

Fields
  • PENDING
    Pending
  • INITIALIZING
    Initializing
  • FAILED
    Failed
  • ACTIVE
    Active
  • TERMINATING
    Terminating
  • TERMINATED
    Terminated

4.15.42Suspension Details

Properties
  • createdOn
    The date and time when the object was created.
    DateTime
  • effectiveEndDate
    The date and time when the suspension ended.
    DateTime
  • endAction
    Whether the subscription should be terminated or reactivated after the suspension has reached its end date.
    Subscription Suspension Action
  • 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
  • note
    ≤ 300 chars
    A note that contains details about the suspension. It is not disclosed to the subscriber.
    String
  • periodBill
    The period bill that led to the suspension of the subscription.
    Long
    Subscription Period Bill
  • plannedEndDate
    The date and time when the suspension is planned to end.
    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
  • reason
    The reason why the subscription was suspended.
    Subscription Suspension Reason
  • state
    The object's current state.
    Subscription Suspension State
  • subscription
    The subscription that this suspension belongs to.
    Long
    Subscription
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.15.43Tax Calculation

Fields
  • TAX_INCLUDED
    Tax Included
  • TAX_NOT_INCLUDED
    Tax Not Included

4.16Tax

4.16.1Tax Details

Properties
  • rate
    ≤ 100
    The tax rate to be applied.
    Decimal
  • title
    2 - 40 chars
    The name of the tax.
    String

4.16.2Tax Class 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 name used to identify the tax class.
    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.17User

4.17.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.17.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.17.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.17.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.17.5Role State

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

4.17.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.17.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.17.8User Account Role Details

Properties
  • account
    The account in which the role is assigned to the user.
    Long
    Account
  • appliesOnSubAccount
    Whether the role is assigned to the user in subaccounts only.
    Boolean
  • id
    A unique identifier for the object.
    Long
  • role
    The role that is assigned to the user.
    Long
    Role
  • user
    The user whose role this defines.
    Long
    User
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.17.9User Space Role Details

Properties
  • id
    A unique identifier for the object.
    Long
  • role
    The role that is assigned to the user.
    Long
    Role
  • space
    The space in which the role is assigned to the user.
    Long
    Space
  • user
    The user whose role this defines.
    Long
    User
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.17.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.18Web App

4.18.1Web App Confirmation Response Details

The confirmation response provides details about the installation of the web app.

Properties
  • access_token
    The access code granting permissions to the web service API according to the OAuth standard.
    String
  • scope
    The list of the permissions granted to the web app within the space.
    String
  • space
    The space that the web app was installed in.
    Space
  • state
    The state parameter that was provided in the authorization request.
    String
  • token_type
    The type of the access token that determines the authentication mechanism to use for accessing the web service API.
    String

4.19Webhook

4.19.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

4.19.2Webhook Identity Details

The webhook identity represents a set of keys that will be used to sign the webhook messages.

Properties
  • id
    A unique identifier for the object.
    Long
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • name
    ≤ 50 chars
    The name used to identify the webhook identity.
    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.19.3Webhook Listener Details

Properties
  • enablePayloadSignatureAndState
    Whether signature header and 'state' property are enabled in webhook payload.
    Boolean
  • entity
    The entity that is to be monitored.
    Long
    Webhook Listener Entity
  • entityStates
    The entity's target states that are to be monitored.
    Collection of String
  • id
    A unique identifier for the object.
    Long
  • identity
    The identity used to sign messages.
    Webhook Identity
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • name
    ≤ 50 chars
    The name used to identify the webhook listener.
    String
  • notifyEveryChange
    Whether every update of the entity or only state changes are to be monitored.
    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
  • state
    The object's current state.
    Creation Entity State
  • url
    The URL where notifications about entity changes are sent to.
    Webhook URL
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer

4.19.4Webhook Listener Entity Details

Properties
  • id
    A unique identifier for the object.
    Long
  • name
    The name used to identify the webhook listener entity.
    Map of String String
  • technicalName
    The name used to programmatically identify the webhook listener entity.
    String

4.19.5Webhook URL Details

Properties
  • applicationManaged
    Whether the webhook URL is managed by the application, and therefore cannot be changed via the user interface.
    Boolean
  • id
    A unique identifier for the object.
    Long
  • linkedSpaceId
    Virtual
    The ID of the space this object belongs to.
    Long
    Space
  • name
    ≤ 50 chars
    The name used to identify the webhook URL.
    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
  • url
    9 - 500 options
    URL
    The actual URL where notifications about entity changes are sent to.
    String
  • version
    The version is used for optimistic locking and incremented whenever the object is updated.
    Integer