Documentation
account account
  • active
    boolean
    Active means that this account and all accounts in the hierarchy are active.
  • activeOrRestrictedActive
    boolean
    This property is true when all accounts in the hierarchy are active or restricted active.
  • createdBy
    bigint
    The ID of the user who created this entity.
  • createdOn
    timestamp
    The date and time when this entity was created.
  • deletedBy
    bigint
    The ID of a user that deleted this entity.
  • deletedOn
    timestamp
    The date and time when this entity was deleted.
  • id
    bigint
    The ID is the primary key of the entity. The ID identifies the entity uniquely.
  • lastModifiedDate
    timestamp
     
  • name
    string
    The name of the account identifies the account within the administrative interface.
  • bigint
    The account which is responsible for administering the account.
  • restrictedActive
    boolean
    Restricted active means that at least one account in the hierarchy is only restricted active, but all are either restricted active or active.
  • scope
    bigint
    This is the scope to which the account belongs to.
  • state
    string
     
  • subaccountLimit
    bigint
    This property restricts the number of subaccounts which can be created within this account.
  • type
    string
    The account type defines which role and capabilities it has.
failurereason failurereason
  • category
    string
     
  • description
    map
     
  • id
    bigint
    The ID is the primary key of the entity. The ID identifies the entity uniquely.
  • name
    map
     
labeldescriptor labeldescriptor
  • category
    string
     
  • description
    map
     
  • bigint
     
  • id
    bigint
    The ID is the primary key of the entity. The ID identifies the entity uniquely.
  • name
    map
     
  • weight
    int
     
labeldescriptorgroup labeldescriptorgroup
  • description
    map
     
  • id
    bigint
    The ID is the primary key of the entity. The ID identifies the entity uniquely.
  • name
    map
     
  • weight
    int
     
space space
  • bigint
    The account to which the space belongs to.
  • active
    boolean
    Active means that this account and all accounts in the hierarchy are active.
  • activeOrRestrictedActive
    boolean
    This property is true when all accounts in the hierarchy are active or restricted active.
  • createdBy
    bigint
    The ID of the user who created this entity.
  • createdOn
    timestamp
    The date and time when this entity was created.
  • deletedBy
    bigint
    The ID of a user that deleted this entity.
  • deletedOn
    timestamp
    The date and time when this entity was deleted.
  • id
    bigint
    The ID is the primary key of the entity. The ID identifies the entity uniquely.
  • lastModifiedDate
    timestamp
     
  • name
    string
    The space name is used internally to identify the space in administrative interfaces. For example it is used within search fields and hence it should be distinct and descriptive.
  • postalAddress.city
    string
     
  • postalAddress.country
    string
     
  • postalAddress.dependentLocality
    string
     
  • postalAddress.emailAddress
    string
     
  • postalAddress.familyName
    string
     
  • postalAddress.givenName
    string
     
  • postalAddress.organizationName
    string
     
  • postalAddress.postalState
    string
     
  • postalAddress.postcode
    string
     
  • postalAddress.salesTaxNumber
    string
     
  • postalAddress.salutation
    string
     
  • postalAddress.sortingCode
    string
     
  • postalAddress.street
    string
     
  • postalAddress
    struct
    The address to use in communication with clients for example in email, documents etc.
  • primaryCurrency
    string
    This is the currency that is used to display aggregated amounts in the space.
  • requestLimit
    bigint
    The request limit defines the maximum number of API request accepted within 2 minutes for this space. This limit can only be changed with special privileges.
  • restrictedActive
    boolean
    Restricted active means that at least one account in the hierarchy is only restricted active, but all are either restricted active or active.
  • state
    string
     
  • technicalContactAddresses
    array
    The email address provided as contact addresses will be informed about technical issues or errors triggered by the space.
  • timeZone
    string
    The time zone assigned to the space determines the time offset for calculating dates within the space. This is typically used for background processed which needs to be triggered on a specific hour within the day. Changing the space time zone will not change the display of dates.
legalorganizationform legalorganizationform
  • country
    string
     
  • description
    array
     
  • englishDescription
    string
     
  • id
    bigint
    The ID is the primary key of the entity. The ID identifies the entity uniquely.
  • shortcut
    array
     
customer customer
  • createdOn
    timestamp
    The created on date indicates the date on which the entity was stored into the database.
  • customerId
    string
     
  • emailAddress
    string
     
  • familyName
    string
     
  • givenName
    string
     
  • id
    bigint
    The ID is the primary key of the entity. The ID identifies the entity uniquely.
  • language
    string
     
  • metaData
    map
    Meta data allow to store additional data along the object.
  • preferredCurrency
    string
     
customeraddress customeraddress
  • address.city
    string
     
  • address.commercialRegisterNumber
    string
     
  • address.country
    string
     
  • address.dateOfBirth
    date
     
  • address.dependentLocality
    string
     
  • address.emailAddress
    string
     
  • address.familyName
    string
     
  • address.gender
    string
     
  • address.givenName
    string
     
  • bigint
     
  • address.mobilePhoneNumber
    string
     
  • address.organizationName
    string
     
  • address.phoneNumber
    string
     
  • address.postalState
    string
     
  • address.postcode
    string
     
  • address.salesTaxNumber
    string
     
  • address.salutation
    string
     
  • address.socialSecurityNumber
    string
     
  • address.sortingCode
    string
     
  • address.street
    string
     
  • address
    struct
     
  • addressType
    string
     
  • createdOn
    timestamp
    The created on date indicates the date on which the entity was stored into the database.
  • bigint
     
  • defaultAddress
    boolean
     
  • id
    bigint
    The ID is the primary key of the entity. The ID identifies the entity uniquely.
saleschannel saleschannel
  • description
    map
     
  • id
    bigint
    The ID is the primary key of the entity. The ID identifies the entity uniquely.
  • name
    map
     
  • bigint
     
  • sortOrder
    int
     
paymentconnector paymentconnector
  • dataCollectionType
    string
     
  • deprecated
    boolean
     
  • deprecationReason
    map
     
  • description
    map
     
  • id
    bigint
    The ID is the primary key of the entity. The ID identifies the entity uniquely.
  • name
    map
     
  • bigint
     
  • bigint
     
  • primaryRiskTaker
    string
     
  • bigint
     
paymentconnectorconfiguration paymentconnectorconfiguration
  • applicableForTransactionProcessing
    boolean
    This property indicates if the connector is currently used for processing transactions. In case either the payment method configuration or the processor configuration is not active the connector will not be used even though the connector state is active.
  • bigint
     
  • enabledSalesChannels
    array
    Defines the sales channels the connector configuration is enabled for. In case the set is empty, the connector configuration is enabled for all sales channels.
  • enabledSpaceViews
    array
    The connector configuration is only enabled for the selected space views. In case the set is empty the connector configuration is enabled for all space views.
  • id
    bigint
    The ID is the primary key of the entity. The ID identifies the entity uniquely.
  • name
    string
    The connector configuration name is used internally to identify the configuration in administrative interfaces. For example it is used within search fields and hence it should be distinct and descriptive.
  • bigint
     
  • priority
    int
    The priority will define the order of choice of the connector configurations. The lower the value, the higher the priority is going to be. This value can also be a negative number in case you are adding a new configuration that you want to have a high priority and you dont want to change the priority of all the other configurations.
  • bigint
     
  • state
    string
     
paymentmethod paymentmethod
  • dataCollectionTypes
    array
     
  • description
    map
     
  • id
    bigint
    The ID is the primary key of the entity. The ID identifies the entity uniquely.
  • merchantDescription
    map
     
  • name
    map
     
  • supportedCurrencies
    array
     
paymentmethodbrand paymentmethodbrand
  • description
    map
     
  • id
    bigint
    The ID is the primary key of the entity. The ID identifies the entity uniquely.
  • name
    map
     
  • bigint
     
paymentmethodconfiguration paymentmethodconfiguration

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

The payment method configuration builds the base to connect with different payment method connectors.
  • dataCollectionType
    string
    The data collection type determines who is collecting the payment information. This can be done either by the processor (offsite) or by our application (onsite).
  • id
    bigint
    The ID is the primary key of the entity. The ID identifies the entity uniquely.
  • name
    string
    The payment method configuration name is used internally to identify the payment method configuration. For example the name is used within search fields and hence it should be distinct and descriptive.
  • oneClickPaymentMode
    string
    When the buyer is present on the payment page or within the iFrame the payment details can be stored automatically. The buyer will be able to use the stored payment details for subsequent transactions. When the transaction already contains a token one-click payments are disabled anyway
  • bigint
     
  • resolvedDescription
    map
    The resolved description uses the specified description or the default one when it is not overridden.
  • resolvedTitle
    map
    The resolved title uses the specified title or the default one when it is not overridden.
  • sortOrder
    int
    The sort order of the payment method determines the ordering of the methods shown to the user during the payment process.
  • state
    string
     
paymentprocessor paymentprocessor
  • companyName
    map
     
  • description
    map
     
  • headquartersLocation
    map
     
  • id
    bigint
    The ID is the primary key of the entity. The ID identifies the entity uniquely.
  • name
    map
     
  • productName
    map
     
paymentprocessorconfiguration paymentprocessorconfiguration
  • contractId
    bigint
    The contract links the processor configuration with the contract that is used to process payments.
  • id
    bigint
    The ID is the primary key of the entity. The ID identifies the entity uniquely.
  • name
    string
    The processor configuration name is used internally to identify a specific processor configuration. For example the name is used within search fields and hence it should be distinct and descriptive.
  • bigint
    A processor handles the connection to a third part company (a Payment Service Provider) that technically manages the transaction and therefore processes the payment. For the same processor multiple processor configuration can be setup.
  • state
    string
     
refund refund

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

The refund represents a credit back to the customer. It can be issued by the merchant or by the customer (reversal).
  • amount
    decimal
     
  • baseLineItems
    array
     
  • bigint
     
  • createdBy
    bigint
     
  • createdOn
    timestamp
    The created on date indicates the date on which the entity was stored into the database.
  • environment
    string
     
  • externalId
    string
    The external id helps to identify duplicate calls to the refund service. As such the external ID has to be unique per transaction.
  • failedOn
    timestamp
     
  • bigint
     
  • id
    bigint
    The ID is the primary key of the entity. The ID identifies the entity uniquely.
  • labels
    array
     
  • language
    string
     
  • lineItems
    array
     
  • merchantReference
    string
     
  • nextUpdateOn
    timestamp
     
  • processingOn
    timestamp
     
  • processorReference
    string
     
  • reducedLineItems
    array
     
  • reductions
    array
     
  • state
    string
     
  • succeededOn
    timestamp
     
  • taxes
    array
     
  • timeZone
    string
     
  • timeoutOn
    timestamp
     
  • totalAppliedFees
    decimal
    The total applied fees is the sum of all fees that have been applied so far.
  • totalSettledAmount
    decimal
    The total settled amount is the total amount which has been settled so far.
  • bigint
     
  • type
    string
     
  • bigint
     
paymentterminal paymentterminal
  • defaultCurrency
    string
     
  • id
    bigint
    The ID is the primary key of the entity. The ID identifies the entity uniquely.
  • identifier
    string
    The identifier uniquely identifies the terminal. Normally it is visible on the device or in the display of the device.
  • name
    string
    The terminal name is used internally to identify the terminal in administrative interfaces. For example it is used within search fields and hence it should be distinct and descriptive.
  • state
    string
     
  • bigint
     
paymentterminaltype paymentterminaltype
  • description
    map
     
  • id
    bigint
    The ID is the primary key of the entity. The ID identifies the entity uniquely.
  • name
    map
     
token token
  • createdOn
    timestamp
    The created on date indicates the date on which the entity was stored into the database.
  • customerEmailAddress
    string
    The customer email address is the email address of the customer.
  • customerId
    string
    The customer ID identifies the customer in the merchant system. In case the customer ID has been provided it has to correspond with the customer ID provided on the transaction. The customer ID will not be changed automatically. The merchant system has to provide it.
  • enabledForOneClickPayment
    boolean
    When a token is enabled for one-click payments the buyer will be able to select the token within the iFrame or on the payment page to pay with the token. The usage of the token will reduce the number of steps the buyer has to go through. The buyer is linked via the customer ID on the transaction with the token. Means the token will be visible for buyers with the same customer ID. Additionally the payment method has to be configured to allow the one-click payments.
  • externalId
    string
    A client generated nonce which identifies the entity to be created. Subsequent creation requests with the same external ID will not create new entities but return the initially created entity instead.
  • id
    bigint
    The ID is the primary key of the entity. The ID identifies the entity uniquely.
  • language
    string
     
  • state
    string
     
  • timeZone
    string
    The time zone defines in which time zone the customer is located in. The time zone may affects how dates are formatted when interacting with the customer.
  • tokenReference
    string
    Use something that it is easy to identify and may help you find the token (e.g. customer id, email address).
transaction transaction
  • acceptHeader
    string
     
  • acceptLanguageHeader
    string
    The accept language contains the header which indicates the language preferences of the buyer.
  • allowedPaymentMethodBrands
    array
     
  • allowedPaymentMethodConfigurations
    array
     
  • authorizationAmount
    decimal
     
  • authorizationEnvironment
    string
    The environment in which this transaction was successfully authorized.
  • bigint
    The sales channel through which the transaction was placed.
  • authorizationTimeoutOn
    timestamp
    This is the time on which the transaction will be timed out when it is not at least authorized. The timeout time may change over time.
  • authorizedOn
    timestamp
     
  • autoConfirmationEnabled
    boolean
    When auto confirmation is enabled the transaction can be confirmed by the user and does not require an explicit confirmation through the web service API.
  • billingAddress.city
    string
     
  • billingAddress.commercialRegisterNumber
    string
     
  • billingAddress.country
    string
     
  • billingAddress.dateOfBirth
    date
     
  • billingAddress.dependentLocality
    string
     
  • billingAddress.emailAddress
    string
     
  • billingAddress.familyName
    string
     
  • billingAddress.gender
    string
     
  • billingAddress.givenName
    string
     
  • bigint
     
  • billingAddress.mobilePhoneNumber
    string
     
  • billingAddress.organizationName
    string
     
  • billingAddress.phoneNumber
    string
     
  • billingAddress.postalState
    string
     
  • billingAddress.postcode
    string
     
  • billingAddress.salesTaxNumber
    string
     
  • billingAddress.salutation
    string
     
  • billingAddress.socialSecurityNumber
    string
     
  • billingAddress.sortingCode
    string
     
  • billingAddress.street
    string
     
  • billingAddress
    struct
     
  • chargeRetryEnabled
    boolean
    When the charging of the customer fails we can retry the charging. This implies that we redirect the user back to the payment page which allows the customer to retry. By default we will retry.
  • completedAmount
    decimal
    The completed amount is the total amount which has been captured so far.
  • completedOn
    timestamp
     
  • completionBehavior
    string
    The completion behavior controls when the transaction is completed.
  • completionTimeoutOn
    timestamp
     
  • confirmedBy
    bigint
     
  • confirmedOn
    timestamp
     
  • createdBy
    bigint
     
  • createdOn
    timestamp
    The created on date indicates the date on which the entity was stored into the database.
  • currency
    string
     
  • customerEmailAddress
    string
    The customer email address is the email address of the customer. If no email address is provided on the shipping or billing address this address is used.
  • customerId
    string
     
  • customersPresence
    string
    The customer's presence indicates what kind of authentication methods can be used during the authorization of the transaction. If no value is provided, 'Virtually Present' is used by default.
  • deliveryDecisionMadeOn
    timestamp
    This date indicates when the decision has been made if a transaction should be delivered or not.
  • deviceSessionIdentifier
    string
    The device session identifier links the transaction with the session identifier provided in the URL of the device data JavaScript. This allows to link the transaction with the collected device data of the buyer.
  • emailsDisabled
    boolean
    Flag indicating whether email sending is disabled for this particular transaction. Defaults to false.
  • environment
    string
     
  • environmentSelectionStrategy
    string
    The environment selection strategy determines how the environment (test or production) for processing the transaction is selected.
  • failedOn
    timestamp
     
  • failedUrl
    string
    The user will be redirected to failed URL when the transaction could not be authorized or completed. In case no failed URL is specified a default failed page will be displayed.
  • bigint
    The failure reason describes why the transaction failed. This is only provided when the transaction is marked as failed.
  • id
    bigint
    The ID is the primary key of the entity. The ID identifies the entity uniquely.
  • internetProtocolAddress
    string
    The Internet Protocol (IP) address identifies the device of the buyer.
  • internetProtocolAddressCountry
    string
     
  • invoiceMerchantReference
    string
     
  • javaEnabled
    boolean
     
  • language
    string
     
  • lineItems
    array
     
  • merchantReference
    string
     
  • metaData
    map
    Meta data allow to store additional data along the object.
  • bigint
     
  • bigint
     
  • processingOn
    timestamp
     
  • refundedAmount
    decimal
    The refunded amount is the total amount which has been refunded so far.
  • screenColorDepth
    string
     
  • screenHeight
    string
     
  • screenWidth
    string
     
  • shippingAddress.city
    string
     
  • shippingAddress.commercialRegisterNumber
    string
     
  • shippingAddress.country
    string
     
  • shippingAddress.dateOfBirth
    date
     
  • shippingAddress.dependentLocality
    string
     
  • shippingAddress.emailAddress
    string
     
  • shippingAddress.familyName
    string
     
  • shippingAddress.gender
    string
     
  • shippingAddress.givenName
    string
     
  • bigint
     
  • shippingAddress.mobilePhoneNumber
    string
     
  • shippingAddress.organizationName
    string
     
  • shippingAddress.phoneNumber
    string
     
  • shippingAddress.postalState
    string
     
  • shippingAddress.postcode
    string
     
  • shippingAddress.salesTaxNumber
    string
     
  • shippingAddress.salutation
    string
     
  • shippingAddress.socialSecurityNumber
    string
     
  • shippingAddress.sortingCode
    string
     
  • shippingAddress.street
    string
     
  • shippingAddress
    struct
     
  • shippingMethod
    string
     
  • spaceViewId
    bigint
     
  • state
    string
     
  • successUrl
    string
    The user will be redirected to success URL when the transaction could be authorized or completed. In case no success URL is specified a default success page will be displayed.
  • bigint
    The terminal on which the payment was processed.
  • timeZone
    string
    The time zone defines in which time zone the customer is located in. The time zone may affects how dates are formatted when interacting with the customer.
  • bigint
     
  • tokenizationMode
    string
    The tokenization mode controls if and how the tokenization of payment information is applied to the transaction.
  • totalAppliedFees
    decimal
    The total applied fees is the sum of all fees that have been applied so far.
  • totalSettledAmount
    decimal
    The total settled amount is the total amount which has been settled so far.
  • userAgentHeader
    string
    The user agent header provides the exact string which contains the user agent of the buyer.
  • userFailureMessage
    string
    The failure message describes for an end user why the transaction is failed in the language of the user. This is only provided when the transaction is marked as failed.
  • userInterfaceType
    string
    The user interface type defines through which user interface the transaction has been processed resp. created.
  • windowHeight
    string
     
  • windowWidth
    string
     
transactioncompletion transactioncompletion
  • amount
    decimal
    The amount which is captured. The amount represents sum of line items including taxes.
  • baseLineItems
    array
    The base line items on which the completion is applied on.
  • createdBy
    bigint
     
  • createdOn
    timestamp
    The created on date indicates the date on which the entity was stored into the database.
  • externalId
    string
    The external ID helps to identify the entity and a subsequent creation of an entity with the same ID will not create a new entity.
  • failedOn
    timestamp
     
  • id
    bigint
    The ID is the primary key of the entity. The ID identifies the entity uniquely.
  • invoiceMerchantReference
    string
     
  • labels
    array
     
  • language
    string
     
  • lastCompletion
    boolean
    Indicates if this is the last completion. After the last completion is created the transaction cannot be completed anymore.
  • lineItems
    array
    The line items which are captured.
  • bigint
     
  • mode
    string
     
  • nextUpdateOn
    timestamp
     
  • paymentInformation
    string
     
  • processingOn
    timestamp
     
  • processorReference
    string
     
  • remainingLineItems
    array
     
  • spaceViewId
    bigint
     
  • state
    string
     
  • succeededOn
    timestamp
     
  • taxAmount
    decimal
    The total sum of all taxes of line items.
  • timeZone
    string
     
  • timeoutOn
    timestamp
     
transactioninvoice transactioninvoice

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

The transaction invoice represents the invoice document for a particular transaction.
  • amount
    decimal
     
  • billingAddress.city
    string
     
  • billingAddress.commercialRegisterNumber
    string
     
  • billingAddress.country
    string
     
  • billingAddress.dateOfBirth
    date
     
  • billingAddress.dependentLocality
    string
     
  • billingAddress.emailAddress
    string
     
  • billingAddress.familyName
    string
     
  • billingAddress.gender
    string
     
  • billingAddress.givenName
    string
     
  • bigint
     
  • billingAddress.mobilePhoneNumber
    string
     
  • billingAddress.organizationName
    string
     
  • billingAddress.phoneNumber
    string
     
  • billingAddress.postalState
    string
     
  • billingAddress.postcode
    string
     
  • billingAddress.salesTaxNumber
    string
     
  • billingAddress.salutation
    string
     
  • billingAddress.socialSecurityNumber
    string
     
  • billingAddress.sortingCode
    string
     
  • billingAddress.street
    string
     
  • billingAddress
    struct
     
  • bigint
     
  • createdOn
    timestamp
    The date on which the invoice is created on.
  • derecognizedBy
    bigint
    The id of the user which marked the invoice as derecognized.
  • derecognizedOn
    timestamp
    The date on which the invoice is marked as derecognized.
  • dueOn
    timestamp
    The date on which the invoice should be paid on.
  • environment
    string
     
  • externalId
    string
    The external id helps to identify the entity and a subsequent creation of an entity with the same ID will not create a new entity.
  • id
    bigint
    The ID is the primary key of the entity. The ID identifies the entity uniquely.
  • language
    string
     
  • lineItems
    array
     
  • bigint
     
  • merchantReference
    string
     
  • outstandingAmount
    decimal
    The outstanding amount indicates how much the buyer owes the merchant. A negative amount indicates that the invoice is overpaid.
  • paidOn
    timestamp
    The date on which the invoice is marked as paid. Eventually this date lags behind of the actual paid date.
  • spaceViewId
    bigint
     
  • state
    string
     
  • taxAmount
    decimal
     
  • timeZone
    string