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.1.1Analytics Queries (Analytics2)

10.1.1.1.1List all query executions
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
    A cursor for pagination, specifies the number of query executions to skip.
  • limit
    Integer Required
    QUERY
    A limit on the number of query executions to be returned, between 1 and 100. Default is 100.
Responses
10.1.1.1.2Retrieve a query execution

Queries are processed asynchronously and may take several minutes to complete. Avoid frequent requests, as they will not speed up processing.

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

97 seconds

Parameters
  • queryToken
    String Required
    PATH
    Identifies the query execution.
  • account
    Long Required
    HEADER
    Specifies the ID of the account the operation should be executed in.
Responses
  • 200 OK
    Submitted Analytics Query Execution
    The query execution has successfully completed processing and reached its final status.
  • 202 Accepted
    Submitted Analytics Query Execution
    The query execution is still being processed, retry after the time specified in the "Retry-After" header.
    Headers
    • Retry-After
      Integer
      Specifies the number of seconds to wait before checking the status again.
10.1.1.1.3Generate a temporary URL to download the query result

Generate a short-lived (5-minute) URL for downloading the Analytics query result file. Note that each URL generation is counted as a potential download and will be billed accordingly. Do not use this endpoint for periodic checks of file availability. Instead, use the 'Retrieve a query execution' endpoint for status checks.

GET /api/v2.0/analytics/queries/{queryToken}/result View in Client
Parameters
  • queryToken
    String Required
    PATH
    Identifies the query execution.
  • account
    Long Required
    HEADER
    Specifies the ID of the account the operation should be executed in.
Responses
  • 200 OK
    String
    A short-lived (5-minute) URL for downloading the Analytics query result file is returned.
  • 202 Accepted
    No response body.
    The result is not currently available and is expected to be provided at a later time.
  • 204 No Content
    No response body.
    No data was returned from the query. This could indicate that the query was either canceled or encountered an error during execution.
  • 404 Not Found
    No response body.
    No query execution found for the given token.
10.1.1.1.4Submit a query execution
POST /api/v2.0/analytics/queries/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
Responses
10.1.1.1.5Cancel a query execution
DELETE /api/v2.0/analytics/queries/{queryToken} View in Client
Parameters
  • queryToken
    String Required
    PATH
    Identifies the query execution.
  • account
    Long Required
    HEADER
    Specifies the ID of the account the operation should be executed in.
Responses
  • 204 No Content
    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.2Consumed Resources

10.2.1.2.1List consumed resources
GET /api/v2.0/spaces/consumed-resources View in Client
Parameters
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • startDate
    DateTime Required
    QUERY
    The start date of the period for which the consumed resources are to be returned.
  • endDate
    DateTime Required
    QUERY
    The end date of the period for which the consumed resources are to be returned.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.2.1.3Spaces

10.2.1.3.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.3.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.3.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.3.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.3.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.3.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.1.1Customer Addresses

10.3.1.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.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.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.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.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.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.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.1.2Customer Comments

10.3.1.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.1.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.1.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.1.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.1.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.1.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.1.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.1.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.1.3Customers

10.3.1.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.1.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.1.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.1.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.1.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.1.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.1.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.1.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.1.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.1.3.10Delete a customer

Permanently deletes a customer. It cannot be undone.

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.1.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.1.1Document Template Types

10.4.1.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.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.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.1.2Document Templates

10.4.1.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.1.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.1.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.1.1Countries

10.5.1.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.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.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.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.1.5List all country states
GET /api/v2.0/countries/states View in Client
Responses
10.5.1.1.6Retrieve a country state
GET /api/v2.0/countries/states/{id} View in Client
Parameters
  • id
    String Required
    PATH
Responses

10.5.1.2Currencies

10.5.1.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.1.2.2Retrieve a currency
GET /api/v2.0/currencies/{code} View in Client
Parameters
  • code
    String Required
    PATH
Responses
10.5.1.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.1.3Languages

10.5.1.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.1.3.2Retrieve a language
GET /api/v2.0/languages/{code} View in Client
Parameters
  • code
    String Required
    PATH
Responses
10.5.1.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.1.4Legal Organization Forms

10.5.1.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.1.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.1.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.1.1Label Descriptors

10.6.1.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.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.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.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.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.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.1.2Static Values

10.6.1.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.1.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.1.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.1.1Manual Tasks

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

10.8.1.1Bank Accounts

10.8.1.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.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.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.1.2Bank Transactions

10.8.1.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.1.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.1.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.1.3Charge Bank Transactions

10.8.1.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.1.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.1.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.1.4Currency Bank Accounts

10.8.1.4.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.1.4.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.1.4.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.1.5External Transfer Bank Transactions

10.8.1.5.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.1.5.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.1.5.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.1.6Internal Transfer Bank Transactions

10.8.1.6.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.1.6.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.1.6.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.1.7Refund Bank Transactions

10.8.1.7.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.1.7.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.1.7.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.1.8Refund Recovery Bank Transactions

10.8.1.8.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.1.8.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.1.8.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.2Base

10.8.2.1Payment Connector Configurations

10.8.2.1.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.2.1.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.2.1.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.2.1.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.2.1.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.2.1.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.2.2Payment Connectors

10.8.2.2.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.2.2.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.2.2.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.2.3Payment Method Brands

10.8.2.3.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.2.3.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.2.3.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.2.4Payment Method Configurations

10.8.2.4.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.2.4.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.2.4.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.2.4.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 Create
JSON Required
Responses
10.8.2.4.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 Update
JSON Required
Responses
10.8.2.4.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.2.5Payment Methods

10.8.2.5.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.2.5.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.2.5.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.2.6Payment Processor Configurations

10.8.2.6.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.2.6.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.2.6.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.2.6.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
Payment Processor Configuration Create
JSON Required
Responses
10.8.2.6.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
Payment Processor Configuration Active
JSON Required
Responses
10.8.2.6.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.2.7Payment Processors

10.8.2.7.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.2.7.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.2.7.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.3Charge

10.8.3.1Charge Attempts

10.8.3.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.3.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.3.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.3.2Charge Flow Levels

10.8.3.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.3.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.3.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.3.2.4Send a payment link
POST /api/v2.0/payment/charge-flows/levels/{id}/send-message 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
    No response body.

10.8.3.3Charge Flows

10.8.3.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.3.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.3.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.3.4Charge Flows Level Payment Links

10.8.3.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.3.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.3.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.3.5Sales Channels

10.8.3.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.3.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.3.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.4Condition

10.8.4.1Condition Types

10.8.4.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.4.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.4.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.5Payment Link

10.8.5.1Payment Links

10.8.5.1.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.5.1.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.5.1.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.5.1.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 Create
JSON Required
Responses
10.8.5.1.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 Update
JSON Required
Responses
10.8.5.1.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.6Terminal

10.8.6.1Terminals

10.8.6.1.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.6.1.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.6.1.3Retrieve till connection credentials
GET /api/v2.0/payment/terminals/{id}/till-connection-credentials View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • transactionId
    Long Required
    QUERY
  • language
    String
    QUERY
Responses
  • 200 OK
    String
10.8.6.1.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.6.1.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
Terminal Create
JSON Required
Responses
10.8.6.1.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
Responses
  • 204 No Content
    No response body.
10.8.6.1.7Perform a payment terminal transaction

Initiates a payment terminal transaction and waits for its completion. If a timeout occurs, retrying will resume the transaction from where it left off.

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

90 seconds

Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • transactionId
    Long Required
    QUERY
  • language
    String
    QUERY
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses
10.8.6.1.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.6.1.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.6.1.10Perform a payment terminal transaction by identifier

Initiates a payment terminal transaction and waits for its completion. If a timeout occurs, retrying will resume the transaction from where it 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 unique identifier of the terminal.
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • transactionId
    Long Required
    QUERY
  • language
    String
    QUERY
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses
10.8.6.1.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.6.1.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
Terminal Update
JSON Required
Responses
10.8.6.1.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.7Token

10.8.7.1Token Versions

10.8.7.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.7.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.7.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.7.2Tokens

10.8.7.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.7.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.7.2.3Retrieve the active token version
GET /api/v2.0/payment/tokens/{id}/active-version 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.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.7.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
Token . Create Create
JSON Required
Responses
10.8.7.2.6Create a transaction for token update
POST /api/v2.0/payment/tokens/{id}/create-transaction-for-token-update 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.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
Token . Update Update
JSON Required
Responses
10.8.7.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.8Transaction

10.8.8.1Client Platforms

10.8.8.1.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.8.1.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.8.1.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.8.2Completions

10.8.8.2.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.8.2.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.8.2.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.8.3Delivery Indications

10.8.8.3.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.8.3.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.8.3.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.8.3.4Mark a delivery indication as not suitable.
POST /api/v2.0/payment/delivery-indications/{id}/mark-not-suitable 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.3.5Mark a delivery indication as suitable.
POST /api/v2.0/payment/delivery-indications/{id}/mark-suitable 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.4Invoice Comments

10.8.8.4.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.8.4.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.8.4.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.8.4.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.8.4.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.8.4.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.8.4.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.8.4.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.8.5Invoices

10.8.8.5.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.8.5.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.8.5.3Check if a transaction invoice can be replaced
GET /api/v2.0/payment/transactions/invoices/{id}/check-replacement-possible 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
    Boolean
10.8.8.5.4Retrieve an invoice document
GET /api/v2.0/payment/transactions/invoices/{id}/document View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • targetMediaTypeId
    Long
    QUERY
Responses
10.8.8.5.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.8.5.6Derecognize a transaction invoice
POST /api/v2.0/payment/transactions/invoices/{id}/derecognize 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.5.7Mark a transaction invoice as paid
POST /api/v2.0/payment/transactions/invoices/{id}/mark-paid 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.5.8Replace a transaction invoice
POST /api/v2.0/payment/transactions/invoices/{id}/replace 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
Invoice Replacement
JSON Required
Responses

10.8.8.6Line Item Versions

10.8.8.6.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.8.6.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.8.6.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.8.6.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
Line Item Version Create
JSON Required
Responses

10.8.8.7Refund Comments

10.8.8.7.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.8.7.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.8.7.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.8.7.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.8.7.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.8.7.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.8.7.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.8.7.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.8.8Refunds

10.8.8.8.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.8.8.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.8.8.3Retrieve a refund document
GET /api/v2.0/payment/refunds/{id}/document View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • targetMediaTypeId
    Long
    QUERY
Responses
10.8.8.8.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.8.8.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.8.8.6Mark a refund as failed
POST /api/v2.0/payment/refunds/{id}/mark-failed 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.8.7Mark a refund as successful
POST /api/v2.0/payment/refunds/{id}/mark-succeeded 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.9Transaction Comments

10.8.8.9.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.8.9.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.8.9.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.8.9.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.8.9.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.8.9.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.8.9.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.8.9.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.8.10Transaction Voids

10.8.8.10.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.8.10.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.8.10.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.8.8.11Transactions

10.8.8.11.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.8.11.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.8.11.3Retrieve a charge flow payment page URL
GET /api/v2.0/payment/transactions/{id}/charge-flow/payment-page-url 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.8.8.11.4Check if token can be created
GET /api/v2.0/payment/transactions/{id}/check-token-creation-possible 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
    Boolean
10.8.8.11.5Retrieve transaction credentials

Generates temporary transaction credentials to delegate access to the REST API for the specified transaction.

GET /api/v2.0/payment/transactions/{id}/credentials 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.8.8.11.6Retrieve an iFrame JavaScript URL
GET /api/v2.0/payment/transactions/{id}/iframe-javascript-url 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.8.8.11.7Retrieve an invoice document
GET /api/v2.0/payment/transactions/{id}/invoice-document View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • targetMediaTypeId
    Long
    QUERY
Responses
10.8.8.11.8Retrieve the latest line item version
GET /api/v2.0/payment/transactions/{id}/latest-line-item-version 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.11.9Retrieve a Lightbox JavaScript URL
GET /api/v2.0/payment/transactions/{id}/lightbox-javascript-url 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.8.8.11.10Retrieve a packing slip document
GET /api/v2.0/payment/transactions/{id}/packing-slip-document View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • targetMediaTypeId
    Long
    QUERY
Responses
10.8.8.11.11List available payment method configurations
GET /api/v2.0/payment/transactions/{id}/payment-method-configurations View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • integrationMode
    String Required
    QUERY
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses
10.8.8.11.12Retrieve a payment page URL
GET /api/v2.0/payment/transactions/{id}/payment-page-url 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.8.8.11.13List terminal receipts
GET /api/v2.0/payment/transactions/{id}/terminal-receipts View in Client
Parameters
  • id
    Long Required
    PATH
  • 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.8.11.14Retrieve a transaction by credentials
GET /api/v2.0/payment/transactions/by-credentials/{credentials} View in Client
Parameters
  • credentials
    String Required
    PATH
    Identifies the transaction and includes the security details required to authorize access to 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.8.11.15Retrieve a Mobile SDK URL by credentials
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.8.11.16List one-click tokens by credentials
GET /api/v2.0/payment/transactions/by-credentials/{credentials}/one-click-tokens View in Client
Parameters
  • credentials
    String Required
    PATH
    Identifies the transaction and includes the security details required to authorize access to 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.8.11.17List available payment method configurations by credentials
GET /api/v2.0/payment/transactions/by-credentials/{credentials}/payment-method-configurations View in Client
Parameters
  • credentials
    String Required
    PATH
    Identifies the transaction and includes the security details required to authorize access to this operation.
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • integrationMode
    String Required
    QUERY
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses
10.8.8.11.18Export transactions
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.8.11.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.8.11.20Create a 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
Responses
10.8.8.11.21Process a transaction via charge flow
POST /api/v2.0/payment/transactions/{id}/charge-flow/apply 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.11.22Cancel a charge flow
POST /api/v2.0/payment/transactions/{id}/charge-flow/cancel 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.11.23Update a charge flow recipient
POST /api/v2.0/payment/transactions/{id}/charge-flow/update-recipient View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • type
    Long Required
    QUERY
  • recipient
    String Required
    QUERY
Responses
  • 204 No Content
    No response body.
10.8.8.11.24Complete a transaction offline
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.8.11.25Complete a transaction online
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.8.11.26Complete a transaction offline partially
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
Completion Details
JSON Required
Responses
10.8.8.11.27Complete a transaction online partially
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
Completion Details
JSON Required
Responses
10.8.8.11.28Confirm a transaction
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
Responses
10.8.8.11.29Process a card transaction
POST /api/v2.0/payment/transactions/{id}/process-card-details 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
Authenticated Card Request
JSON Required
Responses
10.8.8.11.30Process a card transaction with 3-D Secure

Processes the transaction using the provided card details, potentially utilizing 3-D Secure. Returns a URL where the buyer must be redirected to complete the transaction.

POST /api/v2.0/payment/transactions/{id}/process-card-details-threed View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
Request Body
Tokenized Card Request
JSON Required
Responses
  • 200 OK
    String
10.8.8.11.31Process a transaction via token
POST /api/v2.0/payment/transactions/{id}/process-with-token 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.11.32Process a transaction without user-interaction
POST /api/v2.0/payment/transactions/{id}/process-without-interaction 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.11.33Void a transaction offline
POST /api/v2.0/payment/transactions/{id}/void-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.8.11.34Void a transaction online
POST /api/v2.0/payment/transactions/{id}/void-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.8.11.35Process via one-click token by credentials

Assigns the provided token to the transaction, processes it, and returns a URL for customer redirection 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 includes the security details required to authorize access to this operation.
  • 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.8.8.11.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.8.11.37Delete a one-click token by 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 includes the security details required to authorize access to this operation.
  • 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.9Subscription

10.9.1.1Ledger Entries

10.9.1.1.1List all ledger entries
GET /api/v2.0/subscriptions/ledger-entries 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.9.1.1.2Retrieve a ledger entry
GET /api/v2.0/subscriptions/ledger-entries/{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.9.1.1.3Search ledger entries
GET /api/v2.0/subscriptions/ledger-entries/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.9.1.1.4Create a ledger entry
POST /api/v2.0/subscriptions/ledger-entries 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
Subscription Ledger Entry Create
JSON Required
Responses

10.9.1.2Subscribers

10.9.1.2.1List all subscribers
GET /api/v2.0/subscriptions/subscribers 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.9.1.2.2Retrieve a subscriber
GET /api/v2.0/subscriptions/subscribers/{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.9.1.2.3Search subscribers
GET /api/v2.0/subscriptions/subscribers/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.9.1.2.4Create a subscriber
POST /api/v2.0/subscriptions/subscribers 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
Subscriber . Create Create
JSON Required
Responses
10.9.1.2.5Update a subscriber
PATCH /api/v2.0/subscriptions/subscribers/{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
Subscriber . Update Update
JSON Required
Responses
10.9.1.2.6Delete a subscriber
DELETE /api/v2.0/subscriptions/subscribers/{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.9.1.3Subscription Affiliates

10.9.1.3.1List all affiliates
GET /api/v2.0/subscriptions/affiliates 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.9.1.3.2Retrieve an affiliate
GET /api/v2.0/subscriptions/affiliates/{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.9.1.3.3Search affiliates
GET /api/v2.0/subscriptions/affiliates/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.9.1.3.4Create an affiliate
POST /api/v2.0/subscriptions/affiliates 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
Subscription Affiliate Create
JSON Required
Responses
10.9.1.3.5Update an affiliate
PATCH /api/v2.0/subscriptions/affiliates/{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
Subscription Affiliate Update
JSON Required
Responses
10.9.1.3.6Delete an affiliate
DELETE /api/v2.0/subscriptions/affiliates/{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.9.1.4Subscription Charges

10.9.1.4.1List all charges
GET /api/v2.0/subscriptions/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.9.1.4.2Retrieve a charge
GET /api/v2.0/subscriptions/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.9.1.4.3Search charges
GET /api/v2.0/subscriptions/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.9.1.4.4Create a charge
POST /api/v2.0/subscriptions/charges 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
Subscription Charge . Create Create
JSON Required
Responses
10.9.1.4.5Discard a charge
POST /api/v2.0/subscriptions/charges/{id}/discard 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.9.1.5Subscription Period Bills

10.9.1.5.1List all subscription period bills
GET /api/v2.0/subscriptions/period-bills 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.9.1.5.2Retrieve a subscription period bill
GET /api/v2.0/subscriptions/period-bills/{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.9.1.5.3Search subscription period bills
GET /api/v2.0/subscriptions/period-bills/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.9.1.5.4Close a subscription period bill
POST /api/v2.0/subscriptions/period-bills/{id}/close View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • currentDate
    DateTime Required
    QUERY
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses

10.9.1.6Subscription Versions

10.9.1.6.1List all subscription versions
GET /api/v2.0/subscriptions/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.9.1.6.2Retrieve a subscription version
GET /api/v2.0/subscriptions/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.9.1.6.3Search subscription versions
GET /api/v2.0/subscriptions/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.9.1.7Subscriptions

10.9.1.7.1List all subscriptions
GET /api/v2.0/subscriptions 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.9.1.7.2Retrieve a subscription
GET /api/v2.0/subscriptions/{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.9.1.7.3Search subscription invoices
GET /api/v2.0/subscriptions/{id}/invoices 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.
  • 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.1.7.4Search subscriptions
GET /api/v2.0/subscriptions/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.9.1.7.5Create a subscription
POST /api/v2.0/subscriptions 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
Subscription Creation Request
JSON Required
Responses
10.9.1.7.6Apply changes to a subscription
POST /api/v2.0/subscriptions/{id}/apply-changes 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
Subscription Update Request
JSON Required
Responses
10.9.1.7.7Initialize a subscription
POST /api/v2.0/subscriptions/{id}/initialize 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.9.1.7.8Initialize a subscription with the subscriber present
POST /api/v2.0/subscriptions/{id}/initialize-subscriber-present 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
Subscription Initialization Request
JSON Required
Responses
10.9.1.7.9Reactivate a suspended subscription
POST /api/v2.0/subscriptions/{id}/reactivate 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.9.1.7.10Suspend a subscription
POST /api/v2.0/subscriptions/{id}/suspend 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
Suspension Request
JSON Required
Responses
10.9.1.7.11Terminate a subscription
POST /api/v2.0/subscriptions/{id}/terminate View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • respectTerminationPeriod
    Boolean Required
    QUERY
    Whether the product's termination period should be respected.
Responses
  • 204 No Content
    No response body.
10.9.1.7.12Upgrade a subscription's product
POST /api/v2.0/subscriptions/{id}/upgrade-product View in Client
Parameters
  • id
    Long Required
    PATH
  • space
    Long Required
    HEADER
    Specifies the ID of the space the operation should be executed in.
  • respectTerminationPeriod
    Boolean Required
    QUERY
    Whether the product's termination period should be respected.
  • expand
    Collection of String
    QUERY
    Specifies the fields that should be expanded in the response, see Expanding Responses.
Responses
10.9.1.7.13Update a subscription
PATCH /api/v2.0/subscriptions/{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
Subscription Update Request
JSON Required
Responses

10.9.2Metric

10.9.2.1Metric Usage Reports

10.9.2.1.1List all metric usage reports
GET /api/v2.0/subscriptions/metric-usage-reports 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.9.2.1.2Retrieve a metric usage report
GET /api/v2.0/subscriptions/metric-usage-reports/{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.9.2.1.3Search metric usage reports
GET /api/v2.0/subscriptions/metric-usage-reports/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.9.2.1.4Create a metric usage report
POST /api/v2.0/subscriptions/metric-usage-reports 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
Metric Usage Report Create
JSON Required
Responses

10.9.2.2Metrics

10.9.2.2.1List all metrics
GET /api/v2.0/subscriptions/metrics 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.9.2.2.2Retrieve a metric
GET /api/v2.0/subscriptions/metrics/{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.9.2.2.3Search metrics
GET /api/v2.0/subscriptions/metrics/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.9.2.2.4Create a metric
POST /api/v2.0/subscriptions/metrics 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
Metric Create
JSON Required
Responses
10.9.2.2.5Update a metric
PATCH /api/v2.0/subscriptions/metrics/{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
Metric Active
JSON Required
Responses
10.9.2.2.6Delete a metric
DELETE /api/v2.0/subscriptions/metrics/{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.9.3Product

10.9.3.1Product Component Groups

10.9.3.1.1List all component groups
GET /api/v2.0/subscriptions/products/component-groups 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.9.3.1.2Retrieve a component group
GET /api/v2.0/subscriptions/products/component-groups/{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.9.3.1.3Search component groups
GET /api/v2.0/subscriptions/products/component-groups/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.9.3.1.4Create a component group
POST /api/v2.0/subscriptions/products/component-groups 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
Product Component Group Update
JSON Required
Responses
10.9.3.1.5Update a component group
PATCH /api/v2.0/subscriptions/products/component-groups/{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
Product Component Group Update
JSON Required
Responses
10.9.3.1.6Delete a component group
DELETE /api/v2.0/subscriptions/products/component-groups/{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.9.3.2Product Components

10.9.3.2.1List all components
GET /api/v2.0/subscriptions/products/components 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.9.3.2.2Retrieve a component
GET /api/v2.0/subscriptions/products/components/{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.9.3.2.3Search components
GET /api/v2.0/subscriptions/products/components/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.9.3.2.4Create a component
POST /api/v2.0/subscriptions/products/components 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
Product Component Update
JSON Required
Responses
10.9.3.2.5Update a component
PATCH /api/v2.0/subscriptions/products/components/{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
Product Component Update
JSON Required
Responses
10.9.3.2.6Delete a component
DELETE /api/v2.0/subscriptions/products/components/{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.9.3.3Product Metered Fee Tiers

10.9.3.3.1List all metered fee tiers
GET /api/v2.0/subscriptions/products/metered-fees/{feeId}/tiers View in Client
Parameters
  • feeId
    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.9.3.3.2Retrieve a metered fee tier
GET /api/v2.0/subscriptions/products/metered-fees/{feeId}/tiers/{id} View in Client
Parameters
  • feeId
    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.9.3.3.3Search metered fee tiers
GET /api/v2.0/subscriptions/products/metered-fees/{feeId}/tiers/search View in Client
Parameters
  • feeId
    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.9.3.3.4Create a metered fee tier
POST /api/v2.0/subscriptions/products/metered-fees/{feeId}/tiers View in Client
Parameters
  • feeId
    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
Product Metered Fee Tier Update
JSON Required
Responses
10.9.3.3.5Update a metered fee tier
PATCH /api/v2.0/subscriptions/products/metered-fees/{feeId}/tiers/{id} View in Client
Parameters
  • feeId
    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
Product Metered Fee Tier Update
JSON Required
Responses
10.9.3.3.6Delete a metered fee tier
DELETE /api/v2.0/subscriptions/products/metered-fees/{feeId}/tiers/{id} View in Client
Parameters
  • feeId
    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.9.3.4Product Metered Fees

10.9.3.4.1List all metered fees
GET /api/v2.0/subscriptions/products/metered-fees 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.9.3.4.2Retrieve a metered fee
GET /api/v2.0/subscriptions/products/metered-fees/{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.9.3.4.3Search metered fees
GET /api/v2.0/subscriptions/products/metered-fees/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.9.3.4.4Create a metered fee
POST /api/v2.0/subscriptions/products/metered-fees 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
Product Metered Fee Update
JSON Required
Responses
10.9.3.4.5Update a metered fee
PATCH /api/v2.0/subscriptions/products/metered-fees/{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
Product Metered Fee Update
JSON Required
Responses
10.9.3.4.6Delete a metered fee
DELETE /api/v2.0/subscriptions/products/metered-fees/{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.9.3.5Product Period Fees

10.9.3.5.1List all period fees
GET /api/v2.0/subscriptions/products/period-fees 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.9.3.5.2Retrieve a period fee
GET /api/v2.0/subscriptions/products/period-fees/{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.9.3.5.3Search period fees
GET /api/v2.0/subscriptions/products/period-fees/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.9.3.5.4Create a period fee
POST /api/v2.0/subscriptions/products/period-fees 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
Product Period Fee Update
JSON Required
Responses
10.9.3.5.5Update a period fee
PATCH /api/v2.0/subscriptions/products/period-fees/{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
Product Period Fee Update
JSON Required
Responses
10.9.3.5.6Delete a period fee
DELETE /api/v2.0/subscriptions/products/period-fees/{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.9.3.6Product Retirements

10.9.3.6.1List all product retirements
GET /api/v2.0/subscriptions/products/retirements 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.9.3.6.2Retrieve a product retirement
GET /api/v2.0/subscriptions/products/retirements/{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.9.3.6.3Search product retirements
GET /api/v2.0/subscriptions/products/retirements/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.9.3.7Product Setup Fees

10.9.3.7.1List all setup fees
GET /api/v2.0/subscriptions/products/setup-fees 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.9.3.7.2Retrieve a setup fee
GET /api/v2.0/subscriptions/products/setup-fees/{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.9.3.7.3Search setup fees
GET /api/v2.0/subscriptions/products/setup-fees/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.9.3.7.4Create a setup fee
POST /api/v2.0/subscriptions/products/setup-fees 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
Product Setup Fee Update
JSON Required
Responses
10.9.3.7.5Update a setup fee
PATCH /api/v2.0/subscriptions/products/setup-fees/{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
Product Setup Fee Update
JSON Required
Responses
10.9.3.7.6Delete a setup fee
DELETE /api/v2.0/subscriptions/products/setup-fees/{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.9.3.8Product Version Retirements

10.9.3.8.1List all product version retirements
GET /api/v2.0/subscriptions/products/versions/retirements 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.9.3.8.2Retrieve a product version retirement
GET /api/v2.0/subscriptions/products/versions/retirements/{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.9.3.8.3Search product version retirements
GET /api/v2.0/subscriptions/products/versions/retirements/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.9.3.9Product Versions

10.9.3.9.1List all product versions
GET /api/v2.0/subscriptions/products/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.9.3.9.2Retrieve a product version
GET /api/v2.0/subscriptions/products/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.9.3.9.3Search product versions
GET /api/v2.0/subscriptions/products/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.9.3.9.4Create a product version
POST /api/v2.0/subscriptions/products/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
Product Version Pending
JSON Required
Responses
10.9.3.9.5Activate a product version
POST /api/v2.0/subscriptions/products/versions/{id}/activate 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.9.3.9.6Retire a product version
POST /api/v2.0/subscriptions/products/versions/{id}/retire 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
Product Version Retirement Request
JSON Required
Responses
10.9.3.9.7Update a product version
PATCH /api/v2.0/subscriptions/products/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.
Request Body
Product Version Pending
JSON Required
Responses

10.9.3.10Products

10.9.3.10.1List all products
GET /api/v2.0/subscriptions/products 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.9.3.10.2Retrieve a product
GET /api/v2.0/subscriptions/products/{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.9.3.10.3Search products
GET /api/v2.0/subscriptions/products/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.9.3.10.4Create a product
POST /api/v2.0/subscriptions/products 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
Product Create
JSON Required
Responses
10.9.3.10.5Retire a product
POST /api/v2.0/subscriptions/products/{id}/retire 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
Product Retirement Request
JSON Required
Responses
10.9.3.10.6Update a product
PATCH /api/v2.0/subscriptions/products/{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
Product Active
JSON Required
Responses

10.9.4Suspension

10.9.4.1Suspensions

10.9.4.1.1List all suspensions
GET /api/v2.0/subscriptions/suspensions 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.9.4.1.2Retrieve a suspension
GET /api/v2.0/subscriptions/suspensions/{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.9.4.1.3Search suspensions
GET /api/v2.0/subscriptions/suspensions/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.10User

10.10.1.1Application User Roles

10.10.1.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.10.1.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.10.1.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.10.1.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.10.1.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.10.1.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.10.1.2Application Users

10.10.1.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.10.1.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.10.1.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.10.1.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.10.1.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.10.1.2.6Generate a new authentication key
POST /api/v2.0/application-users/{userId}/keys View in Client
Parameters
  • userId
    Long Required
    PATH
Responses
10.10.1.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.10.1.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.10.1.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.10.1.3Human User Roles

10.10.1.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.10.1.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.10.1.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.10.1.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.10.1.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.10.1.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.10.1.4Human Users

10.10.1.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.10.1.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.10.1.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.10.1.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.10.1.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.10.1.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.10.1.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.10.1.5Permissions

10.10.1.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.10.1.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.10.1.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.10.1.6Roles

10.10.1.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.10.1.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.10.1.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.10.1.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.10.1.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.10.1.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.10.1.7Single Sign-On User Roles

10.10.1.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.10.1.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.10.1.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.10.1.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.10.1.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.10.1.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.10.1.8Single Sign-On Users

10.10.1.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.10.1.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.10.1.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.10.1.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.10.1.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.10.1.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.11User Interface

10.11.1.1Saved Views

10.11.1.1.1Retrieve a saved view
GET /api/v2.0/ui/saved-views/{id} View in Client
Parameters
  • id
    Long Required
    PATH
Responses
10.11.1.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.11.1.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.11.1.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.11.1.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.11.1.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.12Web App

10.12.1.1Payment Web Apps

10.12.1.1.1Create a processor
POST /api/v2.0/payment/web-apps/processors 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 Details Create
JSON Required
Responses
10.12.1.1.2Activate a processor for production
POST /api/v2.0/payment/web-apps/processors/{externalId}/activate-for-production View in Client
Parameters
  • externalId
    String Required
    PATH
    The unique identifier assigned during processor's creation.
  • 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.1.1.3Create a connector
POST /api/v2.0/payment/web-apps/processors/{externalId}/connectors View in Client
Parameters
  • externalId
    String Required
    PATH
    The unique identifier assigned during processor's creation.
  • 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
Connector Details Create
JSON Required
Responses
10.12.1.1.4Update a charge attempt

Updates the state of a charge attempt for transactions created with a processor linked to the invoking web app, returning the specified charge attempt.

PATCH /api/v2.0/payment/web-apps/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.
Request Body
Charge Attempt Update
JSON Required
Responses
10.12.1.1.5Update a completion

Updates the state of a completion for transactions created with a processor linked to the invoking web app, returning the specified completion.

PATCH /api/v2.0/payment/web-apps/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.
Request Body
Completion Update
JSON Required
Responses
10.12.1.1.6Update a connector
PATCH /api/v2.0/payment/web-apps/connectors/{connectorExternalId} View in Client
Parameters
  • connectorExternalId
    String Required
    PATH
    The unique identifier assigned during connector's creation.
  • 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
Connector Details
JSON Required
Responses
10.12.1.1.7Update a processor
PATCH /api/v2.0/payment/web-apps/processors/{externalId} View in Client
Parameters
  • externalId
    String 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 Details
JSON Required
Responses
10.12.1.1.8Update a refund

Updates the state of a refund for transactions created with a processor linked to the invoking web app, returning the specified refund.

PATCH /api/v2.0/payment/web-apps/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.
Request Body
Refund Update
JSON Required
Responses
10.12.1.1.9Update a void

Updates the state of a void for transactions created with a processor linked to the invoking web app, returning the specified void.

PATCH /api/v2.0/payment/web-apps/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.
Request Body
Void Update
JSON Required
Responses
10.12.1.1.10Delete a connector

Permanently deletes a connector. It cannot be undone.

DELETE /api/v2.0/payment/web-apps/connectors/{connectorExternalId} View in Client
Parameters
  • connectorExternalId
    String Required
    PATH
    The unique identifier assigned during connector's creation.
  • 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.1.1.11Delete a processor

Permanently deletes a processor. It cannot be undone.

DELETE /api/v2.0/payment/web-apps/processors/{externalId} View in Client
Parameters
  • externalId
    String Required
    PATH
    The unique identifier assigned during processor's creation.
  • 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.1.2Web Apps

10.12.1.2.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.12.1.2.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.12.1.2.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.13Webhook

10.13.1.1Webhook Encryption Keys

10.13.1.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.13.1.2Webhook Listeners

10.13.1.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.13.1.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.13.1.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.13.1.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.13.1.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.13.1.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.13.1.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.13.1.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.13.1.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.13.1.3Webhook URLs

10.13.1.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.13.1.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.13.1.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.13.1.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.13.1.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.13.1.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.13.1.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.13.1.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.13.1.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.1.1Analytics Query Execution Request Details

Properties
  • sql
    String
    3 - 100,000 chars
    The SQL query (in PrestoDB dialect) to be executed against the analytics database. This query defines the data retrieval operation.

11.1.1.2Analytics Query Execution Response Details

Properties
  • queryToken
    String Read-only
    The unique query token associated with a submitted analytics query execution. This token can be used to check the execution status of the query.

11.1.1.3Submitted Analytics Query Execution Details

Properties
  • accountId
    Long Read-only
    The ID of the target account for which the analytics query will be executed, determining the data scope for the request.
  • createdTimestamp
    DateTime Read-only
    The date and time when the query was created.
  • downloadRequests
    Long Read-only
    The number of times the query result file has been downloaded.
  • originalQuery
    String Read-only
    The SQL query as originally submitted by the user.
  • portalQueryToken
    String Read-only
    The unique query token associated with the analytics query execution.
  • resultFileBytes
    Integer Read-only
    The size, in bytes, of the result file generated by the query.
  • scannedBytes
    Integer Read-only
    The total bytes of data scanned by the submitted query.
  • status
    Enum Read-only
    The current status of the submitted query execution.
    • PROCESSING
      Processing
    • CANCELLED
      Cancelled
    • FAILED
      Failed
    • SUCCESS
      Success
  • totalBilledExecutionTimeMs
    Integer Read-only
    The total execution time, in milliseconds, that has been billed for the query.

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
    Whether the feature is visible to the user.

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.5Scope 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.1Metric Usage Details

The metric usage provides details about the consumption of a particular metric.

Properties
  • consumedUnits
    Decimal Read-only
    The number of consumed units.
  • metricDescription
    Map of String String Expandable Read-only
    The description of the consumed unit's metric.
  • metricId
    Long Read-only
    The ID of the consumed units' metric.
  • metricName
    Map of String String Expandable Read-only
    The name of the consumed units' metric.

11.2.4.2Space 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.3Space 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.4Space 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.1.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.1.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.1.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.1.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.1.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.1.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.1.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.1.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.1.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.1.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.1.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.1.3Country Details

Properties
  • addressFormat
    Address Format Expandable Read-only
    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.1.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.1.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.1.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.1.7Localized String Details

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

11.5.1.8Persistable Currency Amount Details

Properties
  • amount
    Decimal Read-only
  • currency
    String Read-only

11.5.1.9State Details

Properties
  • code
    String Read-only
    The state's code used within addresses.
  • 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.1.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.1.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.1.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.1.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.1.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.1.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.1.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.7.1.3Line Item Reduction Details

Properties
  • lineItemUniqueId
    String Read-only
    The unique identifier of the line item to which the reduction is applied. This ID ensures the reduction is accurately associated with the correct item.
  • quantityReduction
    Decimal Read-only
    The quantity removed or reduced from the line item. This value reflects the decrease in the item count due to the reduction.
  • unitPriceReduction
    Decimal Read-only
    The monetary amount by which the line item's unit price is discounted. This reduction adjusts the price without altering the quantity.

11.8Manual Task

11.8.1.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.1.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.1.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.2Bank

11.9.2.1Bank Account Details

Properties
  • description
    String Read-only
    The description serves as an alternative name for the bank account.
  • id
    Long Read-only
    A unique identifier for the object.
  • identifier
    String Read-only
    The identifier is used 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
    The bank account's type
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.9.2.2Bank 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
    The identifier name specifies how the bank account type's identifier is called.
  • name
    Map of String String Expandable Read-only
    The localized name of the object.

11.9.2.3Bank Transaction Details

Properties
  • adjustments
    Collection of Payment Adjustment Expandable Read-only
    Adjustments are changes made to the initial transaction amount, such as fees or corrections.
  • createdBy
    Long
    User
    Read-only
    The ID of the user the bank transaction was created by.
  • createdOn
    DateTime Read-only
    The date and time when the object was created.
  • currencyBankAccount
    Currency Bank Account Expandable Read-only
    The currency bank account that sends or receives money based on the bank transaction's flow direction.
  • 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.
  • flowDirection
    Enum Read-only
    Indicates the direction of a bank transaction, specifying whether the amount flows into or out of the bank account.
    • 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 specifies the date on which the payment was processed.
  • 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 refers to the monetary value recorded for the bank transaction prior to any adjustments.
  • reference
    String Read-only
    A unique reference to identify the bank transaction.
  • source
    Long
    Bank Transaction Source
    Read-only
    The source indicates how the bank transaction was created.
  • state
    Enum Read-only
    The object's current state.
    • UPCOMING
      Upcoming
    • SETTLED
      Settled
  • totalAdjustmentAmountIncludingTax
    Decimal Read-only
    Represents the total value of all adjustments to the bank transaction, including tax.
  • type
    Long
    Bank Transaction Type
    Read-only
    The bank transaction's type.
  • valueAmount
    Decimal Read-only
    The value amount represents the net monetary value of the transaction after applicable deductions.
  • valueDate
    DateTime Read-only
    The value date indicates the date on which the transaction amount becomes effective.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.9.2.4Bank 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.2.5Bank 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.2.6Charge Bank Transaction Details

Properties
  • bankTransaction
    Bank Transaction Expandable Read-only
    Provides general information about the bank transaction.
  • completion
    Completion Expandable Read-only
    The transaction completion this bank transaction is belongs to.
  • 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
    The payment transaction this object is linked to.
  • spaceViewId
    Long
    Space View
    Read-only
    The ID of the space view this object is linked to.
  • transaction
    Transaction Expandable Read-only
    The payment transaction this bank transaction belongs to.
  • transactionCurrencyAmount
    Decimal Read-only
    The posting amount represents the monetary value of the bank transaction, recorded in the payment transaction's currency, before applying any adjustments.
  • transactionCurrencyValueAmount
    Decimal Read-only
    The value amount represents the net monetary value of the bank transaction, recorded in the payment transaction's currency, after applicable deductions.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.9.2.7Currency Bank Account Details

Properties
  • bankAccount
    Bank Account Expandable Read-only
    The bank account this currency bank account belongs to.
  • currency
    String Read-only
    The currency associated with the bank account.
  • environment
    Enum Read-only
    Whether the bank account operates in a test or production environment.
    • 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.2.8External Transfer Bank Transaction Details

Properties
  • bankTransaction
    Bank Transaction Expandable Read-only
    Provides general information about the bank transaction.
  • externalAccountIdentifier
    String Read-only
    The identifier is used to uniquely identify the external bank account.
  • externalAccountType
    String Read-only
    The external bank account's type.
  • externalBankName
    String Read-only
    The external bank account's name.
  • 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.2.9Internal 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
    The bank transaction from which funds are being transferred out.
  • targetBankTransaction
    Bank Transaction Expandable Read-only
    The bank transaction to which funds are being transferred in.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.9.2.10Payment Adjustment Details

Properties
  • amountExcludingTax
    Decimal Read-only
    The adjustment's amount, excluding taxes.
  • amountIncludingTax
    Decimal Read-only
    The adjustment's amount, including taxes.
  • id
    Long Read-only
    A unique identifier for the object.
  • rateInPercentage
    Decimal Read-only
    The percentage rate used to calculate the adjustment amount.
  • tax
    Tax Read-only
    The tax applied to the adjustment.
  • type
    Long
    Payment Adjustment Type
    Read-only
    The type of the adjustment.

11.9.2.11Payment 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.2.12Refund Bank Transaction Details

Properties
  • bankTransaction
    Bank Transaction Expandable Read-only
    Provides general information about the bank transaction.
  • 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
    The payment transaction this object is linked to.
  • refund
    Refund Expandable Read-only
    The refund this bank transaction belongs to.
  • refundCurrencyAmount
    Decimal Read-only
    The posting amount represents the monetary value of the bank transaction, recorded in the refund's currency, before applying any adjustments.
  • refundCurrencyValueAmount
    Decimal Read-only
    The value amount represents the net monetary value of the bank transaction, recorded in the refund's currency, after applicable deductions.
  • 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.2.13Refund Recovery Bank Transaction Details

Properties
  • bankTransaction
    Bank Transaction Expandable Read-only
    Provides general information about the bank transaction.
  • 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 that were recovered.
  • linkedSpaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • linkedTransaction
    Long
    Transaction
    Read-only
    The payment transaction this object is linked to.
  • refund
    Refund Expandable Read-only
    The refund this bank transaction belongs to.
  • refundCurrencyAmount
    Decimal Read-only
    The posting amount represents the monetary value of the bank transaction, recorded in the refund's currency, before applying any adjustments.
  • refundCurrencyValueAmount
    Decimal Read-only
    The value amount represents the net monetary value of the bank transaction, recorded in the refund's currency, after applicable deductions.
  • 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.3Base

11.9.3.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.3.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 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
    Payment 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.3.3Payment Connector Feature Details

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

11.9.3.4Payment Method Details

Properties
  • dataCollectionTypes
    Collection of Enum Read-only
    The data collection types that payment method supports.
    • 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.
  • merchantDescription
    Map of String String Expandable Read-only
    A merchant-focused, localized description of the payment method, providing its purpose and details.
  • name
    Map of String String Expandable Read-only
    The localized name of the object.
  • supportedCurrencies
    Collection of String Expandable Read-only
    The currencies that the payment method supports.

11.9.3.5Payment Method Brand Details

Properties
  • description
    Map of String String Expandable Read-only
    The localized description of the object.
  • grayImagePath
    String Read-only
    The path to the payment method brand's grayscale image.
  • id
    Long Read-only
    A unique identifier for the object.
  • imagePath
    String Read-only
    The path to the payment method brand's image.
  • 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.3.6Payment Method Configuration Details

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 customer-facing custom description for the payment method.
  • 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, displayed to the customer for visual identification.
  • 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 of the payment method displayed to the customer. If a custom description is defined, it will be used; otherwise, the default description of the payment method will be shown.
  • resolvedImageUrl
    String Read-only
    The URL to the image of the payment method displayed to the customer. If a custom image is defined, it will be used; otherwise, the default image of the payment method will be shown.
  • resolvedTitle
    Map of String String Expandable Read-only
    The title of the payment method displayed to the customer. If a custom title is defined, it will be used; otherwise, the default title of the payment method will be shown.
  • 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 customer-facing custom title for the payment method.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.9.3.7Payment Processor Details

Payment processors serve as intermediaries that establish connections with third-party companies, known as payment service providers. These providers are responsible for managing the technical aspects of payment transactions, ensuring seamless and secure payment processing.

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.3.8Payment Processor Configuration Details

Properties
  • applicationManaged
    Boolean Read-only
    Whether the processor configuration is managed by the application and therefore cannot be changed.
  • contractId
    Long
    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.4Charge

11.9.4.1Charge Details

Properties
  • createdOn
    DateTime Read-only
    The date and time when the object was created.
  • failureReason
    Failure Reason Read-only
    The reason for the failure of the charge.
  • 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
    The time zone that this object is associated with.
  • timeoutOn
    DateTime Read-only
    The date and time when the charge will expire.
  • transaction
    Transaction Expandable Read-only
    The transaction that the charge belongs to.
  • type
    Enum Read-only
    The type specifying how the customer was charged.
    • ASYNCHRONOUS
      Asynchronous
    • SYNCHRONOUS
      Synchronous
    • TOKEN
      Token
    • TERMINAL
      Terminal
  • userFailureMessage
    String Read-only
    The message that can be displayed to the customer explaining why the charge failed, in the customer's language.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.9.4.2Charge Attempt Details

Properties
  • charge
    Charge Expandable Read-only
    The charge that the charge attempt belongs to.
  • 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
  • connectorConfiguration
    Payment Connector Configuration Expandable Read-only
    The payment connector configuration that was used for the charge attempt.
  • createdOn
    DateTime Read-only
    The date and time when the object was created.
  • customersPresence
    Enum Read-only
    The customer's presence indicates whether and in what way the charge attempt's customer is present.
    • NOT_PRESENT
      Not Present
    • VIRTUAL_PRESENT
      Virtual Present
    • PHYSICAL_PRESENT
      Physical Present
  • environment
    Enum Read-only
    The environment in which the charge attempt is executed.
    • PRODUCTION
      Production
    • TEST
      Test
  • failedOn
    DateTime Read-only
    The date and time when the charge attempt failed.
  • failureReason
    Failure Reason Read-only
    The reason for the failure of the charge attempt.
  • id
    Long Read-only
    A unique identifier for the object.
  • initializingTokenVersion
    Boolean Read-only
    Whether a new token version is being initialized.
  • invocation
    Connector Invocation Expandable Read-only
    The connector invocation that the charge attempt belongs to.
  • 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
    The payment transaction this object is linked to.
  • nextUpdateOn
    DateTime Read-only
    The date and time when the next update of the object's state is planned.
  • 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
    The URL to redirect the customer to after payment processing.
  • salesChannel
    Long
    Sales Channel
    Read-only
    The sales channel through which the charge attempt was made.
  • 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
    The date and time when the charge attempt succeeded.
  • terminal
    Terminal Expandable Read-only
    The payment terminal through which the charge attempt was made.
  • timeZone
    String Read-only
    The time zone that this object is associated with.
  • timeoutOn
    DateTime Read-only
    The date and time when the object will expire.
  • tokenVersion
    Token Version Expandable Read-only
    The token version used for the charge attempt.
  • userFailureMessage
    String Read-only
    The message that can be displayed to the customer explaining why the charge attempt failed, in the customer's language.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.
  • wallet
    Wallet Type Read-only
    The type of wallet used to make the charge attempt.

11.9.4.3Charge Flow Details

Properties
  • conditions
    Collection of Connector Condition Expandable Read-only
    Conditions allow to define criteria that a transaction must fulfill in order for the charge flow 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 charge flow.
  • 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 charge flows are taken into account when processing a payment. Low values are considered first.
  • 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.4.4Charge Flow Level Details

Properties
  • asynchronousCharge
    Charge Expandable Read-only
    The charge to process the payment asynchronously.
  • configuration
    Charge Flow Level Configuration Expandable Read-only
    The configuration that was used for this charge flow level.
  • 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
    The payment transaction this object is linked 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
  • synchronousCharge
    Charge Expandable Read-only
    The charge to process the payment synchronously.
  • timeoutOn
    DateTime Read-only
    The date and time when the charge flow level will expire.
  • tokenCharge
    Charge Expandable Read-only
    The charge to process the payment using a token.
  • transaction
    Transaction Expandable Read-only
    The transaction that the charge flow level belongs to.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.9.4.5Charge Flow Level Configuration Details

Properties
  • flow
    Charge Flow Expandable Read-only
    The charge flow that this level configuration belongs 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 charge flow level configuration.
  • period
    String Read-only
    The duration specifies how long the level remains active before transitioning 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 that determines the order in which level configurations are taken into account when processing a charge flow. Low values are considered first.
  • 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 defines the method of delivering the payment link to the customer.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.9.4.6Charge 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
    The localized label that describes the action triggered by the configuration type.
  • name
    Map of String String Expandable Read-only
    The localized name of the object.

11.9.4.7Charge Flow Level Payment Link Details

Properties
  • chargeFlowLevel
    Charge Flow Level Expandable Read-only
    The charge flow level that the payment link belongs 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.
  • paymentLink
    String Read-only
    The URL provided to the customer for entering their payment details and completing the transaction.

11.9.4.8Connector 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
    The transaction stage during which the connector invocation was performed.
    • PAYMENT_METHOD_LIST
      Payment Method List
    • FORM_GENERATION
      Form Generation
    • VALIDATION
      Validation
    • AUTHORIZATION
      Authorization
  • timeTookInMilliseconds
    Long Read-only
    The duration, in milliseconds, taken to execute the connector invocation.
  • transaction
    Long
    Transaction
    Read-only
    The transaction that the connector invocation belongs to.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.9.4.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.4.10Wallet 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.5Condition

11.9.5.1Condition 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.5.2Connector Condition Details

A connector condition defines criteria that a transaction must meet for a connector configuration to process the payment.

Properties
  • conditionType
    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.6Contract

11.9.6.1Contract 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
    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 uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.
  • 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.6.2Contract 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.7Payment Link

11.9.7.1Payment Link Details

Properties
  • allowedPaymentMethodConfigurations
    Collection of Payment Method Configuration Expandable Read-only
    The payment method configurations that customers can use for making payments.
  • appliedSpaceView
    Long Read-only
    The payment link can be used within a specific space view, which may apply a customized design to the payment page.
  • availableFrom
    DateTime Read-only
    The earliest date the payment link can be used to initiate a transaction. If no date is provided, the link will be available immediately.
  • availableUntil
    DateTime Read-only
    The latest date the payment link can be used to initiate a transaction. If no date is provided, the link will remain available indefinitely.
  • billingAddressHandlingMode
    Enum Read-only
    The handling mode defines whether a billing address is required and specifies how it should be provided.
    • NOT_REQUIRED
      Not Required
    • REQUIRED_IN_URL
      Required In Url
    • REQUIRED_ON_PAYMENT_PAGE
      Required On Payment Page
  • currency
    String Read-only
    The three-letter currency code (ISO 4217). If not specified, it must be provided in the 'currency' request parameter.
  • externalId
    String Read-only
    A client-generated nonce which uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.
  • id
    Long Read-only
    A unique identifier for the object.
  • language
    String Read-only
    The language for displaying the payment page. If not specified, it can be supplied via the 'language' request parameter.
  • lineItems
    Collection of Line Item Expandable Read-only
    The line items representing what is being sold. If not specified, they can be supplied via request parameters.
  • linkedSpaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • maximalNumberOfTransactions
    Integer Read-only
    The maximum number of transactions that can be initiated using the payment link.
  • name
    String Read-only
    The name used to identify the payment link.
  • 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 defines whether the payment link is protected against tampering and specifies the protection method.
    • NO_PROTECTION
      No Protection
    • ACCESS_KEY
      Access Key
  • shippingAddressHandlingMode
    Enum Read-only
    The handling mode defines whether a shipping address is required and specifies how it should be provided.
    • 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 public URL to share with customers for making payments.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.9.8Terminal

11.9.8.1Rendered Terminal Receipt Details

Properties
  • data
    Collection of Byte Read-only
    The receipt document data in binary format, presented as a Base64-encoded string.
  • mimeType
    String Read-only
    The MIME type specifies the format of the receipt document and is determined by the requested format.
  • printed
    Boolean Read-only
    Whether the terminal's configuration mandates printing and the device has receipt printing capabilities.
  • receiptType
    Terminal Receipt Type Read-only
    The receipt type specifies the intended use and the target audience of the document.

11.9.8.2Terminal Details

Properties
  • configurationVersion
    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 uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.
  • 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
    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
    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.8.3Terminal 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.8.4Terminal 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
    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.8.5Terminal Configuration Version Details

Properties
  • configuration
    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.8.6Terminal Location Details

Properties
  • externalId
    String Read-only
    A client-generated nonce which uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.
  • 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.8.7Terminal Location Version Details

Properties
  • address
    Terminal Address Expandable Read-only
    The postal address of the location where the payment terminals are used.
  • contactAddress
    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
    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.8.8Terminal Receipt Fetch Request Details

Properties
  • format
    Enum
    The format specifies how the receipts will be presented in the response.
    • PDF
      Pdf
    • TXT
      Txt
  • width
    Integer
    The width defines the dimensions for rendering the document. For PDF format, the width is specified in millimeters, while for text format, it represents the number of characters per line.

11.9.8.9Terminal 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.8.10Terminal 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.8.11Transaction 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
    The unique identifier of the terminal.
  • terminalIdentifier
    String Read-only
    The unique identifier of the terminal, that is displayed on the device.

11.9.9Token

11.9.9.1Payment Information Hash Details

A payment information hash is generated from user input, ensuring consistent and collision-free results for identical inputs.

Properties
  • id
    Long Read-only
    A unique identifier for the object.
  • type
    Payment Information Hash Type Read-only
    The type specifies the algorithm used for calculating the hash.
  • value
    String Read-only
    The hash value generated based on the specified type.

11.9.9.2Payment Information Hash Type Details

Properties
  • id
    Long Read-only
    A unique identifier for the object.
  • name
    Map of String String Expandable Read-only
    The name that describes the hash type.

11.9.9.3Token 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 uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.
  • 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.9.4Token Version Details

Properties
  • activatedOn
    DateTime Read-only
    The date and time when the token version was activated.
  • billingAddress
    Address Expandable Read-only
    The billing address to be used for the transaction if no explicit billing address is provided during payment processing.
  • createdOn
    DateTime Read-only
    The date and time when the object was created.
  • environment
    Enum Read-only
    The environment in which the token version was created.
    • PRODUCTION
      Production
    • TEST
      Test
  • expiresOn
    DateTime Read-only
    The date and time when the token version is set to expire, after which it will be marked as obsolete.
  • iconUrl
    String Read-only
    The URL to the token's icon displayed to the customer.
  • 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
    The name used to identify the token.
  • obsoletedOn
    DateTime Read-only
    The date and time when the token version was marked obsolete.
  • paymentConnectorConfiguration
    Payment Connector Configuration Expandable Read-only
    The payment connector configuration that initialized the token version.
  • paymentInformationHashes
    Collection of Payment Information Hash Read-only
    The hashed payment information that the token version represents.
  • paymentMethod
    Payment Method Expandable Read-only
    The payment method that initialized the token version.
  • paymentMethodBrand
    Payment Method Brand Expandable Read-only
    The payment method brand that initialized the token version.
  • 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
    The token name as specified by the processor.
  • shippingAddress
    Address Expandable Read-only
    The shipping address to be used for the transaction if no explicit shipping address is provided during payment processing.
  • state
    Enum Read-only
    The object's current state.
    • UNINITIALIZED
      Uninitialized
    • ACTIVE
      Active
    • OBSOLETE
      Obsolete
  • token
    Token Expandable Read-only
    The token that the token version belongs to.
  • type
    Token Version Type Expandable Read-only
    The type specifies the nature of the token and identifies the payment connector capable of processing it.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.9.9.5Token Version Type Details

Properties
  • description
    Map of String String Expandable Read-only
    The localized description of the object.
  • feature
    Feature Read-only
    The feature that the token version 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.9.10Transaction

11.9.10.1Authenticated Card Data Details

Properties
  • cardHolderName
    String Read-only
    The name of the cardholder, as printed on the card, identifying the card owner.
  • cardVerificationCode
    String Read-only
    The security code used to validate the card during transactions.
  • cardholderAuthentication
    Cardholder Authentication Read-only
    Optional authentication details for the cardholder, such as 3D Secure authentication, used when the cardholder has already been verified during the transaction for added security.
  • cryptogram
    Card Cryptogram Read-only
    An additional authentication value that enhances the security of tokenized card transactions.
  • expiryDate
    String Read-only
    The expiry date of the card, indicating its validity period in yyyy-mm format (e.g., 2023-09).
  • initialRecurringTransaction
    Boolean Read-only
    Whether the transaction is an initial recurring transaction, based on the recurring indicator. This is used to identify the first transaction in a recurring payment setup.
  • panType
    Enum Read-only
    The type of PAN or token, indicating the source or security method of the card information.
    • 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 card's primary account number (PAN), the unique identifier of the card.
  • recurringIndicator
    Enum Read-only
    The indicator used to distinguish between recurring and one-time transactions. If omitted, it will be automatically determined based on the transaction's properties.
    • 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
    A reference specific to the card's transaction within its payment scheme.
  • tokenRequestorId
    String Read-only
    The token requestor identifier (TRID) identifies the entity requesting tokenization for a card transaction.

11.9.10.2Authenticated Card Request Details

Properties

11.9.10.3Card Cryptogram Details

Properties
  • eci
    String Read-only
    The Electronic Commerce Indicator (ECI) represents the authentication level and indicates liability shift during online or card-not-present transactions.
  • value
    String Read-only
    The cryptogram value used for securing card transactions, format varying based on the PAN type.

11.9.10.4Cardholder Authentication Details

Properties
  • authenticationIdentifier
    String Read-only
    The identifier (e.g., XID or DSTransactionID) assigned by the authentication system for tracking and verification.
  • authenticationResponse
    Enum Read-only
    The result of the authentication process.
    • 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 cryptographic token (CAVV/AAV) generated during the authentication process to validate the cardholder's identity.
  • electronicCommerceIndicator
    String Read-only
    The Electronic Commerce Indicator (ECI) represents the authentication level and indicates liability shift during online or card-not-present transactions.
  • version
    Enum Read-only
    The version of the authentication protocol (e.g., 3D Secure 1.0 or 2.0) used for the transaction.
    • V1
      V1
    • V2
      V2

11.9.10.5Client 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.10.6Completion Details

Properties
  • amount
    Decimal Read-only
    The total amount to be captured in this completion, including taxes.
  • baseLineItems
    Collection of Line Item Expandable Read-only
    The original line items from the transaction that serve as the baseline for this completion.
  • createdBy
    Long Read-only
    The ID of the user the transaction completion 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 uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.
  • failedOn
    DateTime Read-only
    The date and time when the transaction completion failed.
  • failureReason
    Failure Reason Read-only
    The reason for the failure of the transaction completion.
  • id
    Long Read-only
    A unique identifier for the object.
  • invoiceMerchantReference
    String Read-only
    The merchant's reference used to identify the invoice.
  • 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
    Whether this is the final completion for the transaction. After the last completion is successfully created, the transaction enters its final state, and no further completions can occur.
  • lineItemVersion
    Line Item Version Expandable Read-only
    The specific version of the line items that are being used for this completion.
  • lineItems
    Collection of Line Item Expandable Read-only
    The line items captured in this transaction completion.
  • linkedSpaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • linkedTransaction
    Long
    Transaction
    Read-only
    The payment transaction this object is linked to.
  • mode
    Enum Read-only
    The mode of transaction completion, such as online or offline, determining how the completion process is executed.
    • DIRECT
      Direct
    • ONLINE
      Online
    • OFFLINE
      Offline
  • nextUpdateOn
    DateTime Read-only
    The date and time when the next update of the object's state is planned.
  • paymentInformation
    String Read-only
    Payment-specific details related to this transaction completion such as payment instructions or references needed for processing.
  • 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 completion was started.
  • processorReference
    String Read-only
    The reference ID provided by the payment processor, used to trace the completion through the external payment system.
  • remainingLineItems
    Collection of Line Item Expandable Read-only
    The line items yet to be captured in the transaction.
  • 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 that appears on a customer's bank statement, providing an explanation for charges or payments, helping customers identify the transaction.
  • succeededOn
    DateTime Read-only
    The date and time when the transaction completion succeeded.
  • taxAmount
    Decimal Read-only
    The portion of the captured amount that corresponds to taxes.
  • timeZone
    String Read-only
    The time zone that this object is associated with.
  • timeoutOn
    DateTime Read-only
    The date and time when the object will expire.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.9.10.7Completion Details Details

Properties
  • externalId
    String
    1 - 100 chars
    A client-generated nonce which uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.
  • invoiceMerchantReference
    String
    ≤ 100 chars
    The merchant's reference used to identify the invoice.
  • lastCompletion
    Boolean
    Whether this is the final completion for the transaction, meaning no further completions can occur, and the transaction will move to its completed state upon success.
  • lineItems
    Collection of Completion Line Item . Create Create
    The line items to be captured in the transaction completion.
  • statementDescriptor
    String
    ≤ 80 options
    [a-zA-Z0-9\s.,_?+/-]*
    The statement descriptor that appears on a customer's bank statement, providing an explanation for charges or payments, helping customers identify the transaction.

11.9.10.8Completion Line Item Details

Properties
  • amount
    Decimal Read-only
    The total amount of the line item to be captured, including taxes.
  • quantity
    Decimal Read-only
    The number of items to be captured.
  • uniqueId
    String Read-only
    The unique identifier of the line item within the set of line items.

11.9.10.9Delivery Indication Details

Properties
  • automaticDecisionReason
    Delivery Indication Decision Reason Read-only
    The reason for the automatic system decision about the delivery indication.
  • automaticallyDecidedOn
    DateTime Read-only
    The date and time when an automatic decision was made.
  • completion
    Completion Expandable Read-only
    The transaction completion that the delivery indication is linked to.
  • 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
    The payment transaction this object is linked to.
  • manualDecisionTimeoutOn
    DateTime Read-only
    The date and time by which a decision must be made before the system automatically proceeds according to the connector's predefined settings.
  • manuallyDecidedBy
    Long Read-only
    The ID of the user who manually decided the delivery indication's state.
  • manuallyDecidedOn
    DateTime Read-only
    The date and time when a manual decision 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.
  • 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
    The date and time when the delivery indication will expire.
  • transaction
    Transaction Expandable Read-only
    The payment transaction that the delivery indication is linked to.

11.9.10.10Delivery 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.10.11Invoice Details

Properties
  • amount
    Decimal Read-only
    The total sum of all line items on the invoice, including taxes.
  • billingAddress
    Address Expandable Read-only
    The address associated with the invoice, used for billing purposes.
  • completion
    Completion Expandable Read-only
    The transaction completion this object is linked to.
  • createdOn
    DateTime Read-only
    The date and time when the object was created.
  • derecognizedBy
    Long Read-only
    The ID of the user the invoice was derecognized by.
  • derecognizedOn
    DateTime Read-only
    The date and time when the invoice was derecognized, meaning it is no longer considered outstanding or valid in the system.
  • dueOn
    DateTime Read-only
    The due date for payment of the invoice.
  • environment
    Enum Read-only
    The environment used when rendering resources.
    • LIVE
      Live
    • PREVIEW
      Preview
  • externalId
    String Read-only
    A client-generated nonce which uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.
  • 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 invoiced line items that will appear on the invoice document.
  • linkedSpaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • linkedTransaction
    Long
    Transaction
    Read-only
    The payment transaction this object is linked to.
  • merchantReference
    String Read-only
    The merchant's reference used to identify the invoice.
  • outstandingAmount
    Decimal Read-only
    The remaining amount the buyer owes to the merchant. A negative value indicates the invoice has been overpaid.
  • paidOn
    DateTime Read-only
    The date and time when the invoice was recorded as paid. May differ from the actual payment date due to processing delays.
  • 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
    The portion of the invoiced amount that corresponds to taxes.
  • timeZone
    String Read-only
    The time zone that this object is associated with.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.9.10.12Invoice 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
    Invoice Expandable Read-only
    The transaction invoice that the comment belongs to.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.9.10.13Invoice Replacement Details

Properties
  • billingAddress
    Address in Create State Create
    The address associated with the invoice, used for billing purposes.
  • dueOn
    DateTime
    The due date for payment of the invoice.
  • externalId
    String Required
    1 - 100 chars
    A client-generated nonce which uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.
  • lineItems
    Collection of Line Item Create Required
    The invoiced line items that will appear on the invoice document.
  • merchantReference
    String
    ≤ 100 chars
    The merchant's reference used to identify the invoice.
  • sentToCustomer
    Boolean
    Whether the invoice will be sent to the customer via email.

11.9.10.14Line Item Version Details

Properties
  • amount
    Decimal Read-only
    The total amount of the updated line items, including taxes.
  • createdBy
    Long Read-only
    The ID of the user the line item version 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 uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.
  • failedOn
    DateTime Read-only
    The date and time when the processing of the line item version failed.
  • 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
    The line items that replace the original line items in the transaction.
  • linkedSpaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • linkedTransaction
    Long
    Transaction
    Read-only
    The payment transaction this object is linked to.
  • nextUpdateOn
    DateTime Read-only
    The date and time when the next update of the line item version's state is planned.
  • 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 line item version was started.
  • 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
    The date and time when the line item version was processed successfully.
  • taxAmount
    Decimal Read-only
    The portion of the total amount that corresponds to taxes.
  • timeoutOn
    DateTime Read-only
    The date and time by when the line item version is expected to be processed.
  • transaction
    Transaction Expandable Read-only
    The transaction that the line item version belongs to.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.9.10.15Refund Details

A refund is a credit issued to the customer, which can be initiated either by the merchant or by the customer as a reversal.

Properties
  • amount
    Decimal Read-only
    The total monetary amount of the refund, representing the exact credit issued to the customer.
  • baseLineItems
    Collection of Line Item Expandable Read-only
    The original base line items from the transaction prior to the refund, serving as a reference for the refunded amounts.
  • completion
    Long
    Completion
    Read-only
    The transaction completion that the refund belongs to.
  • createdBy
    Long
    User
    Read-only
    The ID of the user the refund was created by.
  • createdOn
    DateTime Read-only
    The date and time when the object was created.
  • environment
    Enum Read-only
    The environment used when rendering resources.
    • LIVE
      Live
    • PREVIEW
      Preview
  • externalId
    String Read-only
    A client-generated nonce which uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.
  • failedOn
    DateTime Read-only
    The date and time when the refund failed.
  • failureReason
    Failure Reason Read-only
    The reason for the failure of the refund.
  • 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
    The line items included in the refund, representing the reductions.
  • 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 refund.
  • nextUpdateOn
    DateTime Read-only
    The date and time when the next update of the object's state is planned.
  • 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 refund was started.
  • processorReference
    String Read-only
    The reference ID provided by the payment processor, used to trace the refund through the external payment system.
  • reducedLineItems
    Collection of Line Item Expandable Read-only
    The line items from the original transaction, adjusted to reflect any reductions applied during the refund process.
  • reductions
    Collection of Line Item Reduction Expandable Read-only
    The reductions applied on the original transaction items, detailing specific adjustments associated with the refund.
  • 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
    The date and time when the refund succeeded.
  • taxes
    Collection of Tax Expandable Read-only
    The tax breakdown applied to the refund amount, helping with tax calculations or reporting.
  • timeZone
    String Read-only
    The time zone that this object is associated with.
  • timeoutOn
    DateTime Read-only
    The date and time when the object will expire.
  • totalAppliedFees
    Decimal Read-only
    The sum of fees applied to the refund transaction, such as processing or service charges.
  • totalSettledAmount
    Decimal Read-only
    The total amount settled for the refund, factoring in reductions, taxes, and any additional applied fees.
  • transaction
    Transaction Expandable Read-only
    The transaction that the refund belongs to.
  • type
    Enum Read-only
    The type specifying the method and origin of the refund (e.g., initiated by the customer or merchant).
    • 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
    Invoice
    Read-only
    An updated invoice reflecting adjustments made by the refund.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.9.10.16Refund 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
    The refund that the comment belongs to.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.9.10.17Tokenized Card Data Details

Properties
  • cardHolderName
    String Read-only
    The name of the cardholder, as printed on the card, identifying the card owner.
  • cardVerificationCode
    String Read-only
    The security code used to validate the card during transactions.
  • cryptogram
    Card Cryptogram Read-only
    An additional authentication value that enhances the security of tokenized card transactions.
  • expiryDate
    String Read-only
    The expiry date of the card, indicating its validity period in yyyy-mm format (e.g., 2023-09).
  • initialRecurringTransaction
    Boolean Read-only
    Whether the transaction is an initial recurring transaction, based on the recurring indicator. This is used to identify the first transaction in a recurring payment setup.
  • panType
    Enum Read-only
    The type of PAN or token, indicating the source or security method of the card information.
    • 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 card's primary account number (PAN), the unique identifier of the card.
  • recurringIndicator
    Enum Read-only
    The indicator used to distinguish between recurring and one-time transactions. If omitted, it will be automatically determined based on the transaction's properties.
    • 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
    A reference specific to the card's transaction within its payment scheme.
  • tokenRequestorId
    String Read-only
    The token requestor identifier (TRID) identifies the entity requesting tokenization for a card transaction.

11.9.10.18Tokenized Card Request Details

Properties
  • cardData
    Tokenized Card Data . Create Create
    The tokenized card data to use in the transaction.
  • paymentMethodConfiguration
    Long
    The ID of the payment method configuration to use.

11.9.10.19Transaction 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
    The environment used when rendering resources.
    • 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
    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
    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.10.20Transaction 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
    The transaction that the comment belongs to.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.9.10.21Transaction 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.9.10.22Transaction Void Details

Properties
  • createdBy
    Long Read-only
    The ID of the user the transaction void was created by.
  • createdOn
    DateTime Read-only
    The date and time when the object was created.
  • failedOn
    DateTime Read-only
    The date and time when the transaction void failed.
  • failureReason
    Failure Reason Read-only
    The reason for the failure of the transaction void.
  • 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
    The payment transaction this object is linked to.
  • mode
    Enum Read-only
    The mode of transaction void, such as online or offline, determining how the void process is executed.
    • ONLINE
      Online
    • OFFLINE
      Offline
  • nextUpdateOn
    DateTime Read-only
    The date and time when the next update of the object's state is planned.
  • 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
    The reference ID provided by the payment processor, used to trace the void through the external payment system.
  • 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
    The date and time when the transaction void succeeded.
  • timeoutOn
    DateTime Read-only
    The date and time when the object will expire.
  • transaction
    Transaction Expandable Read-only
    The transaction that the void belongs to.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.10Subscription

11.10.1.1Subscriber Details

A subscriber represents everyone who is subscribed to a product.

Properties
  • additionalAllowedPaymentMethodConfigurations
    Collection of Long
    Payment Method Configuration
    Read-only
    Allow the subscriber to use these payment methods even if subscription products do not accept them.
  • billingAddress
    Address Expandable Read-only
    The address associated with the subscriber for invoicing and transaction processing purposes.
  • description
    String Read-only
    The description used to identify the subscriber.
  • disallowedPaymentMethodConfigurations
    Collection of Long
    Payment Method Configuration
    Read-only
    Prevent the subscriber from using these payment methods even if subscription products do accept them.
  • emailAddress
    String Read-only
    The email address that is used to communicate with the subscriber. There can be only one subscriber per space with the same email address.
  • externalId
    String Read-only
    A client-generated nonce which uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.
  • id
    Long Read-only
    A unique identifier for the object.
  • language
    String Read-only
    The language that is used when communicating with the subscriber via emails and documents.
  • linkedSpaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • metaData
    Map of String String Expandable Read-only
    Allow to store additional information about 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.
  • reference
    String Read-only
    The merchant's reference used to identify the subscriber.
  • shippingAddress
    Address Expandable Read-only
    The address to where orders will be shipped.
  • 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.10.1.2Subscription Details

Properties
  • activatedOn
    DateTime Read-only
    The date and time when the subscription was activate.
  • affiliate
    Subscription Affiliate Expandable Read-only
    The affiliate that led to the creation of the subscription.
  • createdOn
    DateTime Read-only
    The date and time when the subscription was created.
  • currentProductVersion
    Product Version Expandable Read-only
    The version of the product that the subscription is currently linked to.
  • description
    String Read-only
    A description used to identify the subscription.
  • id
    Long Read-only
    A unique identifier for the object.
  • initializedOn
    DateTime Read-only
    The date and time when the subscription was initialized.
  • 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.
  • plannedTerminationDate
    DateTime Read-only
    The date and time when the subscription is planned to be terminated.
  • reference
    String Read-only
    The merchant's reference used to identify the subscription.
  • state
    Enum Read-only
    The object's current state.
    • PENDING
      Pending
    • INITIALIZING
      Initializing
    • FAILED
      Failed
    • ACTIVE
      Active
    • SUSPENDED
      Suspended
    • TERMINATION_SCHEDULED
      Termination Scheduled
    • TERMINATING
      Terminating
    • TERMINATED
      Terminated
  • subscriber
    Subscriber Expandable Read-only
    The subscriber that the subscription belongs to.
  • terminatedBy
    Long
    User
    Read-only
    The ID of the user the subscription was terminated by.
  • terminatedOn
    DateTime Read-only
    The date and time when the subscription was terminated.
  • terminatingOn
    DateTime Read-only
    The date and time when the termination of the subscription started.
  • terminationScheduledOn
    DateTime Read-only
    The date and time when the subscription was scheduled to be terminated.
  • token
    Token Expandable Read-only
    The payment token that is used to charge the customer.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.10.1.3Subscription Affiliate Details

Properties
  • externalId
    String Read-only
    A client-generated nonce which uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.
  • 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.
  • name
    String Read-only
    The name used to identify the affiliate.
  • 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.
  • reference
    String Read-only
    The reference used to identify the affiliate.
  • 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.10.1.4Subscription Charge Details

The subscription charge represents a single charge carried out for a particular subscription.

Properties
  • createdOn
    DateTime Read-only
    The date and time when the charge was created.
  • discardedBy
    Long
    User
    Read-only
    The ID of the user the charge was discarded by.
  • discardedOn
    DateTime Read-only
    The date and time when the charge was discarded.
  • externalId
    String Read-only
    A client-generated nonce which uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.
  • failedOn
    DateTime Read-only
    The date and time when the charge failed.
  • failedUrl
    String Read-only
    The URL to redirect the customer back to after they canceled or failed to authenticated their payment.
  • id
    Long Read-only
    A unique identifier for the object.
  • language
    String Read-only
    The language that is linked to the object.
  • ledgerEntries
    Collection of Subscription Ledger Entry Expandable Read-only
    The ledger entries that belong to the charge.
  • linkedSpaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • plannedExecutionDate
    DateTime Read-only
    The date and time when the execution of the charge is planned.
  • 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.
  • processingType
    Enum Read-only
    The processing type specifies how the charge is to be processed.
    • SYNCHRONOUS
      Synchronous
    • CHARGE_FLOW
      Charge Flow
  • reference
    String Read-only
    The merchant's reference used to identify the charge.
  • state
    Enum Read-only
    The object's current state.
    • SCHEDULED
      Scheduled
    • DISCARDED
      Discarded
    • PROCESSING
      Processing
    • SUCCESSFUL
      Successful
    • FAILED
      Failed
  • subscription
    Subscription Expandable Read-only
    The subscription that the charge belongs to.
  • succeedOn
    DateTime Read-only
    The date and time when the charge succeeded.
  • successUrl
    String Read-only
    The URL to redirect the customer back to after they successfully authenticated their payment.
  • transaction
    Transaction Expandable Read-only
    The transaction used to process the charge.
  • type
    Enum Read-only
    The type specified how the charge was initiated.
    • MANUAL
      Manual
    • AUTOMATIC
      Automatic
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.10.1.5Subscription Component Configuration Details

Properties
  • component
    Long
    Product Component
    Read-only
    The component that is being configured.
  • id
    Long Read-only
    A unique identifier for the object.
  • linkedSpaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • quantity
    Decimal Read-only
    The quantity that should be applied to the component.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.10.1.6Subscription Component Reference Configuration Details

The component reference configuration adjusts the product component for a particular subscription.

Properties
  • productComponentReferenceId
    Long
    The ID of the component reference that is being configured.
  • quantity
    Decimal
    The quantity that should be applied to the component.

11.10.1.7Subscription Creation Request Details

Properties

11.10.1.8Subscription Initialization Request Details

Properties
  • failureUrl
    String
    The URL that the user is redirected to if the transaction fails.
  • successUrl
    String
    The URL that the user is redirected to if the transaction succeeds.

11.10.1.9Subscription Ledger Entry Details

The subscription ledger entry represents a single change on the subscription balance.

Properties
  • aggregatedTaxRate
    Decimal Read-only
    The total tax rate applied to the ledger entry, calculated from the rates of all tax lines.
  • amountExcludingTax
    Decimal Read-only
    The leger entry's amount with discounts applied, excluding taxes.
  • amountIncludingTax
    Decimal Read-only
    The leger entry's amount with discounts applied, including taxes.
  • componentReferenceName
    String Read-only
  • componentReferenceSku
    String Read-only
  • createdBy
    Long
    User
    Read-only
    The ID of the user the ledger entry was created by.
  • createdOn
    DateTime Read-only
    The date and time when the object was created.
  • discountIncludingTax
    Decimal Read-only
    The discount allocated to the ledger entry, including taxes.
  • externalId
    String Read-only
    A client-generated nonce which uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.
  • feeType
    Enum Read-only
    • METERED_FEE
      Metered Fee
    • SETUP_FEE
      Setup Fee
    • PERIOD_FEE
      Period Fee
  • 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.
  • proRataCalculated
    Boolean Read-only
  • quantity
    Decimal Read-only
    The number of items that were consumed.
  • state
    Enum Read-only
    The object's current state.
    • OPEN
      Open
    • SCHEDULED
      Scheduled
    • PAID
      Paid
  • subscriptionMetricId
    Long Read-only
  • subscriptionVersion
    Long
    Subscription Version
    Read-only
    The subscription version that the ledger entry belongs to.
  • taxAmount
    Decimal Read-only
    The sum of all taxes applied to the ledger entry.
  • taxes
    Collection of Tax Read-only
    A set of tax lines, each of which specifies a tax applied to the ledger entry.
  • title
    String Read-only
    The title that indicates what the ledger entry is about.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.10.1.10Subscription Period Bill Details

Properties
  • createdOn
    DateTime Read-only
    The date and time when the period bill was created.
  • effectivePeriodEndDate
    DateTime Read-only
    The date and time when the period actually ended.
  • 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.
  • periodStartDate
    DateTime Read-only
    The date and time when the period started.
  • plannedPeriodEndDate
    DateTime Read-only
    The date and time when the period is planned to end.
  • 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
    • BILLED
      Billed
  • subscriptionVersion
    Subscription Version Expandable Read-only
    The subscription version that the period bill belongs to.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.10.1.11Subscription Update Request Details

Properties
  • componentConfigurations
    Collection of Subscription Component Reference Configuration
    The configurations of the subscription's components.
  • currency
    String
    The three-letter code (ISO 4217 format) of the currency used to invoice the customer. Must be one of the currencies supported by the product.
  • product
    ID of Product
    The product to subscribe to.
  • respectTerminationPeriod
    Boolean
    Whether the subscriptions' termination periods should be respected.

11.10.1.12Subscription Version Details

Properties
  • activatedOn
    DateTime Read-only
    The date and time when the subscription version was activated.
  • billingCurrency
    String Read-only
    The three-letter code (ISO 4217 format) of the currency used to invoice the customer. Must be one of the currencies supported by the product.
  • billingCycleModel
    Billing Cycle Model Read-only
  • componentConfigurations
    Collection of Subscription Component Configuration Read-only
    The configurations of the subscription's components.
  • createdOn
    DateTime Read-only
    The date and time when the subscription version was created.
  • expectedLastPeriodEnd
    DateTime Read-only
    The date and time when the last period is expected to end.
  • failedOn
    DateTime Read-only
    The date and time when the subscription version failed.
  • 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.
  • plannedTerminationDate
    DateTime Read-only
    The date and time when the termination of the subscription version is planned.
  • productVersion
    Product Version Expandable Read-only
    The product version that is subscribed to.
  • state
    Enum Read-only
    The object's current state.
    • PENDING
      Pending
    • INITIALIZING
      Initializing
    • FAILED
      Failed
    • ACTIVE
      Active
    • TERMINATING
      Terminating
    • TERMINATED
      Terminated
  • subscription
    Subscription Expandable Read-only
    The subscription that this version belongs to.
  • terminatedOn
    DateTime Read-only
    The date and time when the subscription version was terminated.
  • terminatingOn
    DateTime Read-only
    The date and time when the termination of the subscription version started.
  • terminationIssuedOn
    DateTime Read-only
    The date and time when the termination of the subscription version was issued.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.10.2Metric

11.10.2.1Metric Details

A metric represents the usage of a resource that can be measured.

Properties
  • description
    Map of String String Expandable Read-only
    The localized description of the metric that is displayed to the customer.
  • 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
    Map of String String Expandable Read-only
    The localized name of the metric that is displayed to the customer.
  • 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
  • type
    Metric Type Read-only
    The type of the metric.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.10.2.2Metric Type Details

The subscription metric type identifies the type of the metric.

Properties
  • description
    Map of String String Expandable Read-only
    The localized description of the object.
  • feature
    Long
    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.10.2.3Metric Usage Report Details

The metric usage is the actual usage of a metric for a particular subscription as collected by an external application.

Properties
  • consumedUnits
    Decimal Read-only
    The number of resources consumed, will be charged in the next billing cycle.
  • createdByUserId
    Long
    User
    Read-only
    The ID of the user the usage report was created by.
  • createdOn
    DateTime Read-only
    The date and time when the usage report was created.
  • description
    String Read-only
    A description used to identify the usage report.
  • externalId
    String Read-only
    A client-generated nonce which uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.
  • id
    Long Read-only
    A unique identifier for the object.
  • linkedSpaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • metric
    Long
    Metric
    Read-only
    The metric that the usage report is recorded 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.
  • subscription
    Long
    Subscription
    Read-only
    The subscription that the usage report is recorded for.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.10.3Product

11.10.3.1Billing Cycle Model Details

Properties
  • billingCycleType
    Enum Required
    • DAILY
      Daily
    • WEEKLY
      Weekly
    • MONTHLY
      Monthly
    • YEARLY
      Yearly
  • customization
    Enum
    • DEFAULT
      Default
    • SPECIFIC
      Specific
  • dayOfMonth
    Integer
  • month
    Enum
    • JANUARY
      January
    • FEBRUARY
      February
    • MARCH
      March
    • APRIL
      April
    • MAY
      May
    • JUNE
      June
    • JULY
      July
    • AUGUST
      August
    • SEPTEMBER
      September
    • OCTOBER
      October
    • NOVEMBER
      November
    • DECEMBER
      December
  • numberOfPeriods
    Integer Required
    ≥ 1
    Billing Cycle type multiplied by Number of Periods defines billing cycle duration, e.g. 3 months. Monthly types require 1-12; weekly and yearly types require 1-9 periods; and daily types require 1-30.
  • weeklyDay
    Enum
    • MONDAY
      Monday
    • TUESDAY
      Tuesday
    • WEDNESDAY
      Wednesday
    • THURSDAY
      Thursday
    • FRIDAY
      Friday
    • SATURDAY
      Saturday
    • SUNDAY
      Sunday

11.10.3.2Product Details

A subscription product represents a product to which a subscriber can subscribe to. A product defines how much the subscription costs and in what cycles the subscribe is charged.

Properties
  • allowedPaymentMethodConfigurations
    Collection of Long
    Payment Method Configuration
    Read-only
    The payment methods that can be used to subscribe to this product. If none are selected, no restriction is applied.
  • failedPaymentSuspensionPeriod
    String Read-only
    The period after which a subscription that has been suspended due to a failed payment is terminated.
  • 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 product.
  • 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.
  • productLocked
    Boolean Read-only
    Whether subscriptions can be switched to or from this product, or whether they are locked in.
  • reference
    String Read-only
    The merchant's reference used to identify the product, e.g. the SKU.
  • sortOrder
    Integer Read-only
    When listing products, they can be sorted by this number.
  • 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
    • RETIRING
      Retiring
    • RETIRED
      Retired
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.10.3.3Product Component Details

Properties
  • componentChangeWeight
    Integer Read-only
    If switching from a component with a lower tier to a component with a higher one, this is considered an upgrade and a fee may be applied.
  • componentGroup
    Product Component Group Expandable Read-only
    The group that the component belongs to.
  • defaultComponent
    Boolean Read-only
    Whether this is the default component in its group and preselected.
  • description
    Map of String String Expandable Read-only
    The localized description of the component that is displayed to the customer.
  • id
    Long Read-only
    A unique identifier for the object.
  • linkedSpaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • maximalQuantity
    Decimal Read-only
    A maximum of the defined quantity can be selected for this component.
  • minimalQuantity
    Decimal Read-only
    A minimum of the defined quantity must be selected for this component.
  • name
    Map of String String Expandable Read-only
    The localized name of the component that is displayed to the customer.
  • quantityStep
    Decimal Read-only
    The quantity step determines the interval in which the quantity can be increased.
  • reference
    Product Component Reference Expandable Read-only
    The reference is used to link components across different product versions.
  • sortOrder
    Integer Read-only
    When listing components, they can be sorted by this number.
  • taxClass
    Tax Class Expandable Read-only
    The tax class to be applied to fees.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.10.3.4Product Component Group 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
    Map of String String Expandable Read-only
    The localized name of the component group that is displayed to the customer.
  • optional
    Boolean Read-only
    Whether the component group is optional, i.e. the customer does not have to select any component.
  • productVersion
    Product Version Expandable Read-only
    The product version that the component group belongs to.
  • sortOrder
    Integer Read-only
    When listing component groups, they can be sorted by this number.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.10.3.5Product Component Reference Details

The product component reference links components from different product versions, which makes it possible to carry out migrations.

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 component reference.
  • 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.
  • sku
    String Read-only
    The component reference sku as a unique identifier.
  • 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.10.3.6Product Metered Fee Details

Properties
  • component
    Product Component Expandable Read-only
    The product component that the fee belongs to.
  • description
    Map of String String Expandable Read-only
    The localized description of the fee that is displayed to the customer.
  • id
    Long Read-only
    A unique identifier for the object.
  • linkedSpaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • metric
    Metric Expandable Read-only
    The metric used to determine the resource consumption billed to the customer.
  • name
    Map of String String Expandable Read-only
    The localized name of the fee that is displayed to the customer.
  • tierPricing
    Enum Read-only
    The method used to calculate the tier price.
    • CHEAPEST_TIER_PRICING
      Cheapest Tier Pricing
    • INCREMENTAL_DISCOUNT_PRICING
      Incremental Discount Pricing
  • type
    Enum Read-only
    The type of the fee.
    • METERED_FEE
      Metered Fee
    • SETUP_FEE
      Setup Fee
    • PERIOD_FEE
      Period Fee
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.10.3.7Product Metered Fee Tier Details

Properties
  • fee
    Collection of Persistable Currency Amount Read-only
    The amount charged to the customer for each consumed unit at the end of a billing cycle.
  • id
    Long Read-only
    A unique identifier for the object.
  • meteredFee
    Product Metered Fee Expandable Read-only
    The metered fee that this tier belongs to.
  • startRange
    Decimal Read-only
    Starting from and including this quantity is contained in the tier.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.10.3.8Product Period Fee Details

Properties
  • component
    Product Component Expandable Read-only
    The product component that the fee belongs to.
  • description
    Map of String String Expandable Read-only
    The localized description of the fee that is displayed to the customer.
  • id
    Long Read-only
    A unique identifier for the object.
  • ledgerEntryTitle
    Map of String String Expandable Read-only
    The localized title that be used on ledger entries and invoices.
  • linkedSpaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • name
    Map of String String Expandable Read-only
    The localized name of the fee that is displayed to the customer.
  • numberOfFreeTrialPeriods
    Integer Read-only
    The number of subscription billing cycles that count as a trial phase and during which no fees are charged.
  • periodFee
    Collection of Persistable Currency Amount Read-only
    The amount charged to the customer for each billing cycle during the term of a subscription.
  • type
    Enum Read-only
    The type of the fee.
    • METERED_FEE
      Metered Fee
    • SETUP_FEE
      Setup Fee
    • PERIOD_FEE
      Period Fee
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.10.3.9Product Retirement 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.
  • product
    Product Expandable Read-only
    The product that is to be retired.
  • respectTerminationPeriods
    Boolean Read-only
    Whether the subscriptions' termination periods should be respected.
  • targetProduct
    Product Expandable Read-only
    The product to which the subscriptions with the retiring product are to be migrated. If none is defined, the subscriptions are terminated.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.10.3.10Product Retirement Request Details

Properties
  • respectTerminationPeriods
    Boolean
    Whether the subscriptions' termination periods should be respected.
  • targetProduct
    ID of Product
    The product to which the subscriptions with the retiring product are to be migrated. If none is defined, the subscriptions are terminated.

11.10.3.11Product Setup Fee Details

Properties
  • component
    Product Component Expandable Read-only
    The product component that the fee belongs to.
  • description
    Map of String String Expandable Read-only
    The localized description of the fee that is displayed to the customer.
  • 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
    Map of String String Expandable Read-only
    The localized name of the fee that is displayed to the customer.
  • onDowngradeCreditedAmount
    Collection of Persistable Currency Amount Read-only
    The amount charged to the customer when a subscription is downgraded.
  • onUpgradeCreditedAmount
    Collection of Persistable Currency Amount Read-only
    The amount charged to the customer when a subscription is upgraded.
  • setupFee
    Collection of Persistable Currency Amount Read-only
    The amount charged to the customer once when they subscribe to a subscription.
  • type
    Enum Read-only
    The type of the fee.
    • METERED_FEE
      Metered Fee
    • SETUP_FEE
      Setup Fee
    • PERIOD_FEE
      Period Fee
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.10.3.12Product Version Details

Properties
  • activatedOn
    DateTime Read-only
    The date and time when the product version was activated.
  • billingCycle
    String Read-only
    The recurring period of time, typically monthly or annually, for which a subscriber is charged.
  • billingCycleModel
    Billing Cycle Model Read-only
  • comment
    String Read-only
    A comment that describes the product version and why it was created. It is not disclosed to the subscriber.
  • createdOn
    DateTime Read-only
    The date and time when the product version was created.
  • defaultCurrency
    String Read-only
    The three-letter code (ISO 4217 format) of the product version's default currency.
  • enabledCurrencies
    Collection of String Read-only
    The three-letter codes (ISO 4217 format) of the currencies that the product version supports.
  • id
    Long Read-only
    A unique identifier for the object.
  • incrementNumber
    Integer Read-only
    Whenever a new version of a product is created, the number is increased and assigned.
  • linkedSpaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • minimalNumberOfPeriods
    Integer Read-only
    The minimum number of periods the subscription will run before it can be terminated.
  • name
    Map of String String Expandable Read-only
    The localized name of the product that is displayed to the customer.
  • numberOfNoticePeriods
    Integer Read-only
    The number of periods the subscription will keep running after its termination was requested.
  • obsoletedOn
    DateTime Read-only
    The date and time when the product version was made obsolete.
  • 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.
  • product
    Product Expandable Read-only
    The product that the version belongs to.
  • reference
    String Read-only
    The reference used to identify the product version.
  • retiringFinishedOn
    DateTime Read-only
    The date and time when the product version was retired.
  • retiringStartedOn
    DateTime Read-only
    The date and time when the product version's retirement was started.
  • state
    Enum Read-only
    The object's current state.
    • PENDING
      Pending
    • ACTIVE
      Active
    • OBSOLETE
      Obsolete
    • RETIRING
      Retiring
    • RETIRED
      Retired
  • taxCalculation
    Enum Read-only
    The way taxes are calculated for fees.
    • TAX_INCLUDED
      Tax Included
    • TAX_NOT_INCLUDED
      Tax Not Included
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.10.3.13Product Version Retirement 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.
  • productVersion
    Product Version Expandable Read-only
    The product version that is to be retired.
  • respectTerminationPeriods
    Boolean Read-only
    Whether the subscriptions' termination periods should be respected.
  • targetProduct
    Product Expandable Read-only
    The product to which the subscriptions with the retiring product version are to be migrated. If none is defined, the subscriptions are terminated.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.10.3.14Product Version Retirement Request Details

Properties
  • respectTerminationPeriods
    Boolean
    Whether the subscriptions' termination periods should be respected.
  • targetProduct
    ID of Product
    The product to which the subscriptions with the retiring product version are to be migrated. If none is defined, the subscriptions are terminated.

11.10.4Suspension

11.10.4.1Suspension Details

Properties
  • createdOn
    DateTime Read-only
    The date and time when the object was created.
  • effectiveEndDate
    DateTime Read-only
    The date and time when the suspension ended.
  • endAction
    Enum Read-only
    Whether the subscription should be terminated or reactivated after the suspension has reached its end date.
    • TERMINATE
      Terminate
    • REACTIVATE
      Reactivate
  • 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.
  • note
    String Read-only
    A note that contains details about the suspension. It is not disclosed to the subscriber.
  • periodBill
    Long
    Subscription Period Bill
    Read-only
    The period bill that led to the suspension of the subscription.
  • plannedEndDate
    DateTime Read-only
    The date and time when the suspension is planned to end.
  • 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.
  • reason
    Enum Read-only
    The reason why the subscription was suspended.
    • FAILED_CHARGE
      Failed Charge
    • SUBSCRIBER_INITIATED_REFUND
      Subscriber Initiated Refund
    • MANUAL
      Manual
  • state
    Enum Read-only
    The object's current state.
    • RUNNING
      Running
    • ENDED
      Ended
  • subscription
    Subscription Expandable Read-only
    The subscription that this suspension belongs to.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.10.4.2Suspension Request Details

Properties
  • endAction
    Enum
    Whether the subscription should be terminated or reactivated after the suspension has reached its end date.
    • TERMINATE
      Terminate
    • REACTIVATE
      Reactivate
  • note
    String
    ≤ 300 chars
    A note that contains details about the suspension. It is not disclosed to the subscriber.
  • plannedEndDate
    DateTime
    The date and time when the suspension is planned to end.

11.11Tax

11.11.1.1Tax Details

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

11.11.1.2Tax Class 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 tax class.
  • 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.12User

11.12.1.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.12.1.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.12.1.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.12.1.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.12.1.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.12.1.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.12.1.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.12.1.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.12.1.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.12.1.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.12.1.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.13User Interface

11.13.1.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.13.1.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.14Web App

11.14.1.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.14.2Payment Web App

11.14.2.1Charge Attempt Update Details

A request to update the state of a charge attempt. The charge attempt must be associated with a processor created by the invoking payment web app.

Properties
  • endUserFailureMessage
    String
    ≤ 2,000 chars
    A message explaining to the buyer why the payment failed. The message must be localized in the buyer's language, as specified in the payment page invocation URL.
  • failureReason
    Long
    Failure Reason
    The reason for the charge attempt's failure. This field is mandatory when the target state is set to 'FAILED'.
  • reference
    String
    ≤ 100 chars
    A unique identifier for the charge attempt within the systems of the external service provider. This field is mandatory when the target state is set to 'SUCCESSFUL'.
  • targetState
    Enum
    The desired end state of the charge attempt. Once the charge attempt is in the target state, further updates are not allowed.
    • SUCCESSFUL
      Successful
    • FAILED
      Failed

11.14.2.2Completion Configuration Details

Properties
  • completionEndpoint
    String Read-only
    The URL that the payment service provider will invoke to process a completion request. This endpoint handles communication with the provider for initiating and managing completions.
  • completionTimeoutInMinutes
    Integer Read-only
    The maximum time (in minutes) to wait for a response from the payment service provider after a completion request is triggered. If no feedback or final status is received within this period, the completion is considered failed.
  • maximalCompletionDelayInDays
    Integer Read-only
    The maximum number of days after a transaction's authorization during which a completion or void action can be triggered. Once this period has passed, neither action can be executed.
  • multipleCompletionsSupported
    Boolean Read-only
    Whether the payment connector can process multiple completions for a single transaction.
  • voidEndpoint
    String Read-only
    The URL that the payment service provider will invoke to process a void request. This endpoint handles communication with the provider for initiating and managing voids.

11.14.2.3Completion Update Details

A request to update the state of a completion. The completion must be associated with a processor created by the invoking payment web app.

Properties
  • failureReason
    Long
    Failure Reason
    The reason for the completion's failure. This field is mandatory when the target state is set to 'FAILED'.
  • reference
    String
    ≤ 100 chars
    A unique identifier for the completion within the systems of the external service provider. This field is mandatory when the target state is set to 'SUCCESSFUL'.
  • targetState
    Enum
    The desired end state of the completion. Once the completion is in the target state, further updates are not allowed.
    • SUCCESSFUL
      Successful
    • FAILED
      Failed

11.14.2.4Connector Details

Properties
  • authorizationTimeout
    String Read-only
    The duration within which the authorization process for a payment should complete.
  • completionConfiguration
    Completion Configuration Read-only
    The completion configuration controlling how deferred completion is processed. If not present, deferred completion is not supported for this connector.
  • connectorConfiguration
    Payment Connector Configuration Expandable Read-only
    The connector configuration created alongside the connector within its designated space. This configuration is used in transactions created using this connector.
  • createdOn
    DateTime Read-only
    The date and time when the connector was created.
  • externalId
    String Read-only
    A client-generated nonce which uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.
  • 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 connector.
  • paymentPageEndpoint
    String Read-only
    The URL where the user is redirected to process a payment. This endpoint is provided by the external service provider.
  • processor
    Processor Expandable Read-only
    The payment app processor that the connector belongs to. This relationship is defined when the connector is created.
  • refundConfiguration
    Refund Configuration Read-only
    The refund configuration controlling the behavior for processing refunds. If not present, refunds are not supported for this connector.
  • state
    Enum Read-only
    The object's current state.
    • ACTIVE
      Active
    • DELETED
      Deleted
  • updatedOn
    DateTime Read-only
    The date and time when the connector was last updated.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.14.2.5Connector Details Details

Properties
  • authorizationTimeoutInMinutes
    Integer
    Defines the time limit for payment authorization. Transactions are marked as failed if the payment is not authorized within the set time.
  • completionConfiguration
    Completion Configuration Create
    Enables deferred completions for transactions. If this configuration is not provided, the connector will not support deferred transactions.
  • connector
    Long
    Payment Connector
    The unique identifier for the payment connector, linking it to the payment method implemented by this web app connector.
  • name
    String
    ≤ 100 chars
    The name used to identify the connector.
  • paymentPageEndpoint
    String
    URL
    The URL invoked by the buyer to authorize the payment process.
  • refundConfiguration
    Refund Configuration Create
    Enables support for processing refunds on transactions. If not set, the connector will not support refunds.

11.14.2.6Processor Details

Properties
  • configuredEnvironment
    Enum Read-only
    The environment (e.g., test or production) currently configured for the processor.
    • PRODUCTION
      Production
    • TEST
      Test
  • createdOn
    DateTime Read-only
    The date and time when the processor was created.
  • documentationUrl
    String Read-only
    A URL pointing to the documentation that explains how to configure and use the processor.
  • externalId
    String Read-only
    A client-generated nonce which uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.
  • id
    Long Read-only
    A unique identifier for the object.
  • installationId
    Long Read-only
    The installation ID identifies the Web App installation.
  • linkedSpaceId
    Long
    Space
    Read-only
    The ID of the space this object belongs to.
  • name
    String Read-only
    The name used to identify the processor.
  • processorConfiguration
    Payment Processor Configuration Expandable Read-only
    The processor configuration created alongside the process within its designated space. This configuration is used in transactions created using this processor.
  • productionModeUrl
    String Read-only
    A URL pointing to the site where merchants can set up production mode for the processor.
  • state
    Enum Read-only
    The object's current state.
    • ACTIVE
      Active
    • DELETED
      Deleted
  • svgIcon
    String Read-only
    An SVG icon representing the processor, displayed to the user in the interface.
  • updatedOn
    DateTime Read-only
    The date and time when the processor was last updated.
  • usableInProduction
    Boolean Read-only
    Whether the processor is fully prepared and available for handling transactions in a production environment.
  • usableInProductionSince
    DateTime Read-only
    the date and time when the processor became fully usable and available for handling transactions in a production environment.
  • version
    Integer Read-only
    The version is used for optimistic locking and incremented whenever the object is updated.

11.14.2.7Processor Details Details

Properties
  • documentationUrl
    String
    URL
    A URL pointing to the documentation that explains how to configure and use the processor.
  • name
    String
    ≤ 100 chars
    The name used to identify the processor.
  • productionModeUrl
    String
    URL
    A URL pointing to the site where merchants can set up production mode for the processor.
  • svgIcon
    String
    ≤ 10,000 chars
    An SVG icon representing the processor, displayed to the user in the interface.

11.14.2.8Refund Configuration Details

Properties
  • multipleRefundsSupported
    Boolean Read-only
    Whether the payment connector can process multiple refunds for a single transaction.
  • refundEndpoint
    String Read-only
    The URL that the payment service provider will invoke to process a refund request. This endpoint handles communication with the provider for initiating and managing refunds.
  • refundTimeoutInMinutes
    Integer Read-only
    The maximum time (in minutes) to wait for a response from the payment service provider after a refund request is triggered. If no feedback or final status is received within this period, the refund is considered failed.

11.14.2.9Refund Update Details

A request to update the state of a refund. The refund must be associated with a processor created by the invoking payment web app.

Properties
  • failureReason
    Long
    Failure Reason
    The reason for the refund's failure. This field is mandatory when the target state is set to 'FAILED'.
  • reference
    String
    ≤ 100 chars
    A unique identifier for the refund within the systems of the external service provider. This field is mandatory when the target state is set to 'SUCCESSFUL'.
  • targetState
    Enum
    The desired end state of the refund. Once the refund is in the target state, further updates are not allowed.
    • SUCCESSFUL
      Successful
    • FAILED
      Failed

11.14.2.10Void Update Details

A request to update the state of a void. The void must be associated with a processor created by the invoking payment web app.

Properties
  • failureReason
    Long
    Failure Reason
    The reason for the void's failure. This field is mandatory when the target state is set to 'FAILED'.
  • reference
    String
    ≤ 100 chars
    A unique identifier for the void within the systems of the external service provider. This field is mandatory when the target state is set to 'SUCCESSFUL'.
  • targetState
    Enum
    The desired end state of the void. Once the void is in the target state, further updates are not allowed.
    • SUCCESSFUL
      Successful
    • FAILED
      Failed

11.15Webhook

11.15.1.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.15.1.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.15.1.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.15.1.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.