Documentation
Documentation
Web Service API

1Introduction

The REST API allows to create integrations, retrieve data and automate workflows. It accepts and returns JSON-encoded data, uses standard HTTP response codes and authentication using JSON Web Tokens.

The OpenAPI specification provides the standardized documentation of the API that both humans and computers are able to discover and understand. Check the Swagger documentation for more information.

2Authentication

To authenticate a request, a JSON Web Token is included as an Authorization header. The token needs to be signed using an application user’s authentication key.

2.1Getting credentials

To be able to authenticate you need to create an application user first. You can do this in your account at Account > Users > Application Users.

After creating an application user, the user’s ID and authentication key will be shown to you. Please be aware, that once you close the dialog or browser window, you will not be able to see the authentication key again. So make sure to write it down.

Application user credentials

2.2Generating a JSON Web Token

Please refer to https://jwt.io/ to learn how to generate and sign JSON Web Tokens and to find corresponding libraries.

Header
{
    "alg": "HS256", // Defines the signing algorithm that is used, must be `HS256`
    "type": "JWT", // The type of the token, must be JWT
    "ver": 1 // The version of the JWT authorisation method
}
Payload
{
    "sub": "123456", // The ID of the application user whose authentication key is used to sign the token
    "iat": 1664375069, // The current UNIX timestamp in seconds, used to prevent https://en.wikipedia.org/wiki/Relay_attack
    "requestPath": "/api/customers/search?order=lastname", // The path component of the requested URL, including any query string
    "requestMethod": "GET" // The HTTP method of the request, as uppercase string
}

The JSON Web Token needs to be signed using your application user’s authentication key. Depending on the tool you are using to generate the token, you need to decode the authentication key, as you get it base64-encoded.

2.3Sending the JSON Web Token

The generated JSON Web Token is included as a header in the request to the API.

GET /api/customers/search?order=lastname HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsInZlciI6MX0.eyJzdWIiOiIxMjM0NTYiLCJpYXQiOjE2NjQzNzUwNjkwNTksInJlcXVlc3RQYXRoIjoiL2FwaS9jdXN0b21lcnMvc2VhcmNoP29yZGVyPWxhc3RuYW1lIiwicmVxdWVzdE1ldGhvZCI6IkdFVCJ9.1QNdpsjZSnavrJkNM7aiAWHEXZS_o9Tnpg6pt3VDBUA

3Errors

API methods return HTTP status codes to indicate success or failure. Some errors include an error code that allows to identify and handle the error programmatically. The response body to a failed request contains detailed information, see Error Response.

Status Description

400 Bad Request

The request was not accepted often due to missing or invalid parameters.

401 Unauthorized

The necessary authentication credentials are missing or incorrect.

403 Forbidden

The application user is missing the required permissions.

404 Not Found

The requested resource was not found.

406 Not Acceptable

The requested response format is not supported.

409 Conflict

The request conflicts with another request often because of to optimistic locking.

413 Payload Too Large

Too many operations in a bulk request.

415 Unsupported Media Type

The request provides unsupported or invalid data.

416 Range Not Satisfiable

The pagination offset exceeds the limit.

422 Unprocessable Entity

The request is well-formed but contains semantic errors. Check the response body for details.

429 Too Many Requests

Too many requests hit the API too quickly.

5xx Errors

An internal error occurred on the server.

4Optimistic Locking

If an object is modified by multiple users or processes at the same time, this can lead to race conditions. To prevent this, the API uses optimistic locking.

An object that is potentially affected will have a version property which gets incremented everytime the object is updated. When updating an object, its current version needs to be fetched and included in the update request.

If the version is missing or it does not match the current value, the update request will be declined and a response with HTTP status 409 Conflict will be returned. In this case, the current version needs to be fetched and the update request sent again.

5Expanding Responses

Many objects allow you to request additional information by expanding the response using the expand request parameter. This parameter is available on many API methods like list, search, create and update.

Properties that can be expanded are marked accordingly in this documentation. There are two different kinds of expandable properties.

Linked objects are often represented by their IDs in API responses. These objects can be expanded using the expand parameter to be fully included in the response.

Some available properties are not included in responses by default. They can be requested by using the expand parameter.

Properties can be expanded recursively by specifying nested fields using a dot (.). Expanding charge.transaction will include the full charge object as well as the full transaction object. The maximum depth is at four levels.

Multiple properties can be expanded at once by specifying all of them in the expand parameter separated by commas (,).

expand=charge.transaction,labels

6Search Syntax

The same search query syntax is used accross the API for all search API methods. The search query is passed in the query parameter.

6.1Grammar

A search query is made up of terms, connectives, modifiers and comparators. The search grammar is expressed as EBNF with the following terminal symbols:

Item Description

whitespace

Any sequence of space, tab, or newline characters

name

Any sequence of non-whitespace, non-special characters

value

Any name, or any quoted string (single or double quotes are both permitted)
Query
Query = Term { [ whitespace Connective ] whitespace Term }

A query consists of one or more terms separated by whitespace or single connectives.

Connectives
Connective = "AND" | "OR"

If no connective is specified between two terms, AND is implied.

Terms
Term = [ Modifier ] ( "(" Query ")" | name Comparator [ value ] )

A term consists of an optional modifier, followed by either a subquery enclosed in parantheses, or a name, comparator and value.
Values can be quoted (single or double quotes). If the value does not contain any whitespace, the quotes are optional.

Modifiers
Modifier = "-" | "NOT" whitespace

- with no following whitespace and NOT followed by whitespace mean the same thing.

Comparators
Comparator = ":" | ":<" | ":>" | ":<=" | ":>=" | ":*" | ":~"
Comparator Description

:

Equals (case-insensitive)

:<

Less than

:>

Greater than

:⇐

Less than or equal

:>=

Greater than or equal

:*

Is NULL

:~

Contains

6.2Examples

Basic query
query=firstName:"John Peter" lastName:Doe

Search for John Peter as first name AND Doe as last name

Linked object
query=charge.transaction.state=PENDING AND currency=EUR

Search for objects linked to pending transactions AND with currency EUR

Range
query=quantity:>2 quantity:<=10

Search for objects with quantities between 3 and 10.

Negation
query=NOT currency:EUR
query=-currency:EUR

Search that excludes objects with currency EUR.

Grouping
query=state:SUCCESSFUL AND (currency:CHF OR currency:EUR)

Search for successful objects with currency CHF or EUR

NULL
query=paymentMethod:*

Search for objects without a payment method.
The Is NULL comparator (:*) does not ask for a value.

Contains
query=color:~red,blue,green

Search for objects with all the colors red, blue and green.

7Sorting

The objects retrieved from a search API method can be sorted by specifying the order parameter. They can be ordered by multiple fields.

order=lastName
order=lastName+firstName
order=lastName:ASC+firstName:DESC

The fields are separated by a space. The order (ASC or DESC) can be explicitly specified by adding it after a :. If no order is specified, ASC is implied.

8Pagination

8.1List

The response of a list API method represents a single page of objects. The parameters limit, before, after and order can be used to control pagination. If you specify none of them, you will receive the first 10 objects in chronological order.

You can set the after parameter to an object’s ID to retrieve the page of objects coming immediately after the named object in the applied order. Similarly, you can use the before parameter to retrieve the objects coming immediately before the named object. Both parameters after and before can be set at the same time to get a specific range of objects.

Use the limit parameter to specify the maximum number of objects that should be returned. This cannot exceed 100.

8.2Search

The response of a search API method represents a single page of filtered objects. The parameters limit and offset can be used to control pagination. If you specify none of them, you will receive the first 10 objects.

The offset parameter allows you to get objects at an offset. So if you set offset to 20, the first 20 objects will be skipped and the first object returned will be the 21st.

Use the limit parameter to specify the maximum number of objects that should be returned. This cannot exceed 100.

9Metadata

Some objects have a metadata property. You can use this property to attach arbitrary key-value data to these objects. Metadata can be used for storing additional, structured information on an object. Metadata is not used or changed by the system.

You can specify up to 25 keys, with key names up to 40 and values up to 512 characters long.

Do not store any sensitive information (bank account numbers, card details, passwords, …​) in metadata.

10Services

This section details all API services and their operations. An operation may accept data as part of the path, in the request’s header, as query parameter or in the request’s body.

Here is an example request to update a customer:

POST /api/v2/customers/123?expand=metaData HTTP/1.1
Space: 1
Authorization: Bearer [calculated JWT token]

{"version": 1, "givenName": "Jane", "familyName": "Doe"}

10.1Analytics

10.1.1Analytics Queries (Analytics2)

10.1.1.1Get query executions for account. Account ID is mandatory (Target account ID of analytics query).

GET /api/v2.0/analytics/queries View in Client
Parameters
  • account
    Long Required
    HEADER
    Specifies the ID of the account the operation should be executed in.
  • offset
    Integer Required
    QUERY
    Offset of the result set (starts with 0)
  • limit
    Integer Required
    QUERY
    Size of the result set page (max 100)
Responses

10.1.1.2Get query execution for Portal analytics query token.

Get query execution for Portal analytics query token. (Potentially, this is a long-running request. Max request timeout ~100 sec. Queries are processed asynchronously and may take few minutes to reach the final status. Assume long polling, which can take up to 100 seconds. If obtained queryresult still has status "processing" - repeat the call later. Please avoid making frequent requests to this endpoint,this will not have any effect on query processing.HTTP status codes: 200 - OK. Query reached its final status. If query is under processing 200 status is returned with Retry-After header; 5xx - Internal server errors; )

GET /api/v2.0/analytics/queries/{portalQueryToken} View in Client
Long Polling Timeout

97 seconds

Parameters
  • portalQueryToken
    String Required
    PATH
    Portal query token.
  • account
    Long Required
    HEADER
    Specifies the ID of the account the operation should be executed in.
Responses

10.1.1.3Generate a short-living (5 min) URL of Analytics query result file.

Generate a short-living (5 min) URL of Analytics query result file. Each download of the output file is billed, we also count each file URL generation as potential attempt of file download. NB: Please, DO NOT use this endpoint for periodic checks of the result file availability - use 'Get query details by Query token' for periodic checks instead. HTTP status codes: 200 - OK (short-living URL is available); 202 - Result is expected to be available later; 204 - Empty result set (this may mean that query was cancelled or has failed); 404 - No query found for the given token;

GET /api/v2.0/analytics/queries/{portalQueryToken}/result View in Client
Parameters
  • portalQueryToken
    String Required
    PATH
    Portal query token.
  • account
    Long Required
    HEADER
    Specifies the ID of the account the operation should be executed in.
Responses
  • 200 OK
    String

10.1.1.4Submit query execution request

POST /api/v2.0/analytics/submit View in Client
Parameters
  • account
    Long Required
    HEADER
    Specifies the ID of the account the operation should be executed in.
Request Body
Analytics query execution request
JSON Required
Request to execute analytics query
Responses

10.1.1.5Cancel query execution for Portal query token. Account ID is mandatory (Target account ID of analytics query).

DELETE /api/v2.0/analytics/queries/{portalQueryToken} View in Client
Parameters
  • portalQueryToken
    String Required
    PATH
    Portal query token.
  • account
    Long Required
    HEADER
    Specifies the ID of the account the operation should be executed in.
Responses
  • 200 OK
    No response body.

10.2Core

10.2.1Base

10.2.1.1Accounts

10.2.1.1.1List all accounts
GET /api/v2.0/accounts View in Client
Parameters
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses
10.2.1.1.2Retrieve an account
GET /api/v2.0/accounts/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses
10.2.1.1.3Search accounts
GET /api/v2.0/accounts/search View in Client
Parameters
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses
10.2.1.1.4Create an account
POST /api/v2.0/accounts View in Client
Parameters
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Request Body
Account Create
JSON Required
Responses
10.2.1.1.5Activate an account
POST /api/v2.0/accounts/{id}/activate View in Client
Parameters
  • id
    Long Required
    PATH
Responses
  • 204 No Content
    No response body.
10.2.1.1.6Deactivate an account
POST /api/v2.0/accounts/{id}/deactivate View in Client
Parameters
  • id
    Long Required
    PATH
Responses
  • 204 No Content
    No response body.
10.2.1.1.7Update an account
PATCH /api/v2.0/accounts/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Request Body
Account Update
JSON Required
Responses
10.2.1.1.8Delete an account

Permanently deletes an account. It cannot be undone.

DELETE /api/v2.0/accounts/{id} View in Client
Parameters
  • id
    Long Required
    PATH
Responses
  • 204 No Content
    No response body.

10.2.1.2Spaces

10.2.1.2.1List all spaces
GET /api/v2.0/spaces View in Client
Parameters
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses
10.2.1.2.2Retrieve a space
GET /api/v2.0/spaces/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses
10.2.1.2.3Search spaces
GET /api/v2.0/spaces/search View in Client
Parameters
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses
10.2.1.2.4Create a space
POST /api/v2.0/spaces View in Client
Parameters
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Request Body
Space Create
JSON Required
Responses
10.2.1.2.5Update a space
PATCH /api/v2.0/spaces/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Request Body
Space Update
JSON Required
Responses
10.2.1.2.6Delete a space

Permanently deletes a space. It cannot be undone.

DELETE /api/v2.0/spaces/{id} View in Client
Parameters
  • id
    Long Required
    PATH
Responses
  • 204 No Content
    No response body.

10.3Customer

10.3.1Customer Addresses

10.3.1.1List all customer addresses

GET /api/v2.0/customers/{customerId}/addresses View in Client
Parameters
  • customerId
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses

10.3.1.2Retrieve a customer address

GET /api/v2.0/customers/{customerId}/addresses/{id} View in Client
Parameters
  • customerId
    Long Required
    PATH
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.3.1.3Search customer addresses

GET /api/v2.0/customers/{customerId}/addresses/search View in Client
Parameters
  • customerId
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses

10.3.1.4Create a customer address

POST /api/v2.0/customers/{customerId}/addresses View in Client
Parameters
  • customerId
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Request Body
Customer Address Create
JSON Required
Responses

10.3.1.5Set the default address for a customer

POST /api/v2.0/customers/{customerId}/addresses/{id}/default View in Client
Parameters
  • customerId
    Long Required
    PATH
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Responses
  • 204 No Content
    No response body.

10.3.1.6Update a customer address

PATCH /api/v2.0/customers/{customerId}/addresses/{id} View in Client
Parameters
  • customerId
    Long Required
    PATH
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Request Body
Customer Address Active
JSON Required
Responses

10.3.1.7Delete a customer address

DELETE /api/v2.0/customers/{customerId}/addresses/{id} View in Client
Parameters
  • customerId
    Long Required
    PATH
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Responses
  • 204 No Content
    No response body.

10.3.2Customer Comments

10.3.2.1List all customer comments

GET /api/v2.0/customers/{customerId}/comments View in Client
Parameters
  • customerId
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses

10.3.2.2Retrieve a customer comment

GET /api/v2.0/customers/{customerId}/comments/{id} View in Client
Parameters
  • customerId
    Long Required
    PATH
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.3.2.3Search customer comments

GET /api/v2.0/customers/{customerId}/comments/search View in Client
Parameters
  • customerId
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses

10.3.2.4Create a customer comment

POST /api/v2.0/customers/{customerId}/comments View in Client
Parameters
  • customerId
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Request Body
Customer Comment Create
JSON Required
Responses

10.3.2.5Pin a comment to the top

POST /api/v2.0/customers/{customerId}/comments/{id}/pin View in Client
Parameters
  • customerId
    Long Required
    PATH
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Responses
  • 204 No Content
    No response body.

10.3.2.6Remove a pinned comment from the top

POST /api/v2.0/customers/{customerId}/comments/{id}/unpin View in Client
Parameters
  • customerId
    Long Required
    PATH
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Responses
  • 204 No Content
    No response body.

10.3.2.7Update a customer comment

PATCH /api/v2.0/customers/{customerId}/comments/{id} View in Client
Parameters
  • customerId
    Long Required
    PATH
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Request Body
Customer Comment Active
JSON Required
Responses

10.3.2.8Delete a customer comment

DELETE /api/v2.0/customers/{customerId}/comments/{id} View in Client
Parameters
  • customerId
    Long Required
    PATH
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Responses
  • 204 No Content
    No response body.

10.3.3Customers

10.3.3.1List all customers

GET /api/v2.0/customers View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses

10.3.3.2Retrieve a customer

GET /api/v2.0/customers/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.3.3.3List a customer's email addresses

GET /api/v2.0/customers/{id}/email-addresses View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.3.3.4Search customers

GET /api/v2.0/customers/search View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses

10.3.3.5Create a customer

POST /api/v2.0/customers View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Request Body
Customer Create
JSON Required
Responses

10.3.3.6Merge two customers

POST /api/v2.0/customers/{id}/merge/{other} View in Client
Parameters
  • id
    Long Required
    PATH
  • other
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.3.3.7Create multiple customers

POST /api/v2.0/customers/bulk View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Request Body
Collection of Customer Create
JSON Required
Responses

10.3.3.8Update a customer

PATCH /api/v2.0/customers/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Request Body
Customer Active
JSON Required
Responses

10.3.3.9Update multiple customers

PATCH /api/v2.0/customers/bulk View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Request Body
Collection of Customer Active
JSON Required
Responses

10.3.3.10Delete a customer

DELETE /api/v2.0/customers/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Responses
  • 204 No Content
    No response body.

10.3.3.11Delete multiple customers

DELETE /api/v2.0/customers/bulk View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Request Body
Collection of Long
JSON Required
Responses

10.4Document

10.4.1Document Template Types

10.4.1.1List all document template types

GET /api/v2.0/document-templates/types View in Client
Parameters
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses

10.4.1.2Retrieve a document template type

GET /api/v2.0/document-templates/types/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.4.1.3Search document template types

GET /api/v2.0/document-templates/types/search View in Client
Parameters
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses

10.4.2Document Templates

10.4.2.1List all document templates

GET /api/v2.0/document-templates View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses

10.4.2.2Retrieve a document template

GET /api/v2.0/document-templates/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.4.2.3Search document templates

GET /api/v2.0/document-templates/search View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses

10.5Internationalization

10.5.1Countries

10.5.1.1List all countries

GET /api/v2.0/countries View in Client
Parameters
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.5.1.2Retrieve a country

GET /api/v2.0/countries/{code} View in Client
Parameters
  • code
    String Required
    PATH
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.5.1.3List all states for a country

GET /api/v2.0/countries/{countryCode}/states View in Client
Parameters
  • countryCode
    String Required
    PATH
Responses

10.5.1.4Search countries

GET /api/v2.0/countries/search View in Client
Parameters
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses

10.5.1.5List all country states

GET /api/v2.0/countries/states View in Client
Responses

10.5.1.6Retrieve a country state

GET /api/v2.0/countries/states/{id} View in Client
Parameters
  • id
    String Required
    PATH
Responses

10.5.2Currencies

10.5.2.1List all currencies

GET /api/v2.0/currencies View in Client
Parameters
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.5.2.2Retrieve a currency

GET /api/v2.0/currencies/{code} View in Client
Parameters
  • code
    String Required
    PATH
Responses

10.5.2.3Search currencies

GET /api/v2.0/currencies/search View in Client
Parameters
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses

10.5.3Languages

10.5.3.1List all languages

GET /api/v2.0/languages View in Client
Parameters
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.5.3.2Retrieve a language

GET /api/v2.0/languages/{code} View in Client
Parameters
  • code
    String Required
    PATH
Responses

10.5.3.3Search languages

GET /api/v2.0/languages/search View in Client
Parameters
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses

10.5.4Legal Organization Forms

10.5.4.1List all legal organization forms

GET /api/v2.0/legal-organization-forms View in Client
Parameters
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses

10.5.4.2Retrieve a legal organization form

GET /api/v2.0/legal-organization-forms/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.5.4.3Search legal organization forms

GET /api/v2.0/legal-organization-forms/search View in Client
Parameters
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses

10.6Label

10.6.1Label Descriptors

10.6.1.1List all label descriptors

GET /api/v2.0/label-descriptors View in Client
Parameters
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses

10.6.1.2Retrieve a label descriptor

GET /api/v2.0/label-descriptors/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.6.1.3List all label descriptor groups

GET /api/v2.0/label-descriptors/groups View in Client
Parameters
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses

10.6.1.4Retrieve a label descriptor group

GET /api/v2.0/label-descriptors/groups/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.6.1.5Search label descriptor groups

GET /api/v2.0/label-descriptors/groups/search View in Client
Parameters
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses

10.6.1.6Search label descriptors

GET /api/v2.0/label-descriptors/search View in Client
Parameters
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses

10.6.2Static Values

10.6.2.1List all static values

GET /api/v2.0/static-values View in Client
Parameters
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses

10.6.2.2Retrieve a static value

GET /api/v2.0/static-values/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.6.2.3Search static values

GET /api/v2.0/static-values/search View in Client
Parameters
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses

10.7Manual Task

10.7.1Manual Tasks

10.7.1.1List all manual tasks

GET /api/v2.0/manual-tasks View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses

10.7.1.2Retrieve a manual task

GET /api/v2.0/manual-tasks/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.7.1.3Retrieve a manual task's notification message

GET /api/v2.0/manual-tasks/{id}/notification View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Responses
  • 200 OK
    String

10.7.1.4Search manual tasks

GET /api/v2.0/manual-tasks/search View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses

10.7.1.5Process a manual task's action

POST /api/v2.0/manual-tasks/{id}/action/{actionId} View in Client
Parameters
  • id
    Long Required
    PATH
  • actionId
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Responses
  • 204 No Content
    No response body.

10.8Payment

10.8.1Bank Accounts

10.8.1.1List all bank accounts

GET /api/v2.0/payment/bank-accounts View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses

10.8.1.2Retrieve a bank account

GET /api/v2.0/payment/bank-accounts/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.8.1.3Search bank accounts

GET /api/v2.0/payment/bank-accounts/search View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses

10.8.2Bank Transactions

10.8.2.1List all bank transactions

GET /api/v2.0/payment/bank-transactions View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses

10.8.2.2Retrieve a bank transaction

GET /api/v2.0/payment/bank-transactions/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.8.2.3Search bank transactions

GET /api/v2.0/payment/bank-transactions/search View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses

10.8.3Charge Bank Transactions

10.8.3.1List all charge bank transactions

GET /api/v2.0/payment/bank-transactions/charges View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses

10.8.3.2Retrieve a charge bank transaction

GET /api/v2.0/payment/bank-transactions/charges/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.8.3.3Search charge bank transactions

GET /api/v2.0/payment/bank-transactions/charges/search View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses

10.8.4Client Platforms

10.8.4.1List all client platforms

GET /api/v2.0/payment/transaction/client-platforms View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses

10.8.4.2Retrieve the client platform based on id

GET /api/v2.0/payment/transaction/client-platforms/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.8.4.3Search client platforms

GET /api/v2.0/payment/transaction/client-platforms/search View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses

10.8.5Currency Bank Accounts

10.8.5.1List all currency bank accounts

GET /api/v2.0/payment/currency-bank-accounts View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses

10.8.5.2Retrieve a currency bank account

GET /api/v2.0/payment/currency-bank-accounts/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.8.5.3Search currency bank accounts

GET /api/v2.0/payment/currency-bank-accounts/search View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses

10.8.6External Transfer Bank Transactions

10.8.6.1List all external transfer bank transactions

GET /api/v2.0/payment/bank-transactions/external-transfers View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses

10.8.6.2Retrieve an external transfer bank transaction

GET /api/v2.0/payment/bank-transactions/external-transfers/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.8.6.3Search external transfer bank transactions

GET /api/v2.0/payment/bank-transactions/external-transfers/search View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses

10.8.7Internal Transfer Bank Transactions

10.8.7.1List all internal transfer bank transactions

GET /api/v2.0/payment/bank-transactions/internal-transfers View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses

10.8.7.2Retrieve an internal transfer bank transaction

GET /api/v2.0/payment/bank-transactions/internal-transfers/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.8.7.3Search internal transfer bank transactions

GET /api/v2.0/payment/bank-transactions/internal-transfers/search View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses

10.8.8Payment Connector Configurations

10.8.8.1List all payment connector configurations

GET /api/v2.0/payment/connector-configurations View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses

10.8.8.2Retrieve a payment connector configuration

GET /api/v2.0/payment/connector-configurations/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.8.8.3Search payment connector configurations

GET /api/v2.0/payment/connector-configurations/search View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses

10.8.8.4Create a payment connector configuration

POST /api/v2.0/payment/connector-configurations View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Request Body
Payment Connector Configuration Create
JSON Required
Responses

10.8.8.5Update a payment connector configuration

PATCH /api/v2.0/payment/connector-configurations/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Request Body
Payment Connector Configuration Update
JSON Required
Responses

10.8.8.6Delete a payment connector configuration

Permanently deletes a payment connector configuration. It cannot be undone.

DELETE /api/v2.0/payment/connector-configurations/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Responses
  • 204 No Content
    No response body.

10.8.9Payment Connectors

10.8.9.1List all payment connectors.

GET /api/v2.0/payment/connectors View in Client
Parameters
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses

10.8.9.2Retrieve a payment connector.

GET /api/v2.0/payment/connectors/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.8.9.3Search payment connectors.

GET /api/v2.0/payment/connectors/search View in Client
Parameters
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses

10.8.10Payment Links

10.8.10.1List all payment links

GET /api/v2.0/payment/links View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses

10.8.10.2Retrieve a payment link

GET /api/v2.0/payment/links/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.8.10.3Search payment links

GET /api/v2.0/payment/links/search View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses

10.8.10.4Create a payment link

POST /api/v2.0/payment/links View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Request Body
Payment Link Create
JSON Required
Responses

10.8.10.5Update a payment link

PATCH /api/v2.0/payment/links/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Request Body
Payment Link Update
JSON Required
Responses

10.8.10.6Delete a payment link

Permanently deletes a payment link. It cannot be undone.

DELETE /api/v2.0/payment/links/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Responses
  • 204 No Content
    No response body.

10.8.11Payment Method Brands

10.8.11.1List all payment method brands.

GET /api/v2.0/payment/method-brands View in Client
Parameters
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses

10.8.11.2Retrieve a payment method brand.

GET /api/v2.0/payment/method-brands/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.8.11.3Search payment method brands.

GET /api/v2.0/payment/method-brands/search View in Client
Parameters
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses

10.8.12Payment Method Configurations

10.8.12.1List all payment method configurations

GET /api/v2.0/payment/method-configurations View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses

10.8.12.2Retrieve a payment method configuration

GET /api/v2.0/payment/method-configurations/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.8.12.3Search payment method configurations

GET /api/v2.0/payment/method-configurations/search View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses

10.8.12.4Create a payment method configuration

POST /api/v2.0/payment/method-configurations View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Request Body
Payment Method Configuration Create
JSON Required
Responses

10.8.12.5Update a payment method configuration

PATCH /api/v2.0/payment/method-configurations/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Request Body
Payment Method Configuration Update
JSON Required
Responses

10.8.12.6Delete a payment method configuration

Permanently deletes a payment method configuration.

DELETE /api/v2.0/payment/method-configurations/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Responses
  • 204 No Content
    No response body.

10.8.13Payment Methods

10.8.13.1List all payment methods.

GET /api/v2.0/payment/methods View in Client
Parameters
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses

10.8.13.2Retrieve a payment method.

GET /api/v2.0/payment/methods/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.8.13.3Search payment methods.

GET /api/v2.0/payment/methods/search View in Client
Parameters
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses

10.8.14Payment Processor Configurations

10.8.14.1List all payment processor configurations

GET /api/v2.0/payment/processor-configurations View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses

10.8.14.2Retrieve a payment processor configuration

GET /api/v2.0/payment/processor-configurations/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.8.14.3Search payment processor configurations

GET /api/v2.0/payment/processor-configurations/search View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses

10.8.14.4Create a payment processor configuration

POST /api/v2.0/payment/processor-configurations View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Request Body
Processor Configuration Create
JSON Required
Responses

10.8.14.5Update a payment processor configuration

PATCH /api/v2.0/payment/processor-configurations/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Request Body
Processor Configuration Active
JSON Required
Responses

10.8.14.6Delete a payment processor configuration

Permanently deletes a payment processor configuration.

DELETE /api/v2.0/payment/processor-configurations/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Responses
  • 204 No Content
    No response body.

10.8.15Payment Processors

10.8.15.1List all payment processors.

GET /api/v2.0/payment/processors View in Client
Parameters
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses

10.8.15.2Retrieve a payment processor.

GET /api/v2.0/payment/processors/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.8.15.3Search payment processors.

GET /api/v2.0/payment/processors/search View in Client
Parameters
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses

10.8.16Payment Terminals

10.8.16.1List all payment terminals

GET /api/v2.0/payment/terminals View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses

10.8.16.2Retrieve a payment terminal

GET /api/v2.0/payment/terminals/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.8.16.3Create Till Connection Credentials

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

GET /api/v2.0/payment/terminals/{id}/till-connection-credentials View in Client
Parameters
  • id
    Long Required
    PATH
    The ID of the terminal which should be used to process the transaction.
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • transactionId
    Long Required
    QUERY
    The ID of the transaction which is used to process with the terminal.
  • language
    String
    QUERY
    The language that the messages should be rendered in.
Responses
  • 200 OK
    String

10.8.16.4Search payment terminals

GET /api/v2.0/payment/terminals/search View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses

10.8.16.5Create a payment terminal

POST /api/v2.0/payment/terminals View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Request Body
Payment Terminal Create
JSON Required
Responses

10.8.16.6Link a device with a payment terminal

POST /api/v2.0/payment/terminals/{id}/link View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • serialNumber
    String Required
    QUERY
    The serial number of the device to be linked with the payment terminal.
Responses
  • 204 No Content
    No response body.

10.8.16.7Perform 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.

POST /api/v2.0/payment/terminals/{id}/perform-transaction View in Client
Long Polling Timeout

90 seconds

Parameters
  • id
    Long Required
    PATH
    The ID of the terminal which should be used to process the transaction.
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • transactionId
    Long Required
    QUERY
    The ID of the transaction which is used to process with the terminal.
  • languageCode
    String
    QUERY
    The language in which the messages should be rendered in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.8.16.8Remotely trigger the final balance

POST /api/v2.0/payment/terminals/{id}/trigger-final-balance View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Responses

10.8.16.9Unlink any device from a payment terminal

POST /api/v2.0/payment/terminals/{id}/unlink View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Responses
  • 204 No Content
    No response body.

10.8.16.10Perform 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.

POST /api/v2.0/payment/terminals/by-identifier/{identifier}/perform-transaction View in Client
Long Polling Timeout

90 seconds

Parameters
  • identifier
    String Required
    PATH
    The identifier (TID) of the terminal which should be used to process the transaction.
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • transactionId
    Long Required
    QUERY
    The ID of the transaction which is used to process with the terminal.
  • languageCode
    String
    QUERY
    The language in which the messages should be rendered in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.8.16.11Remotely trigger the final balance by identifier

POST /api/v2.0/payment/terminals/by-identifier/{identifier}/trigger-final-balance View in Client
Parameters
  • identifier
    String Required
    PATH
    The unique identifier of the terminal.
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Responses

10.8.16.12Update a payment terminal

PATCH /api/v2.0/payment/terminals/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Request Body
Payment Terminal Update
JSON Required
Responses

10.8.16.13Delete a payment terminal

Permanently deletes a payment terminal. It cannot be undone.

DELETE /api/v2.0/payment/terminals/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Responses
  • 204 No Content
    No response body.

10.8.17Refund Bank Transactions

10.8.17.1List all refund bank transactions

GET /api/v2.0/payment/bank-transactions/refunds View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses

10.8.17.2Retrieve a refund bank transaction

GET /api/v2.0/payment/bank-transactions/refunds/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.8.17.3Search refund bank transactions

GET /api/v2.0/payment/bank-transactions/refunds/search View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses

10.8.18Refund Comments

10.8.18.1List all refund comments

GET /api/v2.0/payment/refunds/{refundId}/comments View in Client
Parameters
  • refundId
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses

10.8.18.2Retrieve a refund comment

GET /api/v2.0/payment/refunds/{refundId}/comments/{id} View in Client
Parameters
  • refundId
    Long Required
    PATH
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.8.18.3Search refund comments

GET /api/v2.0/payment/refunds/{refundId}/comments/search View in Client
Parameters
  • refundId
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses

10.8.18.4Create a refund comment

POST /api/v2.0/payment/refunds/{refundId}/comments View in Client
Parameters
  • refundId
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Request Body
Comment Create
JSON Required
Responses

10.8.18.5Pin a comment to the top

POST /api/v2.0/payment/refunds/{refundId}/comments/{id}/pin View in Client
Parameters
  • refundId
    Long Required
    PATH
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Responses
  • 204 No Content
    No response body.

10.8.18.6Remove the pinned comment from the top

POST /api/v2.0/payment/refunds/{refundId}/comments/{id}/unpin View in Client
Parameters
  • refundId
    Long Required
    PATH
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Responses
  • 204 No Content
    No response body.

10.8.18.7Update a refund comment

PATCH /api/v2.0/payment/refunds/{refundId}/comments/{id} View in Client
Parameters
  • refundId
    Long Required
    PATH
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Request Body
Comment Active
JSON Required
Responses

10.8.18.8Delete a refund comment

DELETE /api/v2.0/payment/refunds/{refundId}/comments/{id} View in Client
Parameters
  • refundId
    Long Required
    PATH
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Responses
  • 204 No Content
    No response body.

10.8.19Refund Recovery Bank Transactions

10.8.19.1List all refund recovery bank transactions

GET /api/v2.0/payment/bank-transactions/refund-recoveries View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses

10.8.19.2Retrieve a refund recovery bank transaction

GET /api/v2.0/payment/bank-transactions/refund-recoveries/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.8.19.3Search refund recovery bank transactions

GET /api/v2.0/payment/bank-transactions/refund-recoveries/search View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses

10.8.20Transaction Comments

10.8.20.1List all transaction comments

GET /api/v2.0/payment/transactions/{transactionId}/comments View in Client
Parameters
  • transactionId
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses

10.8.20.2Retrieve a transaction comment

GET /api/v2.0/payment/transactions/{transactionId}/comments/{id} View in Client
Parameters
  • transactionId
    Long Required
    PATH
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.8.20.3Search transaction comments

GET /api/v2.0/payment/transactions/{transactionId}/comments/search View in Client
Parameters
  • transactionId
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses

10.8.20.4Create a transaction comment

POST /api/v2.0/payment/transactions/{transactionId}/comments View in Client
Parameters
  • transactionId
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Request Body
Comment Create
JSON Required
Responses

10.8.20.5Pin a comment to the top

POST /api/v2.0/payment/transactions/{transactionId}/comments/{id}/pin View in Client
Parameters
  • transactionId
    Long Required
    PATH
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Responses
  • 204 No Content
    No response body.

10.8.20.6Remove the pinned comment from the top

POST /api/v2.0/payment/transactions/{transactionId}/comments/{id}/unpin View in Client
Parameters
  • transactionId
    Long Required
    PATH
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Responses
  • 204 No Content
    No response body.

10.8.20.7Update a transaction comment

PATCH /api/v2.0/payment/transactions/{transactionId}/comments/{id} View in Client
Parameters
  • transactionId
    Long Required
    PATH
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Request Body
Comment Active
JSON Required
Responses

10.8.20.8Delete a transaction comment

DELETE /api/v2.0/payment/transactions/{transactionId}/comments/{id} View in Client
Parameters
  • transactionId
    Long Required
    PATH
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Responses
  • 204 No Content
    No response body.

10.8.21Transaction Invoice Comments

10.8.21.1List all transaction invoice comments

GET /api/v2.0/payment/transactions/invoices/{invoiceId}/comments View in Client
Parameters
  • invoiceId
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses

10.8.21.2Retrieve a transaction invoice comment

GET /api/v2.0/payment/transactions/invoices/{invoiceId}/comments/{id} View in Client
Parameters
  • invoiceId
    Long Required
    PATH
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.8.21.3Search transaction invoice comments

GET /api/v2.0/payment/transactions/invoices/{invoiceId}/comments/search View in Client
Parameters
  • invoiceId
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses

10.8.21.4Create a transaction invoice comment

POST /api/v2.0/payment/transactions/invoices/{invoiceId}/comments View in Client
Parameters
  • invoiceId
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Request Body
Comment Create
JSON Required
Responses

10.8.21.5Pin a comment to the top

POST /api/v2.0/payment/transactions/invoices/{invoiceId}/comments/{id}/pin View in Client
Parameters
  • invoiceId
    Long Required
    PATH
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Responses
  • 204 No Content
    No response body.

10.8.21.6Remove the pinned comment from the top

POST /api/v2.0/payment/transactions/invoices/{invoiceId}/comments/{id}/unpin View in Client
Parameters
  • invoiceId
    Long Required
    PATH
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Responses
  • 204 No Content
    No response body.

10.8.21.7Update a transaction comment

PATCH /api/v2.0/payment/transactions/invoices/{invoiceId}/comments/{id} View in Client
Parameters
  • invoiceId
    Long Required
    PATH
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Request Body
Comment Active
JSON Required
Responses

10.8.21.8Delete a transaction comment

DELETE /api/v2.0/payment/transactions/invoices/{invoiceId}/comments/{id} View in Client
Parameters
  • invoiceId
    Long Required
    PATH
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Responses
  • 204 No Content
    No response body.

10.8.22Transaction Line Item Versions

10.8.22.1List all transaction line item versions

GET /api/v2.0/payment/transactions/line-item-versions View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses

10.8.22.2Retrieve a transaction line item version

GET /api/v2.0/payment/transactions/line-item-versions/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.8.22.3Search transaction line item versions

GET /api/v2.0/payment/transactions/line-item-versions/search View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses

10.8.22.4Create a transaction line item version

POST /api/v2.0/payment/transactions/line-item-versions View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Request Body
Transaction Line Item Version . Create
JSON Required
Responses

10.8.23Transactions

10.8.23.1List all transactions

GET /api/v2.0/payment/transactions View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses

10.8.23.2Retrieve a transaction

GET /api/v2.0/payment/transactions/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.8.23.3Fetch Charge Flow Payment Page URL

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 when it cannot be invoked.

GET /api/v2.0/payment/transactions/{id}/charge-flow/payment-page-url View in Client
Parameters
  • id
    Long Required
    PATH
    The transaction id of the transaction for which the URL of the charge flow should be fetched.
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Responses
  • 200 OK
    String

10.8.23.4Check If Token Creation Is Possible

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

GET /api/v2.0/payment/transactions/{id}/check-token-creation-possible View in Client
Parameters
  • id
    Long Required
    PATH
    The id of the transaction for which we want to check if the token can be created or not.
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Responses
  • 200 OK
    Boolean

10.8.23.5Create Transaction Credentials

Create transaction credentials to delegate temporarily the access to the web service API for this particular transaction.

GET /api/v2.0/payment/transactions/{id}/credentials View in Client
Parameters
  • id
    Long Required
    PATH
    The id of the transaction.
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Responses
  • 200 OK
    String

10.8.23.6Build JavaScript URL for iframe

Ccreates the URL which can be used to embed the JavaScript for handling the iFrame checkout flow.

GET /api/v2.0/payment/transactions/{id}/iframe-javascript-url View in Client
Parameters
  • id
    Long Required
    PATH
    The id of the transaction for which the URL should be created.
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Responses
  • 200 OK
    String

10.8.23.7getInvoiceDocument

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

GET /api/v2.0/payment/transactions/{id}/invoice-document View in Client
Parameters
  • id
    Long Required
    PATH
    The id of the transaction to get the document for.
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • targetMediaTypeId
    Long
    QUERY
    The id of the target media type for which the document should be generated.
Responses

10.8.23.8getLatestSuccessfulTransactionLineItemVersion

GET /api/v2.0/payment/transactions/{id}/latest-line-item-version View in Client
Parameters
  • id
    Long Required
    PATH
    The id of the transaction to get the latest line item version for.
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.8.23.9Build JavaScript URL

Creates the URL which can be used to embed the JavaScript for handling the Lightbox checkout flow.

GET /api/v2.0/payment/transactions/{id}/lightbox-javascript-url View in Client
Parameters
  • id
    Long Required
    PATH
    The id of the transaction for which the URL should be created.
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Responses
  • 200 OK
    String

10.8.23.10getPackingSlipDocument

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

GET /api/v2.0/payment/transactions/{id}/packing-slip-document View in Client
Parameters
  • id
    Long Required
    PATH
    The id of the transaction to get the document for.
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • targetMediaTypeId
    Long
    QUERY
    The id of the target media type for which the document should be generated.
Responses

10.8.23.11Fetch Possible Payment Method Configurations

Get the payment method configurations which can be used with the provided transaction.

GET /api/v2.0/payment/transactions/{id}/payment-method-configurations View in Client
Parameters
  • id
    Long Required
    PATH
    The id of the transaction
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • integrationMode
    String Required
    QUERY
    The type of integration that is applied on the transaction.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.8.23.12Build Payment Page URL

Creates the URL to which the user should be redirected to when the payment page should be used.

GET /api/v2.0/payment/transactions/{id}/payment-page-url View in Client
Parameters
  • id
    Long Required
    PATH
    The id of the transaction for which the URL should be created.
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Responses
  • 200 OK
    String

10.8.23.13Fetch Receipts

Returns all receipts for the requested terminal transaction.

GET /api/v2.0/payment/transactions/{id}/terminal-receipts View in Client
Parameters
  • id
    Long Required
    PATH
    The ID of the transaction which is used to process with the terminal.
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Request Body
Terminal Receipt Fetch Request
JSON Required
Responses

10.8.23.14findByCredentials

GET /api/v2.0/payment/transactions/by-credentials/{credentials} View in Client
Parameters
  • credentials
    String Required
    PATH
    Identifies the transaction and contains the security details which grants the access this operation.
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.8.23.15Build Mobile SDK URL

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/v2.0/payment/transactions/by-credentials/{credentials}/mobile-sdk-url View in Client
Parameters
  • credentials
    String Required
    PATH
    The credentials identify the transaction and contain the security details which grant the access to this operation.
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Responses
  • 200 OK
    String

10.8.23.16Fetch One Click Tokens with Credentials

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

GET /api/v2.0/payment/transactions/by-credentials/{credentials}/one-click-tokens View in Client
Parameters
  • credentials
    String Required
    PATH
    Identifies the transaction and contains the security details which grants the access this operation.
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.8.23.17Fetch Possible Payment Method Configurations

Get the payment method configurations which can be used with the provided transaction.

GET /api/v2.0/payment/transactions/by-credentials/{credentials}/payment-method-configurations View in Client
Parameters
  • credentials
    String Required
    PATH
    The credentials of the transaction
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • integrationMode
    String Required
    QUERY
    Defines the type of integration that is applied on the transaction.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.8.23.18Export transactions

Export transactions into a CSV file.

GET /api/v2.0/payment/transactions/export View in Client
Long Polling Timeout

60 seconds

Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • fields
    Collection of String
    QUERY
    The fields to be included in the export.
  • limit
    Integer
    QUERY
    1 - 9,223,372,036,854,775,807
    A limit on the number of objects to be returned. Default is 2,000.
  • offset
    Integer
    QUERY
    ≤ 100,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses
  • 200 OK
    text/csv

10.8.23.19Search transactions

GET /api/v2.0/payment/transactions/search View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses

10.8.23.20Create Transaction

POST /api/v2.0/payment/transactions View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Request Body
Transaction Create
JSON Required
The transaction object which should be created.
Responses

10.8.23.21applyFlow

Apply the appropriate charge flow to the specified transaction.

POST /api/v2.0/payment/transactions/{id}/charge-flow/apply View in Client
Parameters
  • id
    Long Required
    PATH
    The id of the transaction which should be processed asynchronously with a charge flow.
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.8.23.22Cancel Charge Flow

Cancel the charge flow that is linked with the transaction indicated by the given ID.

POST /api/v2.0/payment/transactions/{id}/charge-flow/cancel View in Client
Parameters
  • id
    Long Required
    PATH
    The ID of the transaction for which the charge flow should be canceled.
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.8.23.23updateChargeFlowRecipient

POST /api/v2.0/payment/transactions/{id}/charge-flow/update-recipient View in Client
Parameters
  • id
    Long Required
    PATH
    The transaction id of the transaction whose recipient should be updated.
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • type
    Long Required
    QUERY
    The id of the charge flow configuration type to recipient should be updated for.
  • recipient
    String Required
    QUERY
    The recipient address that should be used to send the payment URL.
Responses
  • 204 No Content
    No response body.

10.8.23.24completeOffline

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/v2.0/payment/transactions/{id}/complete-offline View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.8.23.25completeOnline

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/v2.0/payment/transactions/{id}/complete-online View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.8.23.26completePartiallyOffline

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

POST /api/v2.0/payment/transactions/{id}/complete-partially-offline View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Request Body
Transaction Completion Details
JSON Required
Responses

10.8.23.27completePartiallyOnline

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/v2.0/payment/transactions/{id}/complete-partially-online View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Request Body
Transaction Completion Details
JSON Required
Responses

10.8.23.28Confirm

Marks the transaction as confirmed. Once the transaction is confirmed no more changes can be applied.

POST /api/v2.0/payment/transactions/{id}/confirm View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Request Body
Transaction Pending
JSON Required
The transaction JSON object to update and confirm.
Responses

10.8.23.29Process Card Transaction

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

POST /api/v2.0/payment/transactions/{id}/process-card-details View in Client
Parameters
  • id
    Long Required
    PATH
    The ID of the transaction which should be processed.
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Request Body
Authenticated Card Request
JSON Required
The transaction processing request containing the card data.
Responses

10.8.23.30Process Card Transaction 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/v2.0/payment/transactions/{id}/process-card-details-threed View in Client
Parameters
  • id
    Long Required
    PATH
    The ID of the transaction which should be processed.
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Request Body
Tokenized Card Request
JSON Required
The card details as JSON in plain which should be used to authorize the payment.
Responses
  • 200 OK
    String

10.8.23.31Process Transaction

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

POST /api/v2.0/payment/transactions/{id}/process-with-token View in Client
Parameters
  • id
    Long Required
    PATH
    The id of the transaction for which we want to check if the token can be created or not.
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.8.23.32Process Without User Interaction

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

POST /api/v2.0/payment/transactions/{id}/process-without-interaction View in Client
Parameters
  • id
    Long Required
    PATH
    The id of the transaction which should be processed.
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.8.23.33voidOffline

This operation voids the transaction online. The void is 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/v2.0/payment/transactions/{id}/void-offline View in Client
Parameters
  • id
    Long Required
    PATH
    The id of the transaction which should be voided.
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.8.23.34voidOnline

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

POST /api/v2.0/payment/transactions/{id}/void-online View in Client
Parameters
  • id
    Long Required
    PATH
    The id of the transaction which should be voided.
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.8.23.35Process One-Click Token with Credentials

Assigns the given token to the transaction and processes it. It will return a URL where the customer has to be redirected to complete the transaction.

POST /api/v2.0/payment/transactions/by-credentials/{credentials}/one-click-tokens/{id}/process View in Client
Parameters
  • credentials
    String Required
    PATH
    Identifies the transaction and contains the security details which grants the access this operation.
  • id
    Long Required
    PATH
    The token ID is used to load the corresponding token and to process the transaction with it.
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Responses
  • 200 OK
    String

10.8.23.36Update a transaction

PATCH /api/v2.0/payment/transactions/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Request Body
Transaction Pending
JSON Required
Responses

10.8.23.37Delete One-Click Token with Credentials

DELETE /api/v2.0/payment/transactions/by-credentials/{credentials}/one-click-tokens/{id} View in Client
Parameters
  • credentials
    String Required
    PATH
    Identifies the transaction and contains the security details which grants the access this operation.
  • id
    Long Required
    PATH
    The token ID
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Responses
  • 204 No Content
    No response body.

10.8.24Charge

10.8.24.1Charge Attempts

10.8.24.1.1List all charge attempts
GET /api/v2.0/payment/charge-attempts View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses
10.8.24.1.2Retrieve a charge attempt
GET /api/v2.0/payment/charge-attempts/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses
10.8.24.1.3Search charge attempts
GET /api/v2.0/payment/charge-attempts/search View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses

10.8.24.2Charge Flow Levels

10.8.24.2.1List all charge flow levels
GET /api/v2.0/payment/charge-flows/levels View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses
10.8.24.2.2Retrieve a charge flow level
GET /api/v2.0/payment/charge-flows/levels/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses
10.8.24.2.3Search charge flow levels
GET /api/v2.0/payment/charge-flows/levels/search View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses
10.8.24.2.4Send Payment Link

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

POST /api/v2.0/payment/charge-flows/levels/{id}/send-Message View in Client
Parameters
  • id
    Long Required
    PATH
    The id of the charge flow level whose payment link should be sent.
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Responses
  • 200 OK
    No response body.

10.8.24.3Charge Flows

10.8.24.3.1List all charge flows
GET /api/v2.0/payment/charge-flows View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses
10.8.24.3.2Retrieve a charge flow
GET /api/v2.0/payment/charge-flows/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses
10.8.24.3.3Search charge flows
GET /api/v2.0/payment/charge-flows/search View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses

10.8.24.4Charge Flows Level Payment Links

10.8.24.4.1List all charge flow payment links
GET /api/v2.0/payment/charge-flows/levels/payment-links View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses
10.8.24.4.2Retrieve a charge flow payment link
GET /api/v2.0/payment/charge-flows/levels/payment-links/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses
10.8.24.4.3Search charge flow payment links
GET /api/v2.0/payment/charge-flows/levels/payment-links/search View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses

10.8.24.5Payment Sales Channels

10.8.24.5.1List all payment sales channels.
GET /api/v2.0/payment/sales-channels View in Client
Parameters
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses
10.8.24.5.2Retrieve a payment sales channel.
GET /api/v2.0/payment/sales-channels/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses
10.8.24.5.3Search payment sales channels.
GET /api/v2.0/payment/sales-channels/search View in Client
Parameters
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses

10.8.25Condition

10.8.25.1Condition Types

10.8.25.1.1List all condition types.
GET /api/v2.0/payment/condition-types View in Client
Parameters
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses
10.8.25.1.2Retrieve a condition type.
GET /api/v2.0/payment/condition-types/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses
10.8.25.1.3Search condition types.
GET /api/v2.0/payment/condition-types/search View in Client
Parameters
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses

10.8.26Token

10.8.26.1Token Versions

10.8.26.1.1List all token versions
GET /api/v2.0/payment/token-versions View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses
10.8.26.1.2Retrieve a token version
GET /api/v2.0/payment/token-versions/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses
10.8.26.1.3Search token token versions
GET /api/v2.0/payment/token-versions/search View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses

10.8.26.2Tokens

10.8.26.2.1List all tokens
GET /api/v2.0/payment/tokens View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses
10.8.26.2.2Retrieve a token
GET /api/v2.0/payment/tokens/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses
10.8.26.2.3Active 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/v2.0/payment/tokens/{id}/active-version View in Client
Parameters
  • id
    Long Required
    PATH
    The id of a token for which you want to look up the current active token version.
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses
10.8.26.2.4Search tokens
GET /api/v2.0/payment/tokens/search View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses
10.8.26.2.5Create a token
POST /api/v2.0/payment/tokens View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Request Body
Payment Token Create
JSON Required
Responses
10.8.26.2.6Create Transaction for Token Update

Creates a transaction which allows the updating of the provided token.

POST /api/v2.0/payment/tokens/{id}/create-transaction-for-token-update View in Client
Parameters
  • id
    Long Required
    PATH
    The id of the token which should be updated.
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses
10.8.26.2.7Update a token
PATCH /api/v2.0/payment/tokens/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Request Body
Payment Token Update
JSON Required
Responses
10.8.26.2.8Delete a token

Permanently deletes a token. It cannot be undone.

DELETE /api/v2.0/payment/tokens/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Responses
  • 204 No Content
    No response body.

10.8.27Transaction

10.8.27.1Delivery Indications

10.8.27.1.1List all delivery indications
GET /api/v2.0/payment/delivery-indications View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses
10.8.27.1.2Retrieve a delivery indication
GET /api/v2.0/payment/delivery-indications/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses
10.8.27.1.3Search delivery indications
GET /api/v2.0/payment/delivery-indications/search View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses
10.8.27.1.4markAsNotSuitable

Marks the delivery indication as not suitable.

POST /api/v2.0/payment/delivery-indications/{id}/mark-not-suitable View in Client
Parameters
  • id
    Long Required
    PATH
    The delivery indication id which should be marked as not suitable.
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses
10.8.27.1.5markAsSuitable

Marks the delivery indication as suitable.

POST /api/v2.0/payment/delivery-indications/{id}/mark-suitable View in Client
Parameters
  • id
    Long Required
    PATH
    The delivery indication id which should be marked as suitable.
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.8.27.2Refunds

10.8.27.2.1List all refunds
GET /api/v2.0/payment/refunds View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses
10.8.27.2.2Retrieve a refund
GET /api/v2.0/payment/refunds/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses
10.8.27.2.3getRefundDocument

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

GET /api/v2.0/payment/refunds/{id}/document View in Client
Parameters
  • id
    Long Required
    PATH
    The id of the refund to get the document for.
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • targetMediaTypeId
    Long
    QUERY
    The id of the target media type for which the refund should be generated for.
Responses
10.8.27.2.4Search refunds
GET /api/v2.0/payment/refunds/search View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses
10.8.27.2.5create
POST /api/v2.0/payment/refunds View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Request Body
Refund Create Create
JSON Required
Responses
10.8.27.2.6fail

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

POST /api/v2.0/payment/refunds/{id}/mark-failed View in Client
Parameters
  • id
    Long Required
    PATH
    The id of the refund which should be marked as failed.
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses
10.8.27.2.7succeed

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

POST /api/v2.0/payment/refunds/{id}/mark-succeeded View in Client
Parameters
  • id
    Long Required
    PATH
    The id of the refund which should be marked as succeeded.
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.8.27.3Transaction Completions

10.8.27.3.1List all transaction completions
GET /api/v2.0/payment/transactions/completions View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses
10.8.27.3.2Retrieve a transaction completion
GET /api/v2.0/payment/transactions/completions/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses
10.8.27.3.3Search transaction completions
GET /api/v2.0/payment/transactions/completions/search View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses

10.8.27.4Transaction Invoices

10.8.27.4.1List all transaction invoices
GET /api/v2.0/payment/transactions/invoices View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses
10.8.27.4.2Retrieve a transaction invoice
GET /api/v2.0/payment/transactions/invoices/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses
10.8.27.4.3isReplacementPossible

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

GET /api/v2.0/payment/transactions/invoices/{id}/check-replacement-possible View in Client
Parameters
  • id
    Long Required
    PATH
    The invoice which should be checked if a replacement is possible.
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Responses
  • 200 OK
    Boolean
10.8.27.4.4getInvoiceDocument

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

GET /api/v2.0/payment/transactions/invoices/{id}/document View in Client
Parameters
  • id
    Long Required
    PATH
    The id of the invoice to get the document for.
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • targetMediaTypeId
    Long
    QUERY
    The id of the target media type for which the document should be generated for.
Responses
10.8.27.4.5Search transaction invoices
GET /api/v2.0/payment/transactions/invoices/search View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses
10.8.27.4.6Mark as Derecognized

Marks the transaction invoice with the given id as derecognized.

POST /api/v2.0/payment/transactions/invoices/{id}/mark-derecognized View in Client
Parameters
  • id
    Long Required
    PATH
    The id of the transaction invoice which should be marked as derecognized.
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses
10.8.27.4.7Mark as Paid

Marks the transaction invoice with the given id as paid.

POST /api/v2.0/payment/transactions/invoices/{id}/mark-paid View in Client
Parameters
  • id
    Long Required
    PATH
    The id of the transaction invoice which should be marked as paid.
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses
10.8.27.4.8replace

Replaces the transaction invoice with given id with the replacement.

POST /api/v2.0/payment/transactions/invoices/{id}/replace View in Client
Parameters
  • id
    Long Required
    PATH
    The id of the transaction invoices which should be replaced.
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Request Body
Transaction Invoice Replacement
JSON Required
Responses

10.8.27.5Transaction Voids

10.8.27.5.1List all transaction voids
GET /api/v2.0/payment/transactions/voids View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses
10.8.27.5.2Retrieve a transaction void
GET /api/v2.0/payment/transactions/voids/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses
10.8.27.5.3Search transaction voids
GET /api/v2.0/payment/transactions/voids/search View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses

10.9User

10.9.1Application User Roles

10.9.1.1List all roles of an application user for an account

GET /api/v2.0/application-users/{userId}/account-roles View in Client
Parameters
  • userId
    Long Required
    PATH
  • account
    Long Required
    HEADER
    Specifies the ID of the account the operation should be executed in.
Responses

10.9.1.2List all roles of an application user for a space

GET /api/v2.0/application-users/{userId}/space-roles View in Client
Parameters
  • userId
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Responses

10.9.1.3Assign a role to an application user for an account

POST /api/v2.0/application-users/{userId}/account-roles View in Client
Parameters
  • userId
    Long Required
    PATH
  • account
    Long Required
    HEADER
    Specifies the ID of the account the operation should be executed in.
  • roleId
    Long Required
    QUERY
  • appliesOnSubAccount
    Boolean
    QUERY
    Whether the role should be assigned to the user in subaccounts only.
Responses

10.9.1.4Assign a role to an application user for a space

POST /api/v2.0/application-users/{userId}/space-roles View in Client
Parameters
  • userId
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • roleId
    Long Required
    QUERY
Responses

10.9.1.5Unassign a role from an application user for an account

DELETE /api/v2.0/application-users/{userId}/account-roles View in Client
Parameters
  • userId
    Long Required
    PATH
  • account
    Long Required
    HEADER
    Specifies the ID of the account the operation should be executed in.
  • roleId
    Long Required
    QUERY
Responses
  • 204 No Content
    No response body.

10.9.1.6Unassign a role from an application user for a space

DELETE /api/v2.0/application-users/{userId}/space-roles View in Client
Parameters
  • userId
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • roleId
    Long Required
    QUERY
Responses
  • 204 No Content
    No response body.

10.9.2Application Users

10.9.2.1List all application users

GET /api/v2.0/application-users View in Client
Parameters
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses

10.9.2.2Retrieve an application user

GET /api/v2.0/application-users/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.9.2.3List a user's authentication keys

GET /api/v2.0/application-users/{userId}/keys View in Client
Parameters
  • userId
    Long Required
    PATH
Responses

10.9.2.4Search application users

GET /api/v2.0/application-users/search View in Client
Parameters
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses

10.9.2.5Create an application user

POST /api/v2.0/application-users View in Client
Parameters
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Request Body
Application User Create
JSON Required
Responses

10.9.2.6Generate a new authentication key

POST /api/v2.0/application-users/{userId}/keys View in Client
Parameters
  • userId
    Long Required
    PATH
Responses

10.9.2.7Update an application user

PATCH /api/v2.0/application-users/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Request Body
Application User Update
JSON Required
Responses

10.9.2.8Delete an application user

Permanently deletes a application user. It cannot be undone.

DELETE /api/v2.0/application-users/{id} View in Client
Parameters
  • id
    Long Required
    PATH
Responses
  • 204 No Content
    No response body.

10.9.2.9Deactivate an authentication key

DELETE /api/v2.0/application-users/{userId}/keys/{id} View in Client
Parameters
  • userId
    Long Required
    PATH
  • id
    Long Required
    PATH
Responses
  • 204 No Content
    No response body.

10.9.3Human User Roles

10.9.3.1List all roles of a human user for an account

GET /api/v2.0/human-users/{userId}/account-roles View in Client
Parameters
  • userId
    Long Required
    PATH
  • account
    Long Required
    HEADER
    Specifies the ID of the account the operation should be executed in.
Responses

10.9.3.2List all roles of a human user for a space

GET /api/v2.0/human-users/{userId}/space-roles View in Client
Parameters
  • userId
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Responses

10.9.3.3Assign a role to a human user for an account

POST /api/v2.0/human-users/{userId}/account-roles View in Client
Parameters
  • userId
    Long Required
    PATH
  • account
    Long Required
    HEADER
    Specifies the ID of the account the operation should be executed in.
  • roleId
    Long Required
    QUERY
  • appliesOnSubAccount
    Boolean
    QUERY
    Whether the role should be assigned to the user in subaccounts only.
Responses

10.9.3.4Assign a role to a human user for a space

POST /api/v2.0/human-users/{userId}/space-roles View in Client
Parameters
  • userId
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • roleId
    Long Required
    QUERY
Responses

10.9.3.5Unassign a role from a human user for an account

DELETE /api/v2.0/human-users/{userId}/account-roles View in Client
Parameters
  • userId
    Long Required
    PATH
  • account
    Long Required
    HEADER
    Specifies the ID of the account the operation should be executed in.
  • roleId
    Long Required
    QUERY
Responses
  • 204 No Content
    No response body.

10.9.3.6Unassign a role from a human user for a space

DELETE /api/v2.0/human-users/{userId}/space-roles View in Client
Parameters
  • userId
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • roleId
    Long Required
    QUERY
Responses
  • 204 No Content
    No response body.

10.9.4Human Users

10.9.4.1List all human users

GET /api/v2.0/human-users View in Client
Parameters
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses

10.9.4.2Retrieve a human user

GET /api/v2.0/human-users/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.9.4.3Export human users

Export human users into a CSV file.

GET /api/v2.0/human-users/export View in Client
Long Polling Timeout

60 seconds

Parameters
  • fields
    Collection of String
    QUERY
    The fields to be included in the export.
  • limit
    Integer
    QUERY
    1 - 9,223,372,036,854,775,807
    A limit on the number of objects to be returned. Default is 2,000.
  • offset
    Integer
    QUERY
    ≤ 100,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses
  • 200 OK
    text/csv

10.9.4.4Search human users

GET /api/v2.0/human-users/search View in Client
Parameters
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses

10.9.4.5Create a human user

POST /api/v2.0/human-users View in Client
Parameters
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Request Body
Human User Create
JSON Required
Responses

10.9.4.6Update a human user

PATCH /api/v2.0/human-users/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Request Body
Human User Update
JSON Required
Responses

10.9.4.7Delete a human user

Permanently deletes a human user. It cannot be undone.

DELETE /api/v2.0/human-users/{id} View in Client
Parameters
  • id
    Long Required
    PATH
Responses
  • 204 No Content
    No response body.

10.9.5Permissions

10.9.5.1List all permissions

GET /api/v2.0/permissions View in Client
Parameters
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses

10.9.5.2Retrieve a permission

GET /api/v2.0/permissions/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.9.5.3Search permissions

GET /api/v2.0/permissions/search View in Client
Parameters
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses

10.9.6Roles

10.9.6.1List all roles

GET /api/v2.0/roles View in Client
Parameters
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses

10.9.6.2Retrieve a role

GET /api/v2.0/roles/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.9.6.3Search roles

GET /api/v2.0/roles/search View in Client
Parameters
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses

10.9.6.4Create a role

POST /api/v2.0/roles View in Client
Parameters
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Request Body
Role Create
JSON Required
Responses

10.9.6.5Update a role

PATCH /api/v2.0/roles/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Request Body
Role Update
JSON Required
Responses

10.9.6.6Delete a role

Permanently deletes a role. It cannot be undone.

DELETE /api/v2.0/roles/{id} View in Client
Parameters
  • id
    Long Required
    PATH
Responses
  • 204 No Content
    No response body.

10.9.7Single Sign-On User Roles

10.9.7.1List all roles of a single sign-on user for an account

GET /api/v2.0/single-sign-on-users/{userId}/account-roles View in Client
Parameters
  • userId
    Long Required
    PATH
  • account
    Long Required
    HEADER
    Specifies the ID of the account the operation should be executed in.
Responses

10.9.7.2List all roles of a single sign-on user for a space

GET /api/v2.0/single-sign-on-users/{userId}/space-roles View in Client
Parameters
  • userId
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Responses

10.9.7.3Assign a role to a single sign-on user for an account

POST /api/v2.0/single-sign-on-users/{userId}/account-roles View in Client
Parameters
  • userId
    Long Required
    PATH
  • account
    Long Required
    HEADER
    Specifies the ID of the account the operation should be executed in.
  • roleId
    Long Required
    QUERY
  • appliesOnSubAccount
    Boolean
    QUERY
    Whether the role should be assigned to the user in subaccounts only.
Responses

10.9.7.4Assign a role to a single sign-on user for a space

POST /api/v2.0/single-sign-on-users/{userId}/space-roles View in Client
Parameters
  • userId
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • roleId
    Long Required
    QUERY
Responses

10.9.7.5Unassign a role from a single sign-on user for an account

DELETE /api/v2.0/single-sign-on-users/{userId}/account-roles View in Client
Parameters
  • userId
    Long Required
    PATH
  • account
    Long Required
    HEADER
    Specifies the ID of the account the operation should be executed in.
  • roleId
    Long Required
    QUERY
Responses
  • 204 No Content
    No response body.

10.9.7.6Unassign a role from a single sign-on user for a space

DELETE /api/v2.0/single-sign-on-users/{userId}/space-roles View in Client
Parameters
  • userId
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • roleId
    Long Required
    QUERY
Responses
  • 204 No Content
    No response body.

10.9.8Single Sign-On Users

10.9.8.1List all single sign-on users

GET /api/v2.0/single-sign-on-users View in Client
Parameters
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses

10.9.8.2Retrieve a single sign-on user

GET /api/v2.0/single-sign-on-users/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.9.8.3Search single sign-on users

GET /api/v2.0/single-sign-on-users/search View in Client
Parameters
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses

10.9.8.4Create a single sign-on user

POST /api/v2.0/single-sign-on-users View in Client
Parameters
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Request Body
Single Sign-On User Create
JSON Required
Responses

10.9.8.5Update a single sign-on user

PATCH /api/v2.0/single-sign-on-users/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Request Body
Single Sign-On User Update
JSON Required
Responses

10.9.8.6Delete a single sign-on user

Permanently deletes a single sign-on user. It cannot be undone.

DELETE /api/v2.0/single-sign-on-users/{id} View in Client
Parameters
  • id
    Long Required
    PATH
Responses
  • 204 No Content
    No response body.

10.10User Interface

10.10.1Saved Views

10.10.1.1Retrieve a saved view

GET /api/v2.0/ui/saved-views/{id} View in Client
Parameters
  • id
    Long Required
    PATH
Responses

10.10.1.2Create a saved view

POST /api/v2.0/ui/saved-views View in Client
Parameters
No parameters.
Request Body
Saved View Create
JSON Required
Responses

10.10.1.3Create a saved view for specified page

POST /api/v2.0/ui/saved-views/for-page/{navigationEntryId} View in Client
Parameters
  • navigationEntryId
    Long Required
    PATH
Request Body
Saved View Create
JSON Required
Responses

10.10.1.4Update a saved view

PATCH /api/v2.0/ui/saved-views/{id} View in Client
Parameters
  • id
    Long Required
    PATH
Request Body
Saved View Create
JSON Required
Responses

10.10.1.5Update a saved view

PATCH /api/v2.0/ui/saved-views/save-as/{id} View in Client
Parameters
  • id
    Long Required
    PATH
Request Body
Map of String String
JSON Required
Responses

10.10.1.6Delete a saved view

Permanently deletes a saved view. It cannot be undone.

DELETE /api/v2.0/ui/saved-views/{id} View in Client
Parameters
  • id
    Long Required
    PATH
Responses
  • 204 No Content
    No response body.

10.11Web App

10.11.1Web Apps

10.11.1.1Check whether the web app is installed

Return true if the web app is installed in the provided space.

GET /api/v2.0/web-apps/installed View in Client
Responses
  • 200 OK
    Boolean

10.11.1.2Confirm a web app installation

Confirm the installation of a web app. This has to be done when the user returns to the web app after granting permissions, using the activation code provided in the request.

POST /api/v2.0/web-apps/confirm/{code} View in Client
Parameters
  • code
    String Required
    PATH
    The activation code passed to the web app after permissions were granted.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.11.1.3Uninstall a web app

Uninstall the web app from the provided space.

POST /api/v2.0/web-apps/uninstall View in Client
Responses
  • 204 No Content
    No response body.

10.12Webhook

10.12.1Webhook Encryption Keys

10.12.1.1Retrieve a webhook encryption key

GET /api/v2.0/webhooks/encryption-keys/{id} View in Client
Parameters
  • id
    String Required
    PATH
Responses
  • 200 OK
    String

10.12.2Webhook Listeners

10.12.2.1List all webhook listeners

GET /api/v2.0/webhooks/listeners View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses

10.12.2.2Retrieve a webhook listener

GET /api/v2.0/webhooks/listeners/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.12.2.3Search webhook listeners

GET /api/v2.0/webhooks/listeners/search View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses

10.12.2.4Create a webhook listener

POST /api/v2.0/webhooks/listeners View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Request Body
Webhook Listener Create
JSON Required
Responses

10.12.2.5Create multiple webhook listeners

POST /api/v2.0/webhooks/listeners/bulk View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Request Body
Collection of Webhook Listener Create
JSON Required
Responses

10.12.2.6Update a webhook listener

PATCH /api/v2.0/webhooks/listeners/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Request Body
Webhook Listener Update
JSON Required
Responses

10.12.2.7Update multiple webhook listeners

PATCH /api/v2.0/webhooks/listeners/bulk View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Request Body
Collection of Webhook Listener Update
JSON Required
Responses

10.12.2.8Delete a webhook listener

DELETE /api/v2.0/webhooks/listeners/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Responses
  • 204 No Content
    No response body.

10.12.2.9Delete multiple webhook listeners

DELETE /api/v2.0/webhooks/listeners/bulk View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Request Body
Collection of Long
JSON Required
Responses

10.12.3Webhook URLs

10.12.3.1List all webhook URLs

GET /api/v2.0/webhooks/urls View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • after
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately after the named object.
  • before
    Long
    QUERY
    ≥ 1
    Set to an object's ID to retrieve the page of objects coming immediately before the named object.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • order
    Enum
    QUERY
    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.
    • ASC
      Ascending order (A-Z)
    • DESC
      Descending order (Z-A)
Responses

10.12.3.2Retrieve a webhook URL

GET /api/v2.0/webhooks/urls/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.12.3.3Search webhook URLs

GET /api/v2.0/webhooks/urls/search View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
  • limit
    Integer
    QUERY
    1 - 100
    A limit on the number of objects to be returned, between 1 and 100. Default is 10.
  • offset
    Integer
    QUERY
    ≥ 1
    ≤ 10,000
    A cursor for pagination, specifies the number of objects to skip.
  • order
    String
    QUERY
    The fields and order to sort the objects by.
  • query
    String
    QUERY
    The search query to filter the objects by.
Responses

10.12.3.4Create a webhook URL

POST /api/v2.0/webhooks/urls View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Request Body
Webhook URL Create
JSON Required
Responses

10.12.3.5Create multiple webhook URLs

POST /api/v2.0/webhooks/urls/bulk View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Request Body
Collection of Webhook URL Create
JSON Required
Responses

10.12.3.6Update a webhook URL

PATCH /api/v2.0/webhooks/urls/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Request Body
Webhook URL Update
JSON Required
Responses

10.12.3.7Update multiple webhook URLs

PATCH /api/v2.0/webhooks/urls/bulk View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Request Body
Collection of Webhook URL Update
JSON Required
Responses

10.12.3.8Delete a webhook URL

DELETE /api/v2.0/webhooks/urls/{id} View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Responses
  • 204 No Content
    No response body.

10.12.3.9Delete multiple webhook URLs

DELETE /api/v2.0/webhooks/urls/bulk View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Request Body
Collection of Long
JSON Required
Responses

11Models

This section details all models that are accepted or returned by API operations.

11.1Analytics

11.1.1Analytics query execution request Details

Request to be sent to Analytics database.

Properties
  • accountId
    Long Required
    Target account ID for which query will be executed.
  • sql
    String
    3 - 100,000 chars
    SQL to execute (PrestoDB dialect).

11.1.2Analytics query execution response Details

Response for Analytics query execution.

Properties
  • queryToken
    String Read-only
    Query token for submitted query execution request.

11.1.3Submitted Analytics query execution Details

Submitted Analytics query execution

Properties
  • accountId
    Long Read-only
    Account ID
  • createdTimestamp
    DateTime Read-only
    Time when query execution request was registered
  • downloadRequests
    Long Read-only
    Amount of query result file download attempts
  • id
    Long Read-only
    ID
  • originalQuery
    String Read-only
    User submitted query SQL
  • portalQueryToken
    String Read-only
    Portal query execution token
  • resultFileBytes
    Integer Read-only
    Result file bytes
  • scannedBytes
    Integer Read-only
    Billed bytes
  • status
    Enum Read-only
    User submitted query status
    • PROCESSING
      Processing
    • CANCELLED
      Cancelled
    • FAILED
      Failed
    • SUCCESS
      Success
  • totalBilledExecutionTimeMs
    Integer Read-only
    Billed execution time, ms

11.2Core

11.2.1API

11.2.1.1Bulk Operation Result Details

Represents the result of a single operation in a bulk request.

Properties
  • error
    Error Response Read-only
    The occurred error in case processing of the operation failed.
  • id
    Long Read-only
    The ID of the processed object.
  • link
    String Read-only
    The API path to call to get the processed object.
  • statusCode
    Integer Read-only
    The resulting HTTP status code of the single operation.

11.2.1.2Error Response Details

Properties
  • code
    String Read-only
    A brief explanation of the error that can be used to programmatically handle it.
  • date
    DateTime Read-only
    The date and time when the error occurred.
  • id
    String Read-only
    The unique identifier of the error.
  • localisedMessage
    String Read-only
    A human-readable message in the user's language providing more details about the error.
  • message
    String Read-only
    A human-readable message in English providing more details about the error.

11.2.1.3List Response Details

Properties
  • data
    Collection of Objects Read-only
    An array containing the actual response objects.
  • hasMore
    Boolean Read-only
    Whether there are more objects available after this set. If false, there are no more objects to retrieve.
  • limit
    Integer Read-only
    The applied limit on the number of objects returned.

11.2.1.4Search Response Details

Properties
  • data
    Collection of Objects Read-only
    An array containing the actual response objects.
  • hasMore
    Boolean Read-only
    Whether there are more objects available after this set. If false, there are no more objects to retrieve.
  • limit
    Integer Read-only
    The applied limit on the number of objects returned.
  • offset
    Integer Read-only
    The number of skipped objects.

11.2.2Account

11.2.2.1Account Details

Properties
  • active
    Boolean Read-only
    Whether this account and all its parent accounts are active.
  • activeOrRestrictedActive
    Boolean Read-only
    Whether this account and all its parent accounts are active or restricted active.
  • createdBy
    Long
    User
    Read-only
    The ID of the user the account was created by.
  • createdOn
    DateTime Read-only
    The date and time when the account was created.
  • deletedBy
    Long
    User
    Read-only
    The ID of a user the account was deleted by.
  • deletedOn
    DateTime Read-only
    The date and time when the account was deleted.
  • id
    Long Read-only
    A unique identifier for the object.
  • lastModifiedDate
    DateTime Read-only
    The date and time when the object was last modified.
  • name
    String Read-only
    The name used to identify the account.
  • parentAccount
    Account Expandable Read-only
    The parent account responsible for administering this account.
  • plannedPurgeDate
    DateTime Read-only
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • restrictedActive
    Boolean Read-only
    Whether this account and all its parent accounts are active or restricted active. There is at least one account that is restricted active.
  • scope
    Scope Expandable Read-only
    The scope that the account belongs to.
  • state
    Enum Read-only
    The object's current state.
    • CREATE
      Create
    • RESTRICTED_ACTIVE
      Restricted Active
    • ACTIVE
      Active
    • INACTIVE
      Inactive
    • DELETING
      Deleting
    • DELETED
      Deleted
  • subaccountLimit
    Long Read-only
    The number of sub-accounts that can be created within this account.
  • type
    Enum Read-only
    The account's type which defines its role and capabilities.
    • MASTER
      Master
    • REGULAR
      Regular
    • SUBACCOUNT
      Subaccount
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.2.3Base

11.2.3.1Database Details

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

11.2.3.2Failure Reason Details

Properties
  • category
    Enum Read-only
    The category that the failure reason belongs to.
    • TEMPORARY_ISSUE
      Temporary Issue
    • INTERNAL
      Internal
    • END_USER
      End User
    • CONFIGURATION
      Configuration
    • DEVELOPER
      Developer
  • description
    Map of String String Expandable Read-only
    The localized description of the object.
  • id
    Long Read-only
    A unique identifier for the object.
  • name
    Map of String String Expandable Read-only
    The localized name of the object.

11.2.3.3Feature Details

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

11.2.3.4Feature Category Details

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

11.2.3.5Line Item Reduction Details

Properties
  • lineItemUniqueId
    String Read-only
    The unique id identifies the line item on which the reduction is applied on.
  • quantityReduction
    Decimal Read-only
  • unitPriceReduction
    Decimal Read-only

11.2.3.6Scope Details

Properties
  • domainName
    String Read-only
    The domain name that belongs to the scope.
  • features
    Collection of Feature Expandable Read-only
    The list of features that are active in the scope.
  • id
    Long Read-only
    A unique identifier for the object.
  • machineName
    String Read-only
    The name identifying the scope in e.g. URLs.
  • name
    String Read-only
    The name used to identify the scope.
  • plannedPurgeDate
    DateTime Read-only
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • port
    Integer Read-only
    The port where the scope can be accessed.
  • sslActive
    Boolean Read-only
    Whether the scope supports SSL.
  • state
    Enum Read-only
    The object's current state.
    • CREATE
      Create
    • ACTIVE
      Active
    • INACTIVE
      Inactive
    • DELETING
      Deleting
    • DELETED
      Deleted
  • themes
    Collection of String Read-only
    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.
  • url
    String Read-only
    The URL where the scope can be accessed.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.2.4Space

11.2.4.1Space Details

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

11.2.4.2Space Address Details

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

11.2.4.3Space View Details

Properties
  • id
    Long Read-only
    A unique identifier for the object.
  • linkedSpaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • name
    String Read-only
    The name used to identify the space view.
  • plannedPurgeDate
    DateTime Read-only
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • space
    Space Read-only
    The space that the space view belongs to.
  • state
    Enum Read-only
    The object's current state.
    • CREATE
      Create
    • ACTIVE
      Active
    • INACTIVE
      Inactive
    • DELETING
      Deleting
    • DELETED
      Deleted
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.3Customer

11.3.1Customer Details

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

11.3.2Customer Address Details

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

11.3.3Customer Comment Details

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

11.3.4Customer Email Address Details

Properties
  • createdOn
    DateTime Read-only
    The date and time when the object was created.
  • emailAddress
    String Read-only
    An email address associated with a customer.

11.3.5Customer Postal Address Details

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

11.4Document

11.4.1Document Template Details

A document template contains the customizations for a particular document template type.

Properties
  • defaultTemplate
    Boolean Read-only
    Whether this is the default document template which is used whenever no specific template is specified for the same template type.
  • deliveryEnabled
    Boolean Read-only
    Whether documents of this template should be delivered.
  • id
    Long Read-only
    A unique identifier for the object.
  • linkedSpaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • name
    String Read-only
    The name used to identify the document template.
  • plannedPurgeDate
    DateTime Read-only
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • spaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • state
    Enum Read-only
    The object's current state.
    • CREATE
      Create
    • ACTIVE
      Active
    • INACTIVE
      Inactive
    • DELETING
      Deleting
    • DELETED
      Deleted
  • templateResource
    String Read-only
    The resource path to a custom template to be used to generate PDF documents.
  • type
    Document Template Type Expandable Read-only
    The document template's type.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.4.2Document Template Type Details

Properties
  • description
    Map of String String Expandable Read-only
    The localized description of the document template type.
  • feature
    Feature Expandable Read-only
    The feature that this document template type belongs to.
  • group
    Document Template Type Group Read-only
    The group that this document template type belongs to.
  • id
    Long Read-only
    A unique identifier for the object.
  • title
    Map of String String Expandable Read-only
    The localized title of the document template type.

11.4.3Document Template Type Group Details

Properties
  • id
    Long Read-only
    A unique identifier for the object.
  • title
    Map of String String Expandable Read-only
    The localized title of the group.

11.4.4Rendered Document Details

Properties
  • data
    Collection of Byte Read-only
    The binary data of the document
  • documentTemplateType
    Long
    Document Template Type
    Read-only
    The document's template type
  • mimeType
    String Read-only
    The document's content type
  • title
    String Read-only
    The title of the rendered document

11.5Internationalization

11.5.1Address Details

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

11.5.2Address Format Details

Properties
  • postCodeExamples
    Collection of String Read-only
    A list of sample post codes.
  • postCodeRegex
    String Read-only
    The regular expression to validate post codes.
  • requiredFields
    Collection of Enum Read-only
    The fields that are required in the address format.
    • 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
  • usedFields
    Collection of Enum Read-only
    The fields that are used in the address format.
    • 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

11.5.3Country Details

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

11.5.4Currency Details

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

11.5.5Language Details

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

11.5.6Legal Organization Form Details

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

11.5.7Localized String Details

Properties
  • language
    String Read-only
    The term's language.
  • string
    String Read-only
    The localized term.

11.5.8State Details

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

11.6Label

11.6.1Label Details

Properties
  • content
    Object Read-only
    The label's actual content.
  • contentAsString
    String Read-only
    The label's content formatted as string.
  • descriptor
    Label Descriptor Expandable Read-only
    The descriptor that describes what information the label provides.

11.6.2Label Descriptor Details

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

11.6.3Label Descriptor Group Details

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

11.6.4Label Descriptor Type Details

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

11.6.5Static Value Details

Properties
  • description
    Map of String String Expandable Read-only
    The localized description of the object.
  • features
    Collection of Long
    Feature
    Read-only
    The features that this static value belongs to.
  • id
    Long Read-only
    A unique identifier for the object.
  • name
    Map of String String Expandable Read-only
    The localized name of the object.

11.7Line Item

11.7.1Line Item Details

Properties
  • aggregatedTaxRate
    Decimal Read-only
    The total tax rate applied to the item, calculated from the rates of all tax lines.
  • amountExcludingTax
    Decimal Read-only
    The line item price with discounts applied, excluding taxes.
  • amountIncludingTax
    Decimal Read-only
    The line item price with discounts applied, including taxes.
  • attributes
    Map of String Line Item Attribute Read-only
    A map of custom information for the item.
  • discountExcludingTax
    Decimal Read-only
    The discount allocated to the item, excluding taxes.
  • discountIncludingTax
    Decimal Read-only
    The discount allocated to the item, including taxes.
  • name
    String Read-only
    The name of the product, ideally in the customer's language.
  • quantity
    Decimal Read-only
    The number of items that were purchased.
  • shippingRequired
    Boolean Read-only
    Whether the item required shipping.
  • sku
    String Read-only
    The SKU (stock-keeping unit) of the product.
  • taxAmount
    Decimal Read-only
    The sum of all taxes applied to the item.
  • taxAmountPerUnit
    Decimal Read-only
    The calculated tax amount per unit.
  • taxes
    Collection of Tax Read-only
    A set of tax lines, each of which specifies a tax applied to the item.
  • type
    Enum Read-only
    The type of the line item.
    • SHIPPING
      Shipping
    • DISCOUNT
      Discount
    • FEE
      Fee
    • PRODUCT
      Product
    • TIP
      Tip
  • undiscountedAmountExcludingTax
    Decimal Read-only
    The line item price with discounts not applied, excluding taxes.
  • undiscountedAmountIncludingTax
    Decimal Read-only
    The line item price with discounts not applied, including taxes.
  • undiscountedUnitPriceExcludingTax
    Decimal Read-only
    The calculated price per unit with discounts not applied, excluding taxes.
  • undiscountedUnitPriceIncludingTax
    Decimal Read-only
    The calculated price per unit with discounts not applied, including taxes.
  • uniqueId
    String Read-only
    The unique identifier of the line item within the set of line items.
  • unitPriceExcludingTax
    Decimal Read-only
    The calculated price per unit with discounts applied, excluding taxes.
  • unitPriceIncludingTax
    Decimal Read-only
    The calculated price per unit with discounts applied, including taxes.

11.7.2Line Item Attribute Details

Properties
  • label
    String Read-only
    The label describing the line item attribute.
  • value
    String Read-only
    The value of the line item attribute.

11.8Manual Task

11.8.1Manual Task Details

A manual task requires the manual intervention of a human.

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

11.8.2Manual Task Action Details

Properties
  • id
    Long Read-only
    A unique identifier for the object.
  • label
    Map of String String Expandable Read-only
    The action's label.
  • style
    Enum Read-only
    The action's style.
    • DEFAULT
      Default
    • PRIMARY
      Primary
    • DANGER
      Danger
  • taskType
    Long
    Manual Task Type
    Read-only
    The type of manual tasks this action belongs to.

11.8.3Manual Task Type Details

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

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

11.9Payment

11.9.1Authenticated Card Data Details

This model holds the card data and optional cardholder authentication details.

Properties
  • cardHolderName
    String
    ≤ 100 chars
    The card holder name is the name printed onto the card. It identifies the person who owns the card.
  • cardVerificationCode
    String
    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.
  • cardholderAuthentication
    Cardholder Authentication
    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).
  • cryptogram
    Card Cryptogram
    The additional authentication value used to secure the tokenized card transactions.
  • expiryDate
    String
    ([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).
  • panType
    Enum
    • 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
  • primaryAccountNumber
    String Required
    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.
  • recurringIndicator
    Enum
    • 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
  • schemeTransactionReference
    String
    ≤ 100 chars
  • tokenRequestorId
    String

11.9.2Authenticated Card Data Details

This model holds the card data and optional cardholder authentication details.

Properties
  • cardHolderName
    String Read-only
    The card holder name is the name printed onto the card. It identifies the person who owns the card.
  • cardVerificationCode
    String Read-only
    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.
  • cardholderAuthentication
    Cardholder Authentication Read-only
    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).
  • cryptogram
    Card Cryptogram Read-only
    The additional authentication value used to secure the tokenized card transactions.
  • expiryDate
    String Read-only
    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).
  • initialRecurringTransaction
    Boolean Read-only
  • panType
    Enum Read-only
    • 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
  • primaryAccountNumber
    String Read-only
    The primary account number (PAN) identifies the card. The number is numeric and typically printed on the front of the card.
  • recurringIndicator
    Enum Read-only
    • 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
  • schemeTransactionReference
    String Read-only
  • tokenRequestorId
    String Read-only

11.9.3Authenticated Card Request Details

Request to process a card transaction without using 3D-Secure.

Properties

11.9.4Bank Account Details

Properties
  • description
    String Read-only
    The optional description is shown along the identifier. The intention of the description is to give an alternative name to the bank account.
  • id
    Long Read-only
    A unique identifier for the object.
  • identifier
    String Read-only
    The bank account identifier is responsible to uniquely identify the bank account.
  • linkedSpaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • plannedPurgeDate
    DateTime Read-only
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • state
    Enum Read-only
    The object's current state.
    • CREATE
      Create
    • ACTIVE
      Active
    • DELETING
      Deleting
    • DELETED
      Deleted
  • type
    Long
    Bank Account Type
    Read-only
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.9.5Bank Account Type Details

Properties
  • description
    Map of String String Expandable Read-only
    The localized description of the object.
  • id
    Long Read-only
    A unique identifier for the object.
  • identifierName
    Map of String String Expandable Read-only
  • name
    Map of String String Expandable Read-only
    The localized name of the object.

11.9.6Bank Transaction Details

Properties
  • adjustments
    Collection of Payment Adjustment Expandable Read-only
    The adjustments applied on this bank transaction.
  • createdBy
    Long
    User
    Read-only
    The created by indicates the user which has created the bank transaction.
  • createdOn
    DateTime Read-only
    The date and time when the object was created.
  • currencyBankAccount
    Currency Bank Account Expandable Read-only
    The currency bank account which is used to handle money flow.
  • externalId
    String Read-only
  • flowDirection
    Enum Read-only
    • INFLOW
      Inflow
    • OUTFLOW
      Outflow
  • id
    Long Read-only
    A unique identifier for the object.
  • linkedSpaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • paymentDate
    DateTime Read-only
    The payment date describes the date when the transaction was made.
  • plannedPurgeDate
    DateTime Read-only
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • postingAmount
    Decimal Read-only
    The posting amount indicates the amount including adjustments.
  • reference
    String Read-only
  • source
    Long
    Bank Transaction Source
    Read-only
  • state
    Enum Read-only
    The object's current state.
    • UPCOMING
      Upcoming
    • SETTLED
      Settled
  • totalAdjustmentAmountIncludingTax
    Decimal Read-only
  • type
    Long
    Bank Transaction Type
    Read-only
  • valueAmount
    Decimal Read-only
  • valueDate
    DateTime Read-only
    The value date describes the date the amount is effective on the account.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.9.7Bank Transaction Source Details

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

11.9.8Bank Transaction Type Details

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

11.9.9Card Cryptogram Details

This model holds the additional card authentication.

Properties
  • eci
    String
  • value
    String Required

11.9.10Card Cryptogram Details

This model holds the additional card authentication.

Properties
  • eci
    String Read-only
  • value
    String Read-only

11.9.11Cardholder Authentication Details

This model holds the cardholder authentication data (e.g. 3-D Secure authentication).

Properties
  • authenticationIdentifier
    String
    The authentication identifier as assigned by authentication system (e.g. XID or DSTransactionID).
  • authenticationResponse
    Enum Required
    • FULLY_AUTHENTICATED
      Fully Authenticated
    • AUTHENTICATION_NOT_REQUIRED
      Authentication Not Required
    • NOT_ENROLLED
      Not Enrolled
    • ENROLLMENT_ERROR
      Enrollment Error
    • AUTHENTICATION_ERROR
      Authentication Error
  • authenticationValue
    String
    The cardholder authentication value. Also known as Cardholder Authentication Verification Value (CAVV).
  • electronicCommerceIndicator
    String
    The Electronic Commerce Indicator (ECI) value. The ECI is returned by authentication system and indicates the outcome/status of authentication.

11.9.12Cardholder Authentication Details

This model holds the cardholder authentication data (e.g. 3-D Secure authentication).

Properties
  • authenticationIdentifier
    String Read-only
    The authentication identifier as assigned by authentication system (e.g. XID or DSTransactionID).
  • authenticationResponse
    Enum Read-only
    • FULLY_AUTHENTICATED
      Fully Authenticated
    • AUTHENTICATION_NOT_REQUIRED
      Authentication Not Required
    • NOT_ENROLLED
      Not Enrolled
    • ENROLLMENT_ERROR
      Enrollment Error
    • AUTHENTICATION_ERROR
      Authentication Error
  • authenticationValue
    String Read-only
    The cardholder authentication value. Also known as Cardholder Authentication Verification Value (CAVV).
  • electronicCommerceIndicator
    String Read-only
    The Electronic Commerce Indicator (ECI) value. The ECI is returned by authentication system and indicates the outcome/status of authentication.
  • version
    Enum Read-only
    • V1
      V1
    • V2
      V2

11.9.13Charge Details

Properties
  • createdOn
    DateTime Read-only
    The date on which the charge was created on.
  • failureReason
    Failure Reason Read-only
  • id
    Long Read-only
    A unique identifier for the object.
  • language
    String Read-only
    The language that is linked to the object.
  • linkedSpaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • plannedPurgeDate
    DateTime Read-only
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • spaceViewId
    Long
    Space View
    Read-only
    The ID of the space view this object is linked to.
  • state
    Enum Read-only
    The object's current state.
    • PENDING
      Pending
    • FAILED
      Failed
    • SUCCESSFUL
      Successful
  • timeZone
    String Read-only
  • timeoutOn
    DateTime Read-only
  • transaction
    Transaction Expandable Read-only
  • type
    Enum Read-only
    • ASYNCHRONOUS
      Asynchronous
    • SYNCHRONOUS
      Synchronous
    • TOKEN
      Token
    • TERMINAL
      Terminal
  • userFailureMessage
    String Read-only
    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.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.9.14Charge Attempt Details

Properties
  • charge
    Charge Expandable Read-only
  • completionBehavior
    Enum Read-only
    • COMPLETE_IMMEDIATELY
      Complete Immediately
    • COMPLETE_DEFERRED
      Complete Deferred
    • USE_CONFIGURATION
      Use Configuration
  • connectorConfiguration
    Payment Connector Configuration Expandable Read-only
  • createdOn
    DateTime Read-only
    The date and time when the object was created.
  • customersPresence
    Enum Read-only
    The customer's presence indicates which kind of customer interaction was used during the charge attempt.
    • NOT_PRESENT
      Not Present
    • VIRTUAL_PRESENT
      Virtual Present
    • PHYSICAL_PRESENT
      Physical Present
  • environment
    Enum Read-only
    • PRODUCTION
      Production
    • TEST
      Test
  • failedOn
    DateTime Read-only
  • failureReason
    Failure Reason Read-only
  • id
    Long Read-only
    A unique identifier for the object.
  • initializingTokenVersion
    Boolean Read-only
  • invocation
    Connector Invocation Expandable Read-only
  • labels
    Collection of Label Expandable Read-only
    The labels providing additional information about the object.
  • language
    String Read-only
    The language that is linked to the object.
  • linkedSpaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • linkedTransaction
    Long
    Transaction
    Read-only
  • nextUpdateOn
    DateTime Read-only
  • plannedPurgeDate
    DateTime Read-only
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • redirectionUrl
    String Read-only
  • salesChannel
    Long
    Sales Channel
    Read-only
  • spaceViewId
    Long
    Space View
    Read-only
    The ID of the space view this object is linked to.
  • state
    Enum Read-only
    The object's current state.
    • PROCESSING
      Processing
    • FAILED
      Failed
    • SUCCESSFUL
      Successful
  • succeededOn
    DateTime Read-only
  • terminal
    Payment Terminal Expandable Read-only
  • timeZone
    String Read-only
  • timeoutOn
    DateTime Read-only
  • tokenVersion
    Token Version Expandable Read-only
  • userFailureMessage
    String Read-only
    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.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.
  • wallet
    Wallet Type Read-only

11.9.15Charge Bank Transaction Details

Properties
  • bankTransaction
    Bank Transaction Expandable Read-only
  • completion
    Transaction Completion Expandable Read-only
  • id
    Long Read-only
    A unique identifier for the object.
  • language
    String Read-only
    The language that is linked to the object.
  • linkedSpaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • linkedTransaction
    Long
    Transaction
    Read-only
  • spaceViewId
    Long
    Space View
    Read-only
    The ID of the space view this object is linked to.
  • transaction
    Transaction Expandable Read-only
  • transactionCurrencyAmount
    Decimal Read-only
    Specify the posting amount in the transaction's currency.
  • transactionCurrencyValueAmount
    Decimal Read-only
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.9.16Charge Flow Details

Properties
  • conditions
    Collection of Payment Connector Condition Expandable Read-only
    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.
  • id
    Long Read-only
    A unique identifier for the object.
  • linkedSpaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • name
    String Read-only
    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.
  • plannedPurgeDate
    DateTime Read-only
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • priority
    Integer Read-only
    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.
  • state
    Enum Read-only
    The object's current state.
    • CREATE
      Create
    • ACTIVE
      Active
    • INACTIVE
      Inactive
    • DELETING
      Deleting
    • DELETED
      Deleted
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.9.17Charge Flow Level Details

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

11.9.18Charge Flow Level Configuration Details

Properties
  • flow
    Charge Flow Expandable Read-only
    The charge flow level configuration to which the flow is associated.
  • id
    Long Read-only
    A unique identifier for the object.
  • linkedSpaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • name
    String Read-only
    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.
  • period
    String Read-only
    The duration of the level before switching to the next one.
  • plannedPurgeDate
    DateTime Read-only
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • priority
    Integer Read-only
    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.
  • state
    Enum Read-only
    The object's current state.
    • CREATE
      Create
    • ACTIVE
      Active
    • INACTIVE
      Inactive
    • DELETING
      Deleting
    • DELETED
      Deleted
  • type
    Long
    Charge Flow Level Configuration Type
    Read-only
    The type determines how the payment link is delivered to the customer. Once the type is defined it cannot be changed anymore.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.9.19Charge Flow Level Configuration Type Details

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

11.9.20Charge Flow Level Payment Link Details

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

11.9.21Completion Line Item Details

Properties
  • amount
    Decimal Read-only
    The total amount of the line item including any tax.
  • quantity
    Decimal Read-only
    The quantity of the line item which should be completed.
  • uniqueId
    String Read-only
    The unique id identifies the line item on which the capture is applied on.

11.9.22Connector Invocation Details

Properties
  • createdOn
    DateTime Read-only
    The date and time when the object was created.
  • id
    Long Read-only
    A unique identifier for the object.
  • linkedSpaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • plannedPurgeDate
    DateTime Read-only
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • stage
    Enum Read-only
    • PAYMENT_METHOD_LIST
      Payment Method List
    • FORM_GENERATION
      Form Generation
    • VALIDATION
      Validation
    • AUTHORIZATION
      Authorization
  • timeTookInMilliseconds
    Long Read-only
  • transaction
    Long
    Transaction
    Read-only
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.9.23Currency Bank Account Details

Properties
  • bankAccount
    Bank Account Expandable Read-only
  • currency
    String Read-only
  • environment
    Enum Read-only
    • PRODUCTION
      Production
    • TEST
      Test
  • id
    Long Read-only
    A unique identifier for the object.
  • linkedSpaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.9.24Delivery Indication Details

Properties
  • automaticDecisionReason
    Delivery Indication Decision Reason Read-only
  • automaticallyDecidedOn
    DateTime Read-only
  • completion
    Transaction Completion Expandable Read-only
  • createdOn
    DateTime Read-only
    The date and time when the object was created.
  • id
    Long Read-only
    A unique identifier for the object.
  • linkedSpaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • linkedTransaction
    Long
    Transaction
    Read-only
  • manualDecisionTimeoutOn
    DateTime Read-only
  • manuallyDecidedBy
    Long Read-only
  • manuallyDecidedOn
    DateTime Read-only
  • plannedPurgeDate
    DateTime Read-only
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • state
    Enum Read-only
    The object's current state.
    • PENDING
      Pending
    • NOT_SUITABLE
      Not Suitable
    • MANUAL_CHECK_REQUIRED
      Manual Check Required
    • SUITABLE
      Suitable
  • timeoutOn
    DateTime Read-only
  • transaction
    Transaction Expandable Read-only

11.9.25Delivery Indication Decision Reason Details

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

11.9.26External Transfer Bank Transaction Details

Properties
  • bankTransaction
    Bank Transaction Expandable Read-only
  • externalAccountIdentifier
    String Read-only
  • externalAccountType
    String Read-only
  • externalBankName
    String Read-only
  • id
    Long Read-only
    A unique identifier for the object.
  • linkedSpaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.9.27Internal Transfer Bank Transaction Details

Properties
  • id
    Long Read-only
    A unique identifier for the object.
  • linkedSpaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • sourceBankTransaction
    Bank Transaction Expandable Read-only
  • targetBankTransaction
    Bank Transaction Expandable Read-only
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.9.28Payment Adjustment Details

Properties
  • amountExcludingTax
    Decimal Read-only
  • amountIncludingTax
    Decimal Read-only
    The total amount of this adjustment including taxes.
  • id
    Long Read-only
    A unique identifier for the object.
  • rateInPercentage
    Decimal Read-only
    The rate in percentage is the rate on which the adjustment amount was calculated with.
  • tax
    Tax Read-only
  • type
    Long
    Payment Adjustment Type
    Read-only

11.9.29Payment Adjustment Type Details

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

11.9.30Payment 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

11.9.31Payment Information Hash Type Details

Properties
  • id
    Long Read-only
    A unique identifier for the object.
  • name
    Map of String String Expandable Read-only

11.9.32Payment Link Details

The payment link defines an URL to automatically create transactions.

Properties
  • allowedPaymentMethodConfigurations
    Collection of Payment Method Configuration Expandable Read-only
    The allowed payment method configurations restrict the payment methods which can be used with this payment link.
  • appliedSpaceView
    Long Read-only
    The payment link can be conducted in a specific space view. The space view may apply a specific design to the payment page.
  • availableFrom
    DateTime Read-only
    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.
  • availableUntil
    DateTime Read-only
    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.
  • billingAddressHandlingMode
    Enum Read-only
    The billing address handling mode controls if the address is collected or not and how it is collected.
    • NOT_REQUIRED
      Not Required
    • REQUIRED_IN_URL
      Required In Url
    • REQUIRED_ON_PAYMENT_PAGE
      Required On Payment Page
  • currency
    String Read-only
    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'.
  • externalId
    String Read-only
    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.
  • id
    Long Read-only
    A unique identifier for the object.
  • language
    String Read-only
    The language defines the language of the payment page. If no language is provided it can be provided through the request parameter.
  • lineItems
    Collection of Line Item Expandable Read-only
    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.
  • linkedSpaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • maximalNumberOfTransactions
    Integer Read-only
    The maximal number of transactions limits the number of transactions which can be created with this payment link.
  • name
    String Read-only
    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.
  • plannedPurgeDate
    DateTime Read-only
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • protectionMode
    Enum Read-only
    The protection mode determines if the payment link is protected against tampering and in what way.
    • NO_PROTECTION
      No Protection
    • ACCESS_KEY
      Access Key
  • shippingAddressHandlingMode
    Enum Read-only
    The shipping address handling mode controls if the address is collected or not and how it is collected.
    • NOT_REQUIRED
      Not Required
    • REQUIRED_IN_URL
      Required In Url
    • REQUIRED_ON_PAYMENT_PAGE
      Required On Payment Page
  • state
    Enum Read-only
    The object's current state.
    • CREATE
      Create
    • ACTIVE
      Active
    • INACTIVE
      Inactive
    • DELETING
      Deleting
    • DELETED
      Deleted
  • url
    String Read-only
    The URL defines the URL to which the user has to be forwarded to initialize the payment.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.9.33Payment Terminal Receipt Type Details

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

11.9.34Refund 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 Read-only
  • baseLineItems
    Collection of Line Item Expandable Read-only
  • completion
    Long
    Transaction Completion
    Read-only
  • createdBy
    Long
    User
    Read-only
  • createdOn
    DateTime Read-only
    The date and time when the object was created.
  • environment
    Enum Read-only
    • LIVE
      Live
    • PREVIEW
      Preview
  • externalId
    String Read-only
    The external id helps to identify duplicate calls to the refund service. As such the external ID has to be unique per transaction.
  • failedOn
    DateTime Read-only
  • failureReason
    Failure Reason Read-only
  • id
    Long Read-only
    A unique identifier for the object.
  • labels
    Collection of Label Expandable Read-only
    The labels providing additional information about the object.
  • language
    String Read-only
    The language that is linked to the object.
  • lineItems
    Collection of Line Item Expandable Read-only
  • linkedSpaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • merchantReference
    String Read-only
  • nextUpdateOn
    DateTime Read-only
  • plannedPurgeDate
    DateTime Read-only
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • processingOn
    DateTime Read-only
  • processorReference
    String Read-only
  • reducedLineItems
    Collection of Line Item Expandable Read-only
  • reductions
    Collection of Line Item Reduction Expandable Read-only
  • state
    Enum Read-only
    The object's current state.
    • CREATE
      Create
    • SCHEDULED
      Scheduled
    • PENDING
      Pending
    • MANUAL_CHECK
      Manual Check
    • FAILED
      Failed
    • SUCCESSFUL
      Successful
  • succeededOn
    DateTime Read-only
  • taxes
    Collection of Tax Expandable Read-only
  • timeZone
    String Read-only
  • timeoutOn
    DateTime Read-only
  • totalAppliedFees
    Decimal Read-only
    The total applied fees is the sum of all fees that have been applied so far.
  • totalSettledAmount
    Decimal Read-only
    The total settled amount is the total amount which has been settled so far.
  • transaction
    Transaction Expandable Read-only
  • type
    Enum Read-only
    • MERCHANT_INITIATED_ONLINE
      Merchant Initiated Online
    • MERCHANT_INITIATED_OFFLINE
      Merchant Initiated Offline
    • CUSTOMER_INITIATED_AUTOMATIC
      Customer Initiated Automatic
    • CUSTOMER_INITIATED_MANUAL
      Customer Initiated Manual
  • updatedInvoice
    Long
    Transaction Invoice
    Read-only
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.9.35Refund Bank Transaction Details

Properties
  • bankTransaction
    Bank Transaction Expandable Read-only
  • id
    Long Read-only
    A unique identifier for the object.
  • language
    String Read-only
    The language that is linked to the object.
  • linkedSpaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • linkedTransaction
    Long
    Transaction
    Read-only
  • refund
    Refund Expandable Read-only
  • refundCurrencyAmount
    Decimal Read-only
    Specify the posting amount in the refund's currency.
  • refundCurrencyValueAmount
    Decimal Read-only
  • spaceViewId
    Long
    Space View
    Read-only
    The ID of the space view this object is linked to.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.9.36Refund Comment Details

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

11.9.37Refund Recovery Bank Transaction Details

Properties
  • bankTransaction
    Bank Transaction Expandable Read-only
  • id
    Long Read-only
    A unique identifier for the object.
  • language
    String Read-only
    The language that is linked to the object.
  • lineItems
    Collection of Line Item Expandable Read-only
    The line items contain the items which could be recovered.
  • linkedSpaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • linkedTransaction
    Long
    Transaction
    Read-only
  • refund
    Refund Expandable Read-only
  • refundCurrencyAmount
    Decimal Read-only
    Specify the posting amount in the refund's currency.
  • refundCurrencyValueAmount
    Decimal Read-only
  • spaceViewId
    Long
    Space View
    Read-only
    The ID of the space view this object is linked to.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.9.38Rendered Terminal Receipt Details

Properties
  • data
    Collection of Byte Read-only
    The data property contains the binary data of the receipt document encoded as base 64 encoded string.
  • mimeType
    String Read-only
    The mime type indicates the format of the receipt document. The mime type depends on the requested receipt format.
  • printed
    Boolean Read-only
    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.
  • receiptType
    Payment Terminal Receipt Type Read-only
    Each receipt has a different usage. The receipt type indicates for what resp. for whom the document is for.

11.9.39Terminal Receipt Fetch Request Details

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

Properties

11.9.40Token Version Details

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

11.9.41Token Version Type Details

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

11.9.42Tokenized Card Data Details

This model holds the card data in plain.

Properties
  • cardHolderName
    String
    ≤ 100 chars
    The card holder name is the name printed onto the card. It identifies the person who owns the card.
  • cardVerificationCode
    String
    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.
  • cryptogram
    Card Cryptogram
    The additional authentication value used to secure the tokenized card transactions.
  • expiryDate
    String
    ([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).
  • panType
    Enum
    • 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
  • primaryAccountNumber
    String Required
    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.
  • recurringIndicator
    Enum
    • 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
  • schemeTransactionReference
    String
    ≤ 100 chars
  • tokenRequestorId
    String

11.9.43Tokenized Card Data Details

This model holds the card data in plain.

Properties
  • cardHolderName
    String Read-only
    The card holder name is the name printed onto the card. It identifies the person who owns the card.
  • cardVerificationCode
    String Read-only
    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.
  • cryptogram
    Card Cryptogram Read-only
    The additional authentication value used to secure the tokenized card transactions.
  • expiryDate
    String Read-only
    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).
  • initialRecurringTransaction
    Boolean Read-only
  • panType
    Enum Read-only
    • 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
  • primaryAccountNumber
    String Read-only
    The primary account number (PAN) identifies the card. The number is numeric and typically printed on the front of the card.
  • recurringIndicator
    Enum Read-only
    • 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
  • schemeTransactionReference
    String Read-only
  • tokenRequestorId
    String Read-only

11.9.44Tokenized Card Request Details

Request to process a card transaction with using 3D-Secure.

Properties

11.9.45Transaction Aware Entity Details

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

11.9.46Transaction Comment Details

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

11.9.47Transaction Completion Details

Properties
  • amount
    Decimal Read-only
    The amount which is captured. The amount represents sum of line items including taxes.
  • baseLineItems
    Collection of Line Item Expandable Read-only
    The base line items on which the completion is applied on.
  • createdBy
    Long Read-only
  • createdOn
    DateTime Read-only
    The date and time when the object was created.
  • externalId
    String Read-only
    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.
  • failedOn
    DateTime Read-only
  • failureReason
    Failure Reason Read-only
  • id
    Long Read-only
    A unique identifier for the object.
  • invoiceMerchantReference
    String Read-only
  • labels
    Collection of Label Expandable Read-only
    The labels providing additional information about the object.
  • language
    String Read-only
    The language that is linked to the object.
  • lastCompletion
    Boolean Read-only
    Indicates if this is the last completion. After the last completion is created the transaction cannot be completed anymore.
  • lineItemVersion
    Transaction Line Item Version Expandable Read-only
  • lineItems
    Collection of Line Item Expandable Read-only
    The line items which are captured.
  • linkedSpaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • linkedTransaction
    Long
    Transaction
    Read-only
  • mode
    Enum Read-only
    • DIRECT
      Direct
    • ONLINE
      Online
    • OFFLINE
      Offline
  • nextUpdateOn
    DateTime Read-only
  • paymentInformation
    String Read-only
  • plannedPurgeDate
    DateTime Read-only
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • processingOn
    DateTime Read-only
  • processorReference
    String Read-only
  • remainingLineItems
    Collection of Line Item Expandable Read-only
  • spaceViewId
    Long
    Space View
    Read-only
    The ID of the space view this object is linked to.
  • state
    Enum Read-only
    The object's current state.
    • CREATE
      Create
    • SCHEDULED
      Scheduled
    • PENDING
      Pending
    • FAILED
      Failed
    • SUCCESSFUL
      Successful
  • statementDescriptor
    String Read-only
    The statement descriptor explain charges or payments on bank statements.
  • succeededOn
    DateTime Read-only
  • taxAmount
    Decimal Read-only
    The total sum of all taxes of line items.
  • timeZone
    String Read-only
  • timeoutOn
    DateTime Read-only
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.9.48Transaction Completion Details Details

Properties
  • externalId
    String Required
    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.
  • invoiceMerchantReference
    String
    ≤ 100 chars
  • lastCompletion
    Boolean Required
    The last completion flag indicates if this is the last completion. After the last completion is created no further completions can be issued.
  • lineItems
    Collection of Completion Line Item . Create Create
    The line items which will be used to complete the transaction.
  • statementDescriptor
    String
    ≤ 80 options
    [a-zA-Z0-9\s.,_?+/-]*
    The statement descriptor explain charges or payments on bank statements.

11.9.49Transaction Invoice Details

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

Properties
  • amount
    Decimal Read-only
  • billingAddress
    Address Expandable Read-only
  • completion
    Transaction Completion Expandable Read-only
  • createdOn
    DateTime Read-only
    The date on which the invoice is created on.
  • derecognizedBy
    Long Read-only
    The id of the user which marked the invoice as derecognized.
  • derecognizedOn
    DateTime Read-only
    The date on which the invoice is marked as derecognized.
  • dueOn
    DateTime Read-only
    The date on which the invoice should be paid on.
  • environment
    Enum Read-only
    • LIVE
      Live
    • PREVIEW
      Preview
  • externalId
    String Read-only
    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.
  • id
    Long Read-only
    A unique identifier for the object.
  • language
    String Read-only
    The language that is linked to the object.
  • lineItems
    Collection of Line Item Expandable Read-only
  • linkedSpaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • linkedTransaction
    Long
    Transaction
    Read-only
  • merchantReference
    String Read-only
  • outstandingAmount
    Decimal Read-only
    The outstanding amount indicates how much the buyer owes the merchant. A negative amount indicates that the invoice is overpaid.
  • paidOn
    DateTime Read-only
    The date on which the invoice is marked as paid. Eventually this date lags behind of the actual paid date.
  • plannedPurgeDate
    DateTime Read-only
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • spaceViewId
    Long
    Space View
    Read-only
    The ID of the space view this object is linked to.
  • state
    Enum Read-only
    The object's current state.
    • CREATE
      Create
    • OPEN
      Open
    • OVERDUE
      Overdue
    • CANCELED
      Canceled
    • PAID
      Paid
    • DERECOGNIZED
      Derecognized
    • NOT_APPLICABLE
      Not Applicable
  • taxAmount
    Decimal Read-only
  • timeZone
    String Read-only
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.9.50Transaction Invoice Comment Details

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

11.9.51Transaction Invoice Replacement Details

Properties
  • billingAddress
    Address in Create State Create
  • dueOn
    DateTime
    The date on which the invoice should be paid on.
  • externalId
    String Required
    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.
  • lineItems
    Collection of Line Item Create Required
  • merchantReference
    String
    ≤ 100 chars
  • sentToCustomer
    Boolean
    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.

11.9.52Transaction Line Item Version Details

Properties
  • amount
    Decimal Read-only
  • createdBy
    Long Read-only
  • createdOn
    DateTime Read-only
    The date and time when the object was created.
  • externalId
    String Read-only
    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.
  • failedOn
    DateTime Read-only
  • failureReason
    Failure Reason Read-only
  • id
    Long Read-only
    A unique identifier for the object.
  • labels
    Collection of Label Expandable Read-only
    The labels providing additional information about the object.
  • language
    String Read-only
    The language that is linked to the object.
  • lineItems
    Collection of Line Item Expandable Read-only
  • linkedSpaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • linkedTransaction
    Long
    Transaction
    Read-only
  • nextUpdateOn
    DateTime Read-only
  • plannedPurgeDate
    DateTime Read-only
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • processingOn
    DateTime Read-only
  • spaceViewId
    Long
    Space View
    Read-only
    The ID of the space view this object is linked to.
  • state
    Enum Read-only
    The object's current state.
    • CREATE
      Create
    • SCHEDULED
      Scheduled
    • PENDING
      Pending
    • SUCCESSFUL
      Successful
    • FAILED
      Failed
  • succeededOn
    DateTime Read-only
  • taxAmount
    Decimal Read-only
  • timeoutOn
    DateTime Read-only
  • transaction
    Transaction Expandable Read-only
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.9.53Transaction Line Item Version . Create Details

Properties
  • externalId
    String Required
    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.
  • lineItems
    Collection of Line Item Create Required
  • transaction
    ID of Transaction Required

11.9.54Transaction Void Details

Properties
  • createdBy
    Long Read-only
  • createdOn
    DateTime Read-only
    The date and time when the object was created.
  • failedOn
    DateTime Read-only
  • failureReason
    Failure Reason Read-only
  • id
    Long Read-only
    A unique identifier for the object.
  • labels
    Collection of Label Expandable Read-only
    The labels providing additional information about the object.
  • language
    String Read-only
    The language that is linked to the object.
  • linkedSpaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • linkedTransaction
    Long
    Transaction
    Read-only
  • mode
    Enum Read-only
    • ONLINE
      Online
    • OFFLINE
      Offline
  • nextUpdateOn
    DateTime Read-only
  • plannedPurgeDate
    DateTime Read-only
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • processorReference
    String Read-only
  • spaceViewId
    Long
    Space View
    Read-only
    The ID of the space view this object is linked to.
  • state
    Enum Read-only
    The object's current state.
    • CREATE
      Create
    • PENDING
      Pending
    • FAILED
      Failed
    • SUCCESSFUL
      Successful
  • succeededOn
    DateTime Read-only
  • timeoutOn
    DateTime Read-only
  • transaction
    Transaction Expandable Read-only
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.9.55Wallet Type Details

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

11.9.56Base

11.9.56.1Payment Connector Details

Properties
  • dataCollectionType
    Enum Read-only
    The data collection type specifies how the payment information is collected.
    • ONSITE
      Onsite
    • OFFSITE
      Offsite
  • deprecated
    Boolean Read-only
    Whether the object was deprecated.
  • deprecationReason
    Map of String String Read-only
    The deprecation reason describes why the object was deprecated.
  • description
    Map of String String Expandable Read-only
    The localized description of the object.
  • id
    Long Read-only
    A unique identifier for the object.
  • name
    Map of String String Expandable Read-only
    The localized name of the object.
  • paymentMethod
    Payment Method Expandable Read-only
    The payment method that the connector supports.
  • paymentMethodBrand
    Payment Method Brand Expandable Read-only
    The specific brand that this payment connector supports.
  • primaryRiskTaker
    Enum Read-only
    The entity that bears the main risk in the event that a contracting party fails to meet its obligations.
    • CUSTOMER
      Customer
    • MERCHANT
      Merchant
    • THIRD_PARTY
      Third Party
  • processor
    Payment Processor Expandable Read-only
    The processor that the connector belongs to.
  • supportedCurrencies
    Collection of String Expandable Read-only
    The currencies that are supported by the connector.
  • supportedCustomersPresences
    Collection of Enum Read-only
    The types of customer's presence that are supported by the connector.
    • NOT_PRESENT
      Not Present
    • VIRTUAL_PRESENT
      Virtual Present
    • PHYSICAL_PRESENT
      Physical Present
  • supportedFeatures
    Collection of Payment Connector Feature Expandable Read-only
    The features that are supported by the connector.

11.9.56.2Payment Connector Configuration Details

Properties
  • applicableForTransactionProcessing
    Boolean Read-only
    Whether this connector configuration is enabled for processing payments, taking into account the state of the processor and payment method configurations.
  • conditions
    Collection of Payment Connector Condition Expandable Read-only
    Conditions allow to define criteria that a transaction must fulfill in order for the connector configuration to be considered for processing the payment.
  • connector
    Payment Connector Expandable Read-only
    The connector that the configuration is for.
  • enabledSalesChannels
    Collection of Sales Channel Expandable Read-only
    The sales channels for which the connector configuration is enabled. If empty, it is enabled for all sales channels.
  • enabledSpaceViews
    Collection of Long Read-only
    The space views for which the connector configuration is enabled. If empty, it is enabled for all space views.
  • id
    Long Read-only
    A unique identifier for the object.
  • imagePath
    String Read-only
    The URL to the connector's image.
  • linkedSpaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • name
    String Read-only
    The name used to identify the connector configuration.
  • paymentMethodConfiguration
    Payment Method Configuration Expandable Read-only
    The payment method configuration that the connector configuration belongs to.
  • plannedPurgeDate
    DateTime Read-only
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • priority
    Integer Read-only
    The priority that determines the order in which connector configurations are taken into account when processing a payment. Low values are considered first.
  • processorConfiguration
    Processor Configuration Expandable Read-only
    The processor configuration that the connector configuration belongs to.
  • state
    Enum Read-only
    The object's current state.
    • CREATE
      Create
    • ACTIVE
      Active
    • INACTIVE
      Inactive
    • DELETING
      Deleting
    • DELETED
      Deleted
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.9.56.3Payment Connector Feature Details

Properties
  • displayName
    String Read-only
    The name of the feature.
  • id
    Long Read-only
    A unique identifier for the object.

11.9.56.4Payment Method Details

Properties
  • dataCollectionTypes
    Collection of Enum Read-only
    The data collection types that are supported by the payment method.
    • ONSITE
      Onsite
    • OFFSITE
      Offsite
  • description
    Map of String String Expandable Read-only
    The localized description of the object.
  • id
    Long Read-only
    A unique identifier for the object.
  • imagePath
    String Read-only
    The path to the payment method's image which is displayed to the customer.
  • merchantDescription
    Map of String String Expandable Read-only
  • name
    Map of String String Expandable Read-only
    The localized name of the object.
  • supportedCurrencies
    Collection of String Expandable Read-only
    The currencies that are supported by the payment method.

11.9.56.5Payment Method Brand Details

Properties
  • description
    Map of String String Expandable Read-only
    The localized description of the object.
  • grayImagePath
    String Read-only
  • id
    Long Read-only
    A unique identifier for the object.
  • imagePath
    String Read-only
    The path to the payment brand's image which is displayed to the customer.
  • name
    Map of String String Expandable Read-only
    The localized name of the object.
  • paymentMethod
    Long
    Payment Method
    Read-only
    The payment method that the brand belongs to.

11.9.56.6Payment Method Configuration Details

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

Properties
  • dataCollectionType
    Enum Read-only
    The data collection type specifies how the payment information is collected.
    • ONSITE
      Onsite
    • OFFSITE
      Offsite
  • description
    Map of String String Expandable Read-only
    A custom description for the payment method which is displayed to the customer.
  • id
    Long Read-only
    A unique identifier for the object.
  • imageResourcePath
    String Read-only
    The resource path to a custom image for the payment method which is displayed to the customer.
  • linkedSpaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • name
    String Read-only
    The name used to identify the payment method configuration.
  • oneClickPaymentMode
    Enum Read-only
    The one-click payment mode determines whether the customer can save their payment details for later payments.
    • DISABLED
      Disabled
    • ALLOW
      Allow
    • FORCE
      Force
  • paymentMethod
    Payment Method Expandable Read-only
    The payment method that the configuration is for.
  • plannedPurgeDate
    DateTime Read-only
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • resolvedDescription
    Map of String String Expandable Read-only
    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.
  • resolvedImageUrl
    String Read-only
    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.
  • resolvedTitle
    Map of String String Expandable Read-only
    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.
  • sortOrder
    Integer Read-only
    When listing payment methods, they can be sorted by this number.
  • spaceId
    Long Read-only
    The ID of the space this object belongs to.
  • state
    Enum Read-only
    The object's current state.
    • CREATE
      Create
    • ACTIVE
      Active
    • INACTIVE
      Inactive
    • DELETING
      Deleting
    • DELETED
      Deleted
  • title
    Map of String String Expandable Read-only
    A custom title for the payment method which is displayed to the customer.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.9.56.7Payment 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
    Map of String String Expandable Read-only
    The name of the company to which the processor belongs.
  • description
    Map of String String Expandable Read-only
    The localized description of the object.
  • headquartersLocation
    Map of String String Expandable Read-only
    Where the processor's headquarters are located.
  • id
    Long Read-only
    A unique identifier for the object.
  • logoPath
    String Read-only
    The path to the logo image of the processor.
  • name
    Map of String String Expandable Read-only
    The localized name of the object.
  • productName
    Map of String String Expandable Read-only
    The name of the processor's product.

11.9.56.8Processor Configuration Details

Properties
  • applicationManaged
    Boolean Read-only
    Whether the processor configuration is managed by the application and therefore cannot be changed.
  • contractId
    Long
    Payment Contract
    Read-only
    The ID of the payment contract the processor configuration is linked to.
  • id
    Long Read-only
    A unique identifier for the object.
  • linkedSpaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • name
    String Read-only
    The name used to identify the payment method configuration.
  • plannedPurgeDate
    DateTime Read-only
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • processor
    Payment Processor Expandable Read-only
    The payment processor that the configuration is for.
  • state
    Enum Read-only
    The object's current state.
    • CREATE
      Create
    • ACTIVE
      Active
    • INACTIVE
      Inactive
    • DELETING
      Deleting
    • DELETED
      Deleted
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.9.56.9Sales Channel Details

Properties
  • description
    Map of String String Expandable Read-only
    The localized description of the object.
  • id
    Long Read-only
    A unique identifier for the object.
  • name
    Map of String String Expandable Read-only
    The localized name of the object.
  • sortOrder
    Integer Read-only
    When listing sales channels, they can be sorted by this number.

11.9.57Charge

11.9.58Condition

11.9.58.1Payment Condition Type Details

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

11.9.58.2Payment 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
    Payment Condition Type Expandable Read-only
    The condition type determines the criteria that a transaction must fulfill in order for a connector configuration to be considered for processing the payment.
  • id
    Long Read-only
    A unique identifier for the object.
  • linkedSpaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • name
    String Read-only
    The name used to identify the condition.
  • plannedPurgeDate
    DateTime Read-only
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • state
    Enum Read-only
    The object's current state.
    • CREATE
      Create
    • ACTIVE
      Active
    • INACTIVE
      Inactive
    • DELETING
      Deleting
    • DELETED
      Deleted
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.9.59Contract

11.9.59.1Payment Contract Details

Properties
  • account
    Long
    Account
    Read-only
    This account that the contract belongs to.
  • activatedOn
    DateTime Read-only
    The date and time when the contract was activated.
  • contractIdentifier
    String Read-only
    The identifier of the contract.
  • contractType
    Payment Contract Type Read-only
    The type of the contract.
  • createdBy
    Long
    User
    Read-only
    The ID of the user the contract was created by.
  • createdOn
    DateTime Read-only
    The date and time when the object was created.
  • externalId
    String Read-only
    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.
  • id
    Long Read-only
    A unique identifier for the object.
  • lastModifiedDate
    DateTime Read-only
    The date and time when the object was last modified.
  • rejectedOn
    DateTime Read-only
    The date and time when the contract was rejected.
  • rejectionReason
    Failure Reason Read-only
    The reason for rejecting the contract.
  • startTerminatingOn
    DateTime Read-only
    The date and time when the termination process of the contract was started.
  • state
    Enum Read-only
    The object's current state.
    • PENDING
      Pending
    • ACTIVE
      Active
    • TERMINATING
      Terminating
    • TERMINATED
      Terminated
    • REJECTED
      Rejected
  • terminatedBy
    Long
    User
    Read-only
    The ID of the user the contract was terminated by.
  • terminatedOn
    DateTime Read-only
    The date and time when the contract was terminated.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.9.59.2Payment Contract Type Details

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

11.9.60Terminal

11.9.60.1Payment Terminal Details

Properties
  • configurationVersion
    Payment Terminal Configuration Version Expandable Read-only
    The configuration that is assigned to the terminal and determines how it works.
  • defaultCurrency
    String Read-only
    The default currency of the terminal.
  • deviceName
    String Read-only
    The name of the device that is currently linked to the payment terminal.
  • deviceSerialNumber
    String Read-only
    The serial number of the device that is currently linked to the payment terminal.
  • externalId
    String Read-only
    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.
  • id
    Long Read-only
    A unique identifier for the object.
  • identifier
    String Read-only
    The unique identifier of the terminal, that is displayed on the device.
  • linkedSpaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • locationVersion
    Payment Terminal Location Version Expandable Read-only
    The physical location where the terminal is used.
  • name
    String Read-only
    The name used to identify the payment terminal.
  • plannedPurgeDate
    DateTime Read-only
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • state
    Enum Read-only
    The object's current state.
    • CREATE
      Create
    • PREPARING
      Preparing
    • ACTIVE
      Active
    • INACTIVE
      Inactive
    • DECOMMISSIONING
      Decommissioning
    • DECOMMISSIONED
      Decommissioned
  • type
    Payment Terminal Type Read-only
    The type of the payment terminal.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.9.60.2Payment Terminal Address Details

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

11.9.60.3Payment Terminal Configuration Details

Properties
  • id
    Long Read-only
    A unique identifier for the object.
  • linkedSpaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • name
    String Read-only
    The name used to identify the payment terminal configuration.
  • plannedPurgeDate
    DateTime Read-only
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • state
    Enum Read-only
    The object's current state.
    • CREATE
      Create
    • ACTIVE
      Active
    • DELETING
      Deleting
    • DELETED
      Deleted
  • type
    Payment Terminal Type Read-only
    The type of payment terminals that this configuration can be assigned to.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.9.60.4Payment Terminal Configuration Version Details

Properties
  • configuration
    Payment Terminal Configuration Expandable Read-only
    The payment terminal configuration that the version belongs to.
  • connectorConfigurations
    Collection of Long
    Payment Connector Configuration
    Read-only
    The payment connector configurations that are available on the payment terminal.
  • createdBy
    Long Read-only
    The ID of the user the payment terminal configuration version was created by.
  • createdOn
    DateTime Read-only
    The date and time when the object was created.
  • defaultCurrency
    String Read-only
    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.
  • id
    Long Read-only
    A unique identifier for the object.
  • linkedSpaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • maintenanceWindowDuration
    String Read-only
    The permitted duration of the terminal's maintenance window.
  • maintenanceWindowStart
    String Read-only
    The start time of the terminal's maintenance window.
  • plannedPurgeDate
    DateTime Read-only
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • state
    Enum Read-only
    The object's current state.
    • PENDING
      Pending
    • SCHEDULING
      Scheduling
    • ACTIVE
      Active
    • DELETING
      Deleting
    • DELETED
      Deleted
  • timeZone
    String Read-only
    The time zone of the payment terminal used to determine the maintenance window.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.
  • versionAppliedImmediately
    Boolean Read-only
    Whether payment terminals are immediately updated to this configuration version. If not, it will be applied during the maintenance window.

11.9.60.5Payment Terminal Location Details

Properties
  • externalId
    String Read-only
    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.
  • id
    Long Read-only
    A unique identifier for the object.
  • linkedSpaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • name
    String Read-only
    The name used to identify the payment terminal location.
  • plannedPurgeDate
    DateTime Read-only
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • state
    Enum Read-only
    The object's current state.
    • CREATE
      Create
    • ACTIVE
      Active
    • DELETING
      Deleting
    • DELETED
      Deleted
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.9.60.6Payment Terminal Location Version Details

Properties
  • address
    Payment Terminal Address Expandable Read-only
    The postal address of the location where the payment terminals are used.
  • contactAddress
    Payment Terminal Address Expandable Read-only
    The contact details if the person responsible for the payment terminals at this location.
  • createdBy
    Long Read-only
    The ID of the user the payment terminal location version was created by.
  • createdOn
    DateTime Read-only
    The date and time when the object was created.
  • id
    Long Read-only
    A unique identifier for the object.
  • linkedSpaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • location
    Payment Terminal Location Expandable Read-only
    The payment terminal location that the version belongs to.
  • plannedPurgeDate
    DateTime Read-only
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • state
    Enum Read-only
    The object's current state.
    • PENDING
      Pending
    • SCHEDULING
      Scheduling
    • ACTIVE
      Active
    • DELETING
      Deleting
    • DELETED
      Deleted
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.
  • versionAppliedImmediately
    Boolean Read-only
    Whether payment terminals are immediately updated to this configuration version. If not, it will be applied during the maintenance window.

11.9.60.7Payment Terminal Type Details

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

11.9.60.8Transaction summary Reference Details

Properties
  • id
    Long Read-only
    A unique identifier for the object.
  • linkedSpaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • terminalId
    Long Read-only
  • terminalIdentifier
    String Read-only

11.9.61Token

11.9.61.1Payment Token Details

Properties
  • createdOn
    DateTime Read-only
    The date and time when the object was created.
  • customerEmailAddress
    String Read-only
    The customer's email address.
  • customerId
    String Read-only
    The unique identifier of the customer in the external system.
  • enabledForOneClickPayment
    Boolean Read-only
    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.
  • externalId
    String Read-only
    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.
  • id
    Long Read-only
    A unique identifier for the object.
  • language
    String Read-only
    The language that is linked to the object.
  • linkedSpaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • plannedPurgeDate
    DateTime Read-only
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • state
    Enum Read-only
    The object's current state.
    • CREATE
      Create
    • ACTIVE
      Active
    • INACTIVE
      Inactive
    • DELETING
      Deleting
    • DELETED
      Deleted
  • timeZone
    String Read-only
    The customer's time zone, which affects how dates and times are formatted when communicating with the customer.
  • tokenReference
    String Read-only
    The reference used to identify the payment token (e.g. the customer's ID or email address).
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.9.62Transaction

11.9.62.1Transaction Details

Properties
  • acceptHeader
    String Read-only
    The 'Accept' header of the customer's web browser.
  • acceptLanguageHeader
    String Read-only
    The 'Accept Language' header of the customer's web browser.
  • allowedPaymentMethodBrands
    Collection of Long
    Payment Method Brand
    Read-only
    The payment method brands that can be used to authorize the transaction.
  • allowedPaymentMethodConfigurations
    Collection of Long
    Payment Method Configuration
    Read-only
    The payment method configurations that can be used to authorize the transaction.
  • authorizationAmount
    Decimal Read-only
    The sum of all line item prices including taxes in the transaction's currency.
  • authorizationEnvironment
    Enum Read-only
    The environment in which the transaction was authorized.
    • PRODUCTION
      Production
    • TEST
      Test
  • authorizationSalesChannel
    Long
    Sales Channel
    Read-only
    The sales channel through which the transaction was placed.
  • authorizationTimeoutOn
    DateTime Read-only
    The date and time when the transaction must be authorized, otherwise it will canceled.
  • authorizedOn
    DateTime Read-only
    The date and time when the transaction was authorized.
  • autoConfirmationEnabled
    Boolean Read-only
    Whether the transaction can be confirmed automatically or whether this must be done explicitly via the API. Default is true.
  • billingAddress
    Address Expandable Read-only
    The address associated with the payment method for invoicing and transaction processing purposes.
  • chargeRetryEnabled
    Boolean Read-only
    Whether the customer can make further payment attempts if the first one has failed. Default is true.
  • completedAmount
    Decimal Read-only
    The total amount that was completed, in the transaction's currency.
  • completedOn
    DateTime Read-only
    The date and time when the transaction was completed.
  • completionBehavior
    Enum Read-only
    The behavior that controls when the transaction is completed.
    • COMPLETE_IMMEDIATELY
      Complete Immediately
    • COMPLETE_DEFERRED
      Complete Deferred
    • USE_CONFIGURATION
      Use Configuration
  • completionTimeoutOn
    DateTime Read-only
    The date and time when the transaction is completed automatically.
  • confirmedBy
    Long Read-only
    The ID of the user the transaction was confirmed by.
  • confirmedOn
    DateTime Read-only
    The date and time when the transaction was created.
  • createdBy
    Long Read-only
    The ID of the user the transaction was created by.
  • createdOn
    DateTime Read-only
    The date and time when the object was created.
  • currency
    String Read-only
    The three-letter code (ISO 4217 format) of the transaction's currency.
  • customerEmailAddress
    String Read-only
    The customer's email address.
  • customerId
    String Read-only
    The unique identifier of the customer in the external system.
  • customersPresence
    Enum Read-only
    The customer's presence indicates whether and in what way the transaction's customer is present. Default is VIRTUAL_PRESENT.
    • NOT_PRESENT
      Not Present
    • VIRTUAL_PRESENT
      Virtual Present
    • PHYSICAL_PRESENT
      Physical Present
  • deliveryDecisionMadeOn
    DateTime Read-only
    This date and time when the decision was made as to whether the order should be shipped.
  • deviceSessionIdentifier
    String Read-only
    Allows to link the transaction to the data collected from the customer's device.
  • emailsDisabled
    Boolean Read-only
    Whether email sending is deactivated for the transaction. Default is false.
  • endOfLife
    DateTime Read-only
    The date and time when the transaction reaches its end of live. No further actions can be carried out at this time.
  • environment
    Enum Read-only
    • LIVE
      Live
    • PREVIEW
      Preview
  • environmentSelectionStrategy
    Enum Read-only
    The strategy for determining whether the transaction is to be processed in the test or production environment.
    • FORCE_TEST_ENVIRONMENT
      Force Test Environment
    • FORCE_PRODUCTION_ENVIRONMENT
      Force Production Environment
    • USE_CONFIGURATION
      Use Configuration
  • failedOn
    DateTime Read-only
    The date and time when the transaction failed.
  • failedUrl
    String Read-only
    The URL to redirect the customer back to after they canceled or failed to authenticated their payment.
  • failureReason
    Failure Reason Read-only
    The reason for the failure of the transaction.
  • group
    Transaction Group Expandable Read-only
    The group that the transaction belongs to.
  • id
    Long Read-only
    A unique identifier for the object.
  • internetProtocolAddress
    String Read-only
    The IP address of the customer's device.
  • internetProtocolAddressCountry
    String Read-only
    The country determined from the IP address of the customer's device.
  • invoiceMerchantReference
    String Read-only
    The merchant's reference used to identify the invoice.
  • javaEnabled
    Boolean Read-only
    Whether Java is enabled on the customer's web browser.
  • language
    String Read-only
    The language that is linked to the object.
  • lineItems
    Collection of Line Item Expandable Read-only
    The line items purchased by the customer.
  • linkedSpaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • merchantReference
    String Read-only
    The merchant's reference used to identify the transaction.
  • metaData
    Map of String String Read-only
    Allow to store additional information about the object.
  • parent
    Transaction Expandable Read-only
    The parent transaction which was (partially) replaced by this transaction.
  • paymentConnectorConfiguration
    Payment Connector Configuration Expandable Read-only
    The payment connector configuration that was used to authorize the transaction.
  • plannedPurgeDate
    DateTime Read-only
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • processingOn
    DateTime Read-only
    The date and time when the processing of the transaction was started.
  • refundedAmount
    Decimal Read-only
    The total amount that was refunded, in the transaction's currency.
  • screenColorDepth
    String Read-only
    The screen color depth of the customer's web browser.
  • screenHeight
    String Read-only
    The screen height of the customer's web browser.
  • screenWidth
    String Read-only
    The screen width of the customer's web browser.
  • shippingAddress
    Address Expandable Read-only
    The address to where the order will be shipped.
  • shippingMethod
    String Read-only
    The name of the shipping method used to ship the products.
  • spaceViewId
    Long
    Space View
    Read-only
    The ID of the space view this object is linked to.
  • state
    Enum Read-only
    The object's current state.
    • CREATE
      Create
    • PENDING
      Pending
    • CONFIRMED
      Confirmed
    • PROCESSING
      Processing
    • FAILED
      Failed
    • AUTHORIZED
      Authorized
    • VOIDED
      Voided
    • COMPLETED
      Completed
    • FULFILL
      Fulfill
    • DECLINE
      Decline
  • successUrl
    String Read-only
    The URL to redirect the customer back to after they successfully authenticated their payment.
  • terminal
    Payment Terminal Expandable Read-only
    The payment terminal through which the payment was processed.
  • timeZone
    String Read-only
    The customer's time zone, which affects how dates and times are formatted when communicating with the customer.
  • token
    Payment Token Expandable Read-only
    The payment token that should be used to charge the customer.
  • tokenizationMode
    Enum Read-only
    The tokenization mode specifies whether and how the tokenization of payment information is applied to the transaction.
    • 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
  • totalAppliedFees
    Decimal Read-only
    The total of all fees charged, in the transaction's currency.
  • totalSettledAmount
    Decimal Read-only
    The total amount that was settled, in the transaction's currency.
  • userAgentHeader
    String Read-only
    The 'User Agent' header of the customer's web browser.
  • userFailureMessage
    String Read-only
    The message that can be displayed to the customer explaining why the transaction failed, in the customer's language.
  • userInterfaceType
    Enum Read-only
    The type of user interface the customer used to provide the payment information.
    • IFRAME
      Iframe
    • LIGHTBOX
      Lightbox
    • PAYMENT_PAGE
      Payment Page
    • MOBILE_SDK
      Mobile Sdk
    • TERMINAL
      Terminal
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.
  • windowHeight
    String Read-only
    The window height of the customer's web browser.
  • windowWidth
    String Read-only
    The window width of the customer's web browser.
  • yearsToKeep
    Integer Read-only
    The number of years the transaction is kept after its authorization.

11.9.62.2Transaction Client Platform Information Details

Properties
  • id
    Long Read-only
    A unique identifier for the object.
  • integrationType
    String Read-only
    The type of integration that was used to collect the payment information.
  • osVersion
    String Read-only
    The version of the operating system that was used to collect the payment information.
  • platformType
    String Read-only
    The type of platform that was used to collect the payment information, e.g. Android or iOS.
  • sdkVersion
    String Read-only
    The type of the SDK that was used to collect the payment information.
  • spaceId
    Long Read-only
    The ID of the space this object belongs to.
  • transaction
    Long
    Transaction
    Read-only
    The transaction that is associated with the client platform information.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.9.62.3Transaction Group Details

Properties
  • beginDate
    DateTime Read-only
    The date and time when the initial transaction in the group was created.
  • customerId
    String Read-only
    The unique identifier of the customer in the external system.
  • endDate
    DateTime Read-only
    The date and time when the final transaction in the group was last updated.
  • id
    Long Read-only
    A unique identifier for the object.
  • linkedSpaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • plannedPurgeDate
    DateTime Read-only
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • state
    Enum Read-only
    The object's current state.
    • PENDING
      Pending
    • FAILED
      Failed
    • SUCCESSFUL
      Successful
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.10Tax

11.10.1Tax Details

Properties
  • rate
    Decimal Read-only
    The tax rate to be applied.
  • title
    String Read-only
    The name of the tax.

11.11User

11.11.1Application User Details

Properties
  • id
    Long Read-only
    A unique identifier for the object.
  • name
    String Read-only
    The name used to identify the application user.
  • plannedPurgeDate
    DateTime Read-only
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • primaryAccount
    Long
    Account
    Read-only
    The primary account that the user belongs to.
  • requestLimit
    Long Read-only
    The maximum number of API requests that are accepted every 2 minutes.
  • scope
    Long
    Scope
    Read-only
    The scope that the user belongs to.
  • state
    Enum Read-only
    The object's current state.
    • CREATE
      Create
    • ACTIVE
      Active
    • INACTIVE
      Inactive
    • DELETING
      Deleting
    • DELETED
      Deleted
  • userType
    Enum Read-only
    The user's type which defines its role and capabilities.
    • HUMAN_USER
      Human User
    • SINGLE_SIGNON_USER
      Single Signon User
    • APPLICATION_USER
      Application User
    • ANONYMOUS_USER
      Anonymous User
    • SERVER_USER
      Server User
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.11.2Application User Mac Key Details

Properties
  • creationTime
    DateTime Read-only
    The date and time when the object was created.
  • id
    Long Read-only
    A unique identifier for the object.
  • state
    Enum Read-only
    The object's current state.
    • GENERATED
      Generated
    • ACTIVE
      Active
    • INACTIVE
      Inactive

11.11.3Human User Details

Properties
  • emailAddress
    String Read-only
    The user's email address.
  • emailAddressVerified
    Boolean Read-only
    Whether the user's email address has been verified.
  • firstname
    String Read-only
    The user's first name.
  • id
    Long Read-only
    A unique identifier for the object.
  • language
    String Read-only
    The user's preferred language.
  • lastname
    String Read-only
    The user's last name.
  • mobilePhoneNumber
    String Read-only
    The user's mobile phone number.
  • mobilePhoneVerified
    Boolean Read-only
    Whether the user's mobile phone number has been verified.
  • plannedPurgeDate
    DateTime Read-only
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • primaryAccount
    Long
    Account
    Read-only
    The primary account that the user belongs to.
  • scope
    Long
    Scope
    Read-only
    The scope that the user belongs to.
  • state
    Enum Read-only
    The object's current state.
    • CREATE
      Create
    • ACTIVE
      Active
    • INACTIVE
      Inactive
    • DELETING
      Deleting
    • DELETED
      Deleted
  • timeZone
    String Read-only
    The user's time zone. If none is specified, the one provided by the browser will be used.
  • twoFactorEnabled
    Boolean Read-only
    Whether two-factor authentication is enabled for this user.
  • twoFactorType
    Two Factor Authentication Type Expandable Read-only
    The type of two-factor authentication that is enabled for the user.
  • userType
    Enum Read-only
    The user's type which defines its role and capabilities.
    • HUMAN_USER
      Human User
    • SINGLE_SIGNON_USER
      Single Signon User
    • APPLICATION_USER
      Application User
    • ANONYMOUS_USER
      Anonymous User
    • SERVER_USER
      Server User
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.11.4Permission Details

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

11.11.5Role Details

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

11.11.6Single Sign-On Provider Details

Properties
  • id
    Long Read-only
    A unique identifier for the object.
  • name
    String Read-only
    The name used to identify the provider.
  • plannedPurgeDate
    DateTime Read-only
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • scope
    Scope Read-only
    The scope that the provider belongs to.
  • signInUrl
    String Read-only
    The URL where the user will be redirected to sign in.
  • state
    Enum Read-only
    The object's current state.
    • CREATE
      Create
    • ACTIVE
      Active
    • INACTIVE
      Inactive
    • DELETING
      Deleting
    • DELETED
      Deleted
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.11.7Single Sign-On User Details

Properties
  • firstname
    String Read-only
    The user's first name.
  • id
    Long Read-only
    A unique identifier for the object.
  • language
    String Read-only
    The user's preferred language.
  • lastname
    String Read-only
    The user's last name.
  • plannedPurgeDate
    DateTime Read-only
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • primaryAccount
    Long
    Account
    Read-only
    The primary account that the user belongs to.
  • provider
    Long
    Single Sign-On Provider
    Read-only
    The single sign-on provider that this user belongs to.
  • scope
    Long
    Scope
    Read-only
    The scope that the user belongs to.
  • state
    Enum Read-only
    The object's current state.
    • CREATE
      Create
    • ACTIVE
      Active
    • INACTIVE
      Inactive
    • DELETING
      Deleting
    • DELETED
      Deleted
  • timeZone
    String Read-only
    The user's time zone. If none is specified, the one provided by the browser will be used.
  • userType
    Enum Read-only
    The user's type which defines its role and capabilities.
    • HUMAN_USER
      Human User
    • SINGLE_SIGNON_USER
      Single Signon User
    • APPLICATION_USER
      Application User
    • ANONYMOUS_USER
      Anonymous User
    • SERVER_USER
      Server User
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.11.8Two Factor Authentication Type Details

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

11.11.9User Details

Properties
  • id
    Long Read-only
    A unique identifier for the object.
  • plannedPurgeDate
    DateTime Read-only
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • scope
    Long
    Scope
    Read-only
    The scope that the user belongs to.
  • state
    Enum Read-only
    The object's current state.
    • CREATE
      Create
    • ACTIVE
      Active
    • INACTIVE
      Inactive
    • DELETING
      Deleting
    • DELETED
      Deleted
  • userType
    Enum Read-only
    The user's type which defines its role and capabilities.
    • HUMAN_USER
      Human User
    • SINGLE_SIGNON_USER
      Single Signon User
    • APPLICATION_USER
      Application User
    • ANONYMOUS_USER
      Anonymous User
    • SERVER_USER
      Server User
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.11.10User Account Role Details

Properties
  • account
    Long
    Account
    Read-only
    The account in which the role is assigned to the user.
  • appliesOnSubAccount
    Boolean Read-only
    Whether the role is assigned to the user in subaccounts only.
  • id
    Long Read-only
    A unique identifier for the object.
  • role
    Long
    Role
    Read-only
    The role that is assigned to the user.
  • user
    Long
    User
    Read-only
    The user whose role this defines.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.11.11User Space Role Details

Properties
  • id
    Long Read-only
    A unique identifier for the object.
  • role
    Long
    Role
    Read-only
    The role that is assigned to the user.
  • space
    Long
    Space
    Read-only
    The space in which the role is assigned to the user.
  • user
    Long
    User
    Read-only
    The user whose role this defines.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.12User Interface

11.12.1Navigation Entry Details

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

11.12.2Saved View Details

Properties
  • contextId
    Long Read-only
    The ID of the context (scope, account, space) the saved view belongs to.
  • createdOn
    DateTime Read-only
    The date and time when the object was created.
  • id
    Long Read-only
    A unique identifier for the object.
  • name
    String Read-only
    The name used to identify the saved view.
  • navigationEntry
    Long
    Navigation Entry
    Read-only
    The navigation entry that represents the web page holding the table.
  • query
    String Read-only
    The query that defines the applied filters, sort order and visible columns of the table.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.13Web App

11.13.1Web App Confirmation Response Details

The confirmation response provides details about the installation of the web app.

Properties
  • access_token
    String Read-only
    The access code granting permissions to the web service API according to the OAuth standard.
  • scope
    String Read-only
    The list of the permissions granted to the web app within the space.
  • space
    Space Expandable Read-only
    The space that the web app was installed in.
  • state
    String Read-only
    The state parameter that was provided in the authorization request.
  • token_type
    String Read-only
    The type of the access token that determines the authentication mechanism to use for accessing the web service API.

11.14Webhook

11.14.1Webhook Identity Details

The webhook identity represents a set of keys that will be used to sign the webhook messages.

Properties
  • id
    Long Read-only
    A unique identifier for the object.
  • linkedSpaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • name
    String Read-only
    The name used to identify the webhook identity.
  • plannedPurgeDate
    DateTime Read-only
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • state
    Enum Read-only
    The object's current state.
    • CREATE
      Create
    • ACTIVE
      Active
    • INACTIVE
      Inactive
    • DELETING
      Deleting
    • DELETED
      Deleted
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.14.2Webhook Listener Details

Properties
  • enablePayloadSignatureAndState
    Boolean Read-only
    Whether signature header and 'state' property are enabled in webhook payload.
  • entity
    Long
    Webhook Listener Entity
    Read-only
    The entity that is to be monitored.
  • entityStates
    Collection of String Read-only
    The entity's target states that are to be monitored.
  • id
    Long Read-only
    A unique identifier for the object.
  • identity
    Webhook Identity Read-only
    The identity used to sign messages.
  • linkedSpaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • name
    String Read-only
    The name used to identify the webhook listener.
  • notifyEveryChange
    Boolean Read-only
    Whether every update of the entity or only state changes are to be monitored.
  • plannedPurgeDate
    DateTime Read-only
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • state
    Enum Read-only
    The object's current state.
    • CREATE
      Create
    • ACTIVE
      Active
    • INACTIVE
      Inactive
    • DELETING
      Deleting
    • DELETED
      Deleted
  • url
    Webhook URL Read-only
    The URL where notifications about entity changes are sent to.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.14.3Webhook Listener Entity Details

Properties
  • id
    Long Read-only
    A unique identifier for the object.
  • name
    Map of String String Expandable Read-only
    The name used to identify the webhook listener entity.
  • technicalName
    String Read-only
    The name used to programmatically identify the webhook listener entity.

11.14.4Webhook URL Details

Properties
  • applicationManaged
    Boolean Read-only
    Whether the webhook URL is managed by the application, and therefore cannot be changed via the user interface.
  • id
    Long Read-only
    A unique identifier for the object.
  • linkedSpaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • name
    String Read-only
    The name used to identify the webhook URL.
  • plannedPurgeDate
    DateTime Read-only
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • state
    Enum Read-only
    The object's current state.
    • CREATE
      Create
    • ACTIVE
      Active
    • INACTIVE
      Inactive
    • DELETING
      Deleting
    • DELETED
      Deleted
  • url
    String Read-only
    The actual URL where notifications about entity changes are sent to.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.