Introduction

Our API is based on the REST software architectural style and provides a secure and comfortable way to perform payments.

API errors are indicated by the corresponding HTTP response codes. This topic is further described in the section Error Handling

In addition to our payment solutions, the API supports mutliple features like our Auxiliary Services. Have a look into our Documentation to gain a deeper understanding of our various products.

Having a 90 second timeout interval allows handling of delays dependent on different queries and responses form external systems and payment providers.

 API Authentication

A web client integration must include an authentication token as part of the HTTP header for all but a few anonymous API methods. Use the provided credentials when requesting an authentication token via the API method 1.45 Issue Token.

The response will include the JWT authentication token under the return parameter "token" which you include in the HTTP header when calling other API methods via the custom header field "X-Auth-Token" or "Authorization".

Authentication means one of the following:
A security token in the form of JWT to be present in the custom authentication header. To get an assertion, call the "Issue Token" or the "Issue Oauth Token" method.
A request signed by a non-expired certificate that belongs to active and not-locked user.

Please note, that authentication tokens have a limited validity period - their expiration time (UTC) is communicated to you via the return parameter "validUntil". The token can be used until the expiration time and should be replaced by a new one shortly before the expiration. By persisting the token alongside the expiration time, it is possible to call multiple API methods with the same token until it expires. It is recommended that tokens are reused instead of requested for each API method call in order to avoid a perception of a performance issue in web applications.

 1.45 Issue Token

post {baseURL}/user/{userId}/issue

This method is called to authenticate the caller and get a security token. Attach this security token to all other API method calls.

Request parameters

userId
String Length: 255 Required

Caller user identifier in the KontoCloud system.

password
String Length: 128 Required

Caller password in the KontoCloud system.

localDate
YYYY-MM-DD Length: 10 Required

The current date of the caller.

localTime
HHMMSS Length: 6 Required

The current time of the caller.

Request Sample

Path:

POST {baseURL}/user/user@example.com/issue

Header:

Content-Type: application/json
Accept-Language: en-US

{
  "password": "3x4mpl3Pa$$w0rd",
  "localDate": "2020-12-31",
  "localTime": "235959"
}

Response parameters

token
String Length: 32768

Security token.

validUntil
YYYY-MM-DD Length: 24

Token validity period in UTC.

localDate
YYYY-MM-DD Length: 10

The current date of the caller.

localTime
HHMMSS Length: 6

The current time of the caller.

sysDate
YYYY-MM-DD Length: 10

The current date of the KontoCloud server

sysTime
HHMMSS Length: 6

The current time of the KontoCloud server

responseCode
String Length: 4

The response code. See Response Codes in the Lookups.

responseDescription
String Length: 512

The response description. See Response Codes in the Lookups.

Response Sample

Status Code:

200 (OK)

Header:

Content-Type: application/json
Accept-Language: en-US

{
  "token": "eyJhbGciOiJSUzI1NiI{abbreviated}RW5kVG9rZW4=",
  "validUntil": "2020-12-31T23:59:59.001Z",
  "localDate": "2020-12-31",
  "localTime": "235959",
  "sysDate": "2020-12-31",
  "sysTime": "235959",
  "responseCode": "0000",
  "responseDescription": "Successful execution.",
    "additionalInformation": {
        "requestId": "aff2728481a181dc36daedc14055b516"
    }
}

 Error Handling

The platform has standardized error codes made up of four digits, which are returned under the “responseCode” return parameter. i.e. these do not change and should be used as part of exception handling logic.

Errors can be broadly classified as Logical Errors and Unexpected Errors.

Communication of errors to end users

Technical error codes or other details of why a request could not be completed, must not be disclosed to an end user directly, as this might increase the risk of fraudulent activity.

Especially when it comes to credit card fraud, fraudsters often target websites that give a different response to different types of declination (e.g. where one response is returned for the amount exceeding the available credit and another where a card is flagged as stolen).

Thus in the interest of data protection and to prevent malicious activity, we recommend having a single response towards the end user for all types of declined transactions:

Currently your request cannot be processed, error code xxx. Please retry using a different payment option and if the issue persists contact our support team by email ({0}) or by phone ({1})”

Doing so increases the difficulty of malicious activity especially the probing of automatically generated card numbers.

From the end user's perspective this means that after the first payment failure, they should be prompted to retry having validated their entered payment option details. They should also be advised that if the payment option continues to fail, that they should contact their bank (or other financial institution) to ascertain the exact reason(s) of declination or to try an alternative payment option.

In the cases when a service request needs to be submitted, please include the following technical identifiers:

  • the 4-digit numeric responseCode (error)
  • "requestId" (returned in the api response)
  • "partnerReference" (request & response)
  • "uniqueReference" (if such is applicable)
  • the timestamp of when the error occurred
  • the user's account number (if applicable)

Capture Error Handling

An authorization is generally a guarantee that a capture should succeed. However a capture can nonetheless fail due to errors between the Gateway and Acquirer. You can retry your request up to 3 times. If the error continues to persist, you can contact Customer Support for details.

Logical Errors

On the right you find a response sample of a handled exception. The Response Code 0001 indicates that mandatory fields are missing or syntax errors (e.g. wrong datatype, spelling) exist in the API request.

Another important exception has the response code 0096 and occurs when the user tries to perform an unauthorized API call. This means that the provided X-Auth-Token in the HTTP-Header is either missing or invalid (see section API Authentication).

Please note, that the response codes 0058 and 0098 allow a retry of the API call up to 3 times.

In most cases, the response code provides enough information, which allow you to further investigate the source of the error. Otherwise you can contact our Customer Support.

 

 

 

Response sample

Status Code:

400 (Bad Request)

Header:

Content-Type: application/json
Accept-Language: en-US

{
"partnerReference": "78838436FDD0445081099C7D931F7041",
"responseCode": "0001",
"responseDescription": "One or more of the required fields has not been sent or was not properly received by the API: 'programCode'.",
    "additionalInformation": {
        "requestId": "aff2728481a181dc36daedc14055b516"
    }
}

Unexpected Errors

On the right you find a response sample of an unhandled exception.

You can retry your request up to 3 times. If the error continues to persist, you can contact our Customer Support for details.

 

Response sample

Status Code:

500 (Internal Server Error)

Header:

Content-Type: application/json
Accept-Language: en-US

{
"partnerReference": "78838436FDD0445081099C7D931F7041",
"sysDate": "2021-02-20",
"sysTime": "054749",
"responseCode": "0099",
"responseDescription": "Unexpected server error occurred.",
    "additionalInformation": {
        "requestId": "aff2728481a181dc36daedc14055b516"
    }
}

 Account Management

 1.1 Create Account

put {baseURL}/account

This method is used to create an e-wallet account.

Request parameters

externalAccountReference
String Length: 255

Account reference to identify the account in the future by the partners in their system.

partnerReference
String Length: 64 Required

Partner service call identifier.

programCode
String Length: 10 Required

Program code

accountApplicationFlowCode
String Length: 10

Code of the account application flow. A program default flow of Type "E-Wallet User" is used if a value is not provided.

currCode
String Length: 3 Required

Currency code of the account to be opened.

validFrom
YYYY-MM-DD Length: 10

Start date of the account.

loginID
String Length: 255

Login ID of the customer using the service.

title
String Length: 2

Customer's title. See Title Codes in the Lookups.

lastName
String Length: 100 Required

Customer's last name.

firstName
String Length: 100 Required

Customer's first name.

culture
String Length: 14

User culture, based on RFC 4646. For example, "de-DE".

addr1
String Length: 60 Required

Address line 1.

addr2
String Length: 60

Address line 2.

addr3
String Length: 60

Address line 3.

houseNumber
String Length: 10

House number.

city
String Length: 50 Required

City name.

state
String Length: 50

State name.

countryCode
String Length: 3 Required

Country ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code.

postCode
String Length: 10 Required

Postal code.

dob
YYYY-MM-DD Length: 10 Required

Date of birth.

placeOfBirth
String Length: 100

Place of birth.

landlinePhone
String Length: 30

Landline phone number.

mobilePhone
String Length: 30

Mobile phone number.

emailAddress
String Length: 255 Required

Email address for any notification.

useDifferentCorrespondenceAddress
Boolean Required

Defines whether a different correspondence address is used. If true, the fields 'correspondenceAddr1', 'correspondenceCity', 'correspondenceCountryCode', 'correspondencePostCode' are required. If false, the fields listed above are optional.

correspondenceAddr1
String Length: 60

Correspondence address line 1.

correspondenceAddr2
String Length: 60

Correspondence address line 2.

correspondenceAddr3
String Length: 60

Correspondence address line 3.

correspondenceHouseNumber
String Length: 10

Correspondence house number.

correspondenceCity
String Length: 50

Correspondence city name.

correspondenceState
String Length: 50

Correspondence state name.

correspondenceCountryCode
String Length: 3

Correspondence country ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code.

correspondencePostCode
String Length: 10

Correspondence postal code.

occupation
String Length: 50

A job or profession.

nationality
String Length: 3 Required

The ISO2 or ISO3 code of a country a new user is a national of.

taxId
String Length: 50

Tax identification number.

identificationDocumentType
String Length: 50

Type of the new user's identification document e.g. passport.

identityNumber
String Length: 20

Identification document number.

documentIssuingCountryCode
String Length: 3

The ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code of a country that issued the identification document.

dateOfExpiry
YYYY-MM-DD Length: 10

Expiry date of the identification document.

sourceOfWealth
String Length: 50

The activity which generated the new user's total net worth.

sourceOfFunds
String Length: 50

The main activity which generates the new user's funds for this ewallet.

isPep
Boolean

Is the new user or his/her family member a politically exposed person.

isBusinessUser
Boolean

Defines whether business information is provided for a user.
Default value is false.

If true, the fields 'businessCompanyName', 'businessCompanyType', 'businessCompanyRegistrationNumber', 'businessCompanyRegistrationCountry', 'businessAddr1', 'businessCity', 'businessPostCode', 'businessCountryCode' are required.

If false, the fields listed above are optional.

businessCompanyName
String Length: 201

Company legal name.

businessCompanyType
String Length: 100

Company legal type.

businessCompanyRegistrationNumber
String Length: 50

Company registration number.

businessCompanyRegistrationCountryCode
String Length: 3

Company registration country ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code.

businessAddr1
String Length: 60

Company address line 1.

businessAddr2
String Length: 60

Company address line 2.

businessAddr3
String Length: 60

Company address line 3.

businessHouseNumber
String Length: 10

Company house number.

businessCity
String Length: 50

Company city name.

businessPostCode
String Length: 10

Company post code.

businessState
String Length: 50

Company state name.

businessCountryCode
String Length: 3

Company country ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code.

businessUrl
String Length: 255

Company website URL.

userAgreementReference
String Length: 36

Reference to the user agreement text.

localDate
YYYY-MM-DD Length: 10 Required

The current date of the caller.

localTime
HHMMSS Length: 6 Required

The current time of the caller.

Request sample

Path:

PUT {baseURL}/account

Header:

Content-Type: application/json
Accept-Language: en-US
X-Auth-Token: eyJhbGciOiJSUzI1NiI{abbreviated}RW5kVG9rZW4=

{
 "externalAccountReference": "CUSTID1234567890",
 "partnerReference": "50F45B51E07D4CE1ABB1676E3DF5BB44",
 "programCode": "COMPANY123",
 "accountApplicationFlowCode": "BIZ",
 "currCode": "EUR",
 "validFrom": "2016-01-31",
 "loginID": "firstname_lastname",
 "title": "1",
 "lastName": "Lastname",
 "firstName": "Firstname",
 "addr1": "123 Anystreet",
 "addr2": "Building 1a",
 "city": "Anycity",
 "state": "Anystate",
 "countryCode": "DE",
 "postCode": "POSTCOD123",
 "dob": "1990-01-31",
 "placeOfBirth": "Anycountry, Anycity",
 "landlinePhone": "+49 1234 567 890",
 "mobilePhone": "+49 1234 567 890",
 "emailAddress": "user@example.com",
 "useDifferentCorrespondenceAddress": true,
 "correspondenceAddr1": "Anystreet 321",
 "correspondenceAddr2": "Tower 1",
 "correspondenceCity": "Anycity",
 "correspondenceState": "Anystate",
 "correspondenceCountryCode": "DE",
 "correspondencePostCode": "12345",
 "occupation": "Computer systems analyst",
 "nationality": "DE",
 "identificationDocumentType": "Passport",
 "identityNumber": "P1234567890",
 "documentIssuingCountryCode": "DE",
 "dateOfExpiry": "2123-01-31",
 "sourceOfWealth": "Inheritance and Savings from Employment Income",
 "sourceOfFunds": "Insurance Payout",
 "isPep": false,
 "isBusinessUser": true,
 "businessCompanyName": "Anycompany Name",
 "businessCompanyType": "Ltd",
 "businessCompanyRegistrationNumber": "12345678",
 "businessCompanyRegistrationCountryCode": "DE",
 "businessAddr1": "Anystreet 456",
 "businessAddr2": "Building 2b",
 "businessCity": "Anycity",
 "businessState": "CA",
 "businessPostCode": "EC4M 7LS",
 "businessCountryCode": "DE",
 "businessUrl": "https://www.example.com",
 "userAgreementReference": "4CE1ABB1676E3DF5BB4450F45B51E07D",
 "localDate": "2016-01-31",
 "localTime": "131415"
}

Response parameters

partnerReference
String Length: 64

Partner service call identifier.

programCode
String Length: 10

Program code

productCode
String Length: 10

Account product of the new account.

accTypeCode
String Length: 10

Account type code of the account.

custCode
String Length: 10

Customer identifier generated by KontoCloud.

externalAccountReference
String Length: 255

Account reference to identify the account in the future by the partners in their system.

accno
String Length: 255

Account number.

statusCode
String Length: 10

Status code of the account. See Account Status Codes in the Lookups.

twoFAStatusCode
String Length: 10

Two Factor Authentication Status Code. Refer to Two Factor Authentication Status Codes in the Lookups.

accFlowStatusCode
String Length: 10

Status code of the account flow. See Account Flow Status Codes in the Lookups.

validFrom
YYYY-MM-DD Length: 10

Start date of the account.

validUntil
YYYY-MM-DD Length: 10

Expiry date of the account.

Deprecated and ignored field.

localDate
YYYY-MM-DD Length: 10

The current date of the caller.

localTime
HHMMSS Length: 6

The current time of the caller.

sysDate
YYYY-MM-DD Length: 10

The current date of the KontoCloud server

sysTime
HHMMSS Length: 6

The current time of the KontoCloud server

responseCode
String Length: 4

The response code. See Response Codes in the Lookups.

responseDescription
String Length: 512

The response description. See Response Codes in the Lookups.

Response sample

Status Code:

201 (Created)

Header:

Content-Type: application/json
Accept-Language: en-US

{
"productCode": "EWLTDBT",
"accTypeCode": "STARTBIZ",
"custCode": "22",
"externalAccountReference": "CUSTID1234567890",
"accno": "1000104149",
"statusCode": "ACTIVE",
"twoFAStatusCode": "2FADIS",
"validFrom": "2016-01-31",
"validUntil": "2999-12-31",
"accFlowStatusCode": "POPENDING",
"partnerReference": "50F45B51E07D4CE1ABB1676E3DF5BB44",
"programCode": "COMPANY123",
"localDate": "2016-01-31",
"localTime": "131415",
"sysDate": "2016-01-31",
"sysTime": "114249",
"responseCode": "0000",
"responseDescription": "Successful execution",
    "additionalInformation": {
        "requestId": "aff2728481a181dc36daedc14055b516"
    }
}

 1.4 Update Account Information

post {baseURL}/account/{accno}/updateInfo

Provides the ability to update an account holder's information.

Request parameters

accno
String Length: 255 Required

Account number.

externalAccountReference
String Length: 255

Account reference to identify the account in the future by the partners in their system.

partnerReference
String Length: 64 Required

Partner service call identifier.

programCode
String Length: 10 Required

Program code

accnoType
String Length: 2 Required

Account number type. See Account Number Type in the Lookups.

accTypeCode
String Length: 10

Account type code of the account.

title
String Length: 2

Customer's title. See Title Codes in the Lookups.

lastName
String Length: 100 Required

Customer's last name.

firstName
String Length: 100 Required

Customer's first name.

addr1
String Length: 60 Required

Address line 1.

addr2
String Length: 60

Address line 2.

addr3
String Length: 60

Address line 3.

houseNumber
String Length: 10

House number.

city
String Length: 50 Required

City name.

postCode
String Length: 10 Required

Postal code.

state
String Length: 50

State name.

countryCode
String Length: 3 Required

Country ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code.

dob
YYYY-MM-DD Length: 10 Required

Date of birth.

landlinePhone
String Length: 30

Landline phone number.

mobilePhone
String Length: 30

Mobile phone number.

emailAddress
String Length: 255 Required

Email address for any notification.

nationality
String Length: 3 Required

The ISO2 or ISO3 code of a country a new user is a national of.

culture
String Length: 14

User culture, based on RFC 4646. For example, "de-DE".

timeZone
String Length: 50

User time zone id. For example, "Central European Standard Time". See Time Zone in the Lookups.

useDifferentCorrespondenceAddress
Boolean Required

Defines whether a different correspondence address is used. If true, the fields 'correspondenceAddr1', 'correspondenceCity', 'correspondenceCountryCode', 'correspondencePostCode' are required. If false, the fields listed above are optional.

correspondenceAddr1
String Length: 60

Correspondence address line 1.

correspondenceAddr2
String Length: 60

Correspondence address line 2.

correspondenceAddr3
String Length: 60

Correspondence address line 3.

correspondenceHouseNumber
String Length: 10

Correspondence house number.

correspondenceCity
String Length: 50

Correspondence city name.

correspondenceState
String Length: 50

Correspondence state name.

correspondenceCountryCode
String Length: 3

Correspondence country ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code.

correspondencePostCode
String Length: 10

Correspondence postal code.

taxId
String Length: 50

Tax identification number.

identificationDocumentType
String Length: 50

Type of the new user's identification document e.g. passport.

identityNumber
String Length: 20

Identification document number.

documentIssuingCountryCode
String Length: 3

The ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code of a country that issued the identification document.

dateOfExpiry
YYYY-MM-DD Length: 10

Expiry date of the identification document.

notifyUser
Boolean

Defines whether the account owner is notified of the account information change. Default value is false.

businessCompanyName
String Length: 201

Company legal name.

businessCompanyType
String Length: 100

Company legal type.

businessCompanyRegistrationNumber
String Length: 50

Company registration number.

businessCompanyRegistrationCountryCode
String Length: 3

Company registration country ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code.

businessAddr1
String Length: 60

Company address line 1.

businessAddr2
String Length: 60

Company address line 2.

businessAddr3
String Length: 60

Company address line 3.

businessHouseNumber
String Length: 10

Company house number.

businessCity
String Length: 50

Company city name.

businessState
String Length: 50

Company state name.

businessPostCode
String Length: 10

Company post code.

businessCountryCode
String Length: 3

Company country ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code.

businessUrl
String Length: 255

Company website URL.

userAgreementReference
String Length: 36

Reference to the user agreement text.

oneTimePassword
Number Length: 8

One Time Password used for confirmation during Two Factor Authentication.

localDate
YYYY-MM-DD Length: 10 Required

The current date of the caller.

localTime
HHMMSS Length: 6 Required

The current time of the caller.

Request sample

Path:

POST {baseURL}/account/XXX-123456/updateInfo

Header:

Content-Type: application/json
Accept-Language: en-US
X-Auth-Token: eyJhbGciOiJSUzI1NiI{abbreviated}RW5kVG9rZW4=

{
"partnerReference": "1234567890",
"externalAccountReference": "CUSTID1234567890",
"userAgreementReference": "4CE1ABB1676E3DF5BB4450F45B51E07D",
"programCode": "PROG",
"accnoType": "00",
"accTypeCode": "MA-FVFD",
"title": "1",
"lastName": "Lastname",
"firstName": "Firstname",
"addr1": "Address 1",
"addr2": "",
"city": "City",
"state": "State",
"countryCode": "DE",
"postCode": "12345",
"dob": "1990-01-01",
"landlinePhone": "+49123456789",
"mobilePhone": "+491234567890",
"emailAddress": "user@example.com",
"nationality": "DE",
"culture": "de-DE",
"timeZone": "Central European Standard Time",
"useDifferentCorrespondenceAddress": true,
"correspondenceAddr1": "Address 1",
"correspondenceCity": "City",
"correspondenceCountryCode": "DE",
"correspondencePostCode": "12345",
"oneTimePassword": 123456,
"localDate": "2014-03-12",
"localTime": "163835"
}

Response parameters

partnerReference
String Length: 64

Partner service call identifier.

programCode
String Length: 10

Program code

accno
String Length: 255

Account number.

localDate
YYYY-MM-DD Length: 10

The current date of the caller.

localTime
HHMMSS Length: 6

The current time of the caller.

sysDate
YYYY-MM-DD Length: 10

The current date of the KontoCloud server

sysTime
HHMMSS Length: 6

The current time of the KontoCloud server

responseCode
String Length: 4

The response code. See Response Codes in the Lookups.

responseDescription
String Length: 512

The response description. See Response Codes in the Lookups.

Response sample

Status Code:

200 (OK)

Header:

Content-Type: application/json
Accept-Language: en-US

{
"partnerReference": "1234567890",
"programCode": "PROG",
"accno": "XXX-123456",
"providerResponse":
{
"complianceData":
{
"archiveId": "4108000025015465",
"trafficLight": "YELLOW",
"hitType": "SL",
"manualReview": true,
"details":
[
{
"name": "Lastname Firstname",
"birthdate": "19900101"
},
{
"name": "Firstname Lastname",
"birthdate": "19900101"
}
]
}
},
"localDate": "2014-03-12",
"localTime": "163835",
"sysDate": "2014-03-12",
"sysTime": "153837",
"responseCode": "0000",
"responseDescription": "Successful execution.",
    "additionalInformation": {
        "requestId": "aff2728481a181dc36daedc14055b516"
    }
}

 1.5 Get Account Information

get {baseURL}/account/{accno}?partnerReference={partnerReference}&programCode={programCode}&accnoType={accnoType}&localDate={localDate}&localTime={localTime}

Returns the account holder information.

Request parameters

accno
String Length: 255 Required

Account number.

partnerReference
String Length: 64 Required

Partner service call identifier.

programCode
String Length: 10 Required

Program code

accnoType
String Length: 2 Required

Account number type. See Account Number Type in the Lookups.

localDate
YYYY-MM-DD Length: 10 Required

The current date of the caller.

localTime
HHMMSS Length: 6 Required

The current time of the caller.

Request sample

Path:

GET {baseURL}/account/XXX-123456?partnerReference=50F45B51E07D4CE1ABB1676E3DF5BB44&programCode=COMPANY123&accnoType=01&localDate=2016-01-31&localTime=131415

Header:

Content-Type: application/json
Accept-Language: en-US
X-Auth-Token: eyJhbGciOiJSUzI1NiI{abbreviated}RW5kVG9rZW4=


Response parameters

partnerReference
String Length: 64

Partner service call identifier.

programCode
String Length: 10

Program code

accno
String Length: 255

Account number.

externalAccountReference
String Length: 255

Account reference to identify the account in the future by the partners in their system.

merchantName
String Length: 201

Merchant name.

title
Number Length: 1

Customer's title. See Title Codes in the Lookups.

lastName
String Length: 100

Customer's last name.

firstName
String Length: 100

Customer's first name.

addr1
String Length: 60

Address line 1.

addr2
String Length: 60

Address line 2.

addr3
String Length: 60

Address line 3.

houseNumber
String Length: 10

House number.

city
String Length: 50

City name.

state
String Length: 50

State name.

countryName
String Length: 100

Country name.

countryCode
String Length: 3

Country ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code.

postCode
String Length: 10

Postal code.

dob
YYYY-MM-DD Length: 10

Date of birth.

landlinePhone
String Length: 30

Landline phone number.

mobilePhone
String Length: 30

Mobile phone number.

emailAddress
String Length: 255

Email address for any notification.

loginID
String Length: 255

Login ID of the customer using the service.

culture
String Length: 14

User culture, based on RFC 4646. For example, "de-DE".

timeZone
String Length: 50

User time zone id. For example, "Central European Standard Time". See Time Zone in the Lookups.

useDifferentCorrespondenceAddress
Boolean

Defines whether a different correspondence address is used.

correspondenceAddr1
String Length: 60

Correspondence address line 1.

correspondenceAddr2
String Length: 60

Correspondence address line 2.

correspondenceAddr3
String Length: 60

Correspondence address line 3.

correspondenceHouseNumber
String Length: 10

Correspondence house number.

correspondenceCity
String Length: 50

Correspondence city name.

correspondenceState
String Length: 50

Correspondence state name.

correspondenceCountryName
String Length: 100

Correspondence country name.

correspondenceCountryCode
String Length: 2

Correspondence country ISO 3166-1 alpha-2 code.

correspondenceCountryCode3
String Length: 3

Correspondence country ISO 3166-1 alpha-3 code.

correspondencePostCode
String Length: 10

Correspondence postal code.

nationality
String Length: 2

The user national country ISO2 code.

nationality3
String Length: 3

The user national country ISO3 code.

taxId
String Length: 50

Tax identification number.

currCode
String Length: 3

Currency code of the account.

accTypeName
String Length: 100

Account type of the account.

accTypeCode
String Length: 10

Account type code of the account.

maximumAllowedBalance
Decimal Length: 18

Account's maximum allowed balance.

minimumAllowedBalance
Decimal Length: 18

Account's minimum allowed balance.

statusCode
String Length: 10

Status code of the account. See Account Status Codes in the Lookups.

twoFAStatusCode
String Length: 10

Two Factor Authentication Status Code. Refer to Two Factor Authentication Status Codes in the Lookups.

accFlowStatusCode
String Length: 10

Status code of the account flow. See Account Flow Status Codes in the Lookups.

isEmailVerified
Boolean

Defines whether the user's email is verified.

isMobilePhoneVerified
Boolean

Defines whether the user's mobile phone number is verified.

isUserActive
Boolean

Defines whether the user is active.

isUserLocked
Boolean

Defines whether the user is locked.

lastLoginDate
YYYY-MM-DD Length: 10

Last user login date into the Kontocloud system.

lastLoginTime
HHMMSS Length: 6

Last user login time into the Kontocloud system.

isMtanEnabled
Boolean

Defines whether MTAN support is enabled.

isBusinessUser
Boolean

Defines whether business information is provided for a user.

businessCompanyName
String Length: 201

Company legal name.

businessCompanyType
String Length: 100

Company legal type.

businessCompanyRegistrationNumber
String Length: 50

Company registration number.

businessCompanyRegistrationCountryCode
String Length: 2

Company registration country ISO 3166-1 alpha-2 code.

businessCompanyRegistrationCountryCode3
String Length: 3

Company registration country ISO 3166-1 alpha-3 code.

businessAddr1
String Length: 60

Company address line 1.

businessAddr2
String Length: 60

Company address line 2.

businessAddr3
String Length: 60

Company address line 3.

businessHouseNumber
String Length: 10

Company house number.

businessCity
String Length: 50

Company city name.

businessPostCode
String Length: 10

Company post code.

businessCountryCode
String Length: 2

Company country ISO 3166-1 alpha-2 code.

businessCountryCode3
String Length: 3

Company country ISO 3166-1 alpha-3 code.

businessUrl
String Length: 255

Company website URL.

userAgreementReference
String Length: 36

Reference to the user agreement text.

isUserAgreementUpToDate
Boolean

Identifies the User Agreement actuality.

accountValidUntil
YYYY-MM-DD Length: 10

The latest account validity date.

accountCreationDate
YYYY-MM-DD Length: 10

The account creation date.

localDate
YYYY-MM-DD Length: 10

The current date of the caller.

localTime
HHMMSS Length: 6

The current time of the caller.

sysDate
YYYY-MM-DD Length: 10

The current date of the KontoCloud server

sysTime
HHMMSS Length: 6

The current time of the KontoCloud server

responseCode
String Length: 4

The response code. See Response Codes in the Lookups.

responseDescription
String Length: 512

The response description. See Response Codes in the Lookups.

Response sample

Status Code:

200 (OK)

Header:

Content-Type: application/json
Accept-Language: en-US

{
"accno": "1000104149",
"title": 1,
"externalAccountReference": "CUSTID1234567890",
"lastName": "Lastname",
"firstName": "Firstname",
"addr1": "123 Anystreet",
"addr2": "Building 1a",
"addr3": null,
"houseNumber": null,
"city": "Anycity",
"state": "Anystate",
"countryCode": "DE",
"countryName": "Germany",
"postCode": "POSTCOD123",
"dob": "1990-01-31",
"landlinePhone": "+49 1234 567 890",
"mobilePhone": "+49 1234 567 890",
"emailAddress": "user@example.com",
"currCode": "EUR",
"accTypeName": "Starter Business",
"accTypeCode": "STARTBIZ",
"maximumAllowedBalance": "1000.00",
"minimumAllowedBalance": "0.00",
"statusCode": "ACTIVE",
"twoFAStatusCode": "2FADIS"
"accFlowStatusCode": "SDDAPPNDNG",
"isEmailVerified": false,
"isUserActive": true,
"isUserLocked": false,
"lastLoginDate": null,
"lastLoginTime": null,
"isMtanEnabled": false,
"culture": null,
"timeZone": "W. Europe Standard Time",
"useDifferentCorrespondenceAddress": true,
"correspondenceAddr1": "Tower 1",
"correspondenceAddr2": null,
"correspondenceAddr3": null,
"correspondenceHouseNumber": null,
"correspondenceCity": "Anycity",
"correspondenceState": "Anystate",
"correspondenceCountryCode": "DE",
"correspondenceCountryName": "Germany",
"correspondencePostCode": "12345",
"nationality": "DE",
"nationality3": "DEU",
"taxId": "9181081508155",
"isBusinessUser": true,
"businessCompanyName": "Anycompany Name",
"businessCompanyType": "Ltd",
"businessCompanyRegistrationNumber": "12345678",
"businessCompanyRegistrationCountryCode": "DE",
"businessAddr1": "Anystreet 456",
"businessAddr2": "Building 2b",
"businessAddr3": null,
"businessHouseNumber": null,
"businessCity": "Anycity",
"businessPostCode": "EC4M 7LS",
"businessCountryCode": "DE",
"businessUrl": "https://www.example.com",
"partnerReference": "50F45B51E07D4CE1ABB1676E3DF5BB44",
"programCode": "COMPANY123",
"userAgreementReference": "4CE1ABB1676E3DF5BB4450F45B51E07D",
"isUserAgreementUpToDate": true,
"accountValidUntil": "2999-12-31",
"accountCreationDate": "2016-01-31",
"localDate": "2016-01-31",
"localTime": "000000",
"sysDate": "2016-06-15",
"sysTime": "114249",
"responseCode": "0000",
"responseDescription": "Successful execution",
    "additionalInformation": {
        "requestId": "aff2728481a181dc36daedc14055b516"
    }
}

 1.73 Close Account

post {baseURL}/account/{accno}/close

The Close Account call will set the status of the account to "Closed", thus disabling the further usage of the account.

Request parameters

accno
String Length: 255 Required

Account number.

partnerReference
String Length: 64 Required

Partner service call identifier.

programCode
String Length: 10 Required

Program code

accnoType
String Length: 2 Required

Account number type. See Account Number Type in the Lookups.

externalRequestReference
String Length: 100

A reference assigned to the Data Deletion Request in the external system.

closingReason
String Length: 1024 Required

Reason for closing the accountand data deletion (if it is needed).

storedPaymentOptionReference
String Length: 36

Stored payment option reference to payout the account balance.

localDate
YYYY-MM-DD Length: 10 Required

The current date of the caller.

localTime
HHMMSS Length: 6 Required

The current time of the caller.

Response parameters

partnerReference
String Length: 64

Partner service call identifier.

programCode
String Length: 10

Program code

accno
String Length: 255

Account number.

statusCode
String Length: 10

Status code of the account. See Account Status Codes in the Lookups.

dateClosed
YYYY-MM-DD Length: 10

Calendar date when the account was closed.

localDate
YYYY-MM-DD Length: 10

The current date of the caller.

localTime
HHMMSS Length: 6

The current time of the caller.

sysDate
YYYY-MM-DD Length: 10

The current date of the KontoCloud server

sysTime
HHMMSS Length: 6

The current time of the KontoCloud server

responseCode
String Length: 4

The response code. See Response Codes in the Lookups.

responseDescription
String Length: 512

The response description. See Response Codes in the Lookups.

Response sample

Status Code:

200 (OK)

Header:

Content-Type: application/json
Accept-Language: en-US

{
"partnerReference": "1234567890",
"programCode": "PROG",
"accno": "XXX-123456",
"statusCode": "CLOSED",
"dateClosed": "2014-03-12",
"localDate": "2014-03-12",
"localTime": "163835",
"sysDate": "2014-03-12",
"sysTime": "153837",
"responseCode": "0000",
"responseDescription": "Successful execution.",
    "additionalInformation": {
        "requestId": "aff2728481a181dc36daedc14055b516"
    }
}

 Payment Option Management

 1.53 Init Add Stored Payment Option

post {baseURL}/account/{accno}/storedPaymentOptions/initAdd

This interface method is used to initialize storing a payment option to an e-wallet user or merchant account. The returned 'authorizationToken' is used for communication with the external provider.

Request parameters

accno
String Length: 255 Required

Account number.

partnerReference
String Length: 64 Required

Partner service call identifier.

programCode
String Length: 10 Required

Program code

accnoType
String Length: 2 Required

Account number type. See Account Number Type in the Lookups.

paymentOptionCode
String Length: 10

Payment option code.

externalChannelReference
String Length: 100

External payment provider channel.

mandateReference
String Length: 35

Mandate reference.

mandateSignedDate
YYYY-MM-DD Length: 10

Mandate signing date.

mandateSignedTime
HHMMSS Length: 6

mandateSignedTime

currCode
String Length: 3

Currency code of the payment option to be stored.

oneTimePassword
String Length: 8

One Time Password used for confirmation during Two Factor Authentication.

localDate
YYYY-MM-DD Length: 10 Required

The current date of the caller.

localTime
HHMMSS Length: 6 Required

The current time of the caller.

Request sample

Path:

POST {baseURL}/account/XXX-123456/storedPaymentOptions/initAdd

Header:

Content-Type: application/json
Accept-Language: en-US
X-Auth-Token: eyJhbGciOiJSUzI1NiI{abbreviated}RW5kVG9rZW4=

{
"partnerReference": "1234567890",
"programCode": "PROG",
"accnoType": "00",
"paymentOptionCode": "MSTRCRD",
"useDifferentBillingAddress": true,
"customerFullName": "Jacob Smith",
"emailAddress": "user@example.com",
"addr1": "Anystreet",
"houseNumber": "321",
"city": "Anycity",
"countryCode": "DE",
"postCode": "12345",
"localDate": "2014-03-12",
"localTime": "163835"
}

Response parameters

partnerReference
String Length: 64

Partner service call identifier.

programCode
String Length: 10

Program code

accno
String Length: 255

Account number.

authorizationToken
String Length: 8192

Unique authorization token assigned by an external payment provider.

paymentOptionCode
String Length: 10

Payment option code.

paymentProviderResponse
Object

Complete payment provider response.

localDate
YYYY-MM-DD Length: 10

The current date of the caller.

localTime
HHMMSS Length: 6

The current time of the caller.

sysDate
YYYY-MM-DD Length: 10

The current date of the KontoCloud server

sysTime
HHMMSS Length: 6

The current time of the KontoCloud server

responseCode
String Length: 4

The response code. See Response Codes in the Lookups.

responseDescription
String Length: 512

The response description. See Response Codes in the Lookups.

Response sample

Status Code:

200 (OK)

Header:

Content-Type: application/json
Accept-Language: en-US

{
"partnerReference": "1234567890",
"programCode": "PROG",
"accno": "XXX-123456",
"authorizationToken": "0C64A8CAD371F2A1177A9B1B2F505B13.sbg-vm-fe02",
"paymentOptionCode": "MSTRCRD",
"localDate": "2014-03-12",
"localTime": "163835",
"sysDate": "2014-03-12",
"sysTime": "153837",
"responseCode": "0000",
"responseDescription": "Successful execution.",
    "additionalInformation": {
        "requestId": "aff2728481a181dc36daedc14055b516"
    }
}

 1.54 Complete Add Stored Payment Option

put {baseURL}/account/{accno}/storedPaymentOptions/completeAdd

This interface method is used to complete storing a payment option to an e-wallet user or merchant account.

Request parameters

accno
String Length: 255 Required

User or merchant account number.

partnerReference
String Length: 64 Required

Partner service call identifier.

programCode
String Length: 10 Required

Program code

accnoType
String Length: 2 Required

Account number type. See Account Number Type in the Lookups.

paymentOptionCode
String Length: 10

Payment option code.

authorizationToken
String Length: 8192 Required

Unique authorization token assigned by an external payment provider.

useDifferentBillingAddress
Boolean Required

Defines whether the stored address or a custom billing address is used.

If true, the fields 'customerFullName', 'addr1', 'city', 'countryCode', 'postCode', 'emailAddress' are required.

If false, the account owner address is used.

customerFullName
String Length: 201

Customer full name consisting of the first name and last name.

externalChannelReference
String Length: 100

External payment provider channel.

oneTimePassword
String Length: 8

One Time Password used for confirmation during Two Factor Authentication.

localDate
YYYY-MM-DD Length: 10 Required

The current date of the caller.

localTime
HHMMSS Length: 6 Required

The current time of the caller.

Request sample

Path:

PUT {baseURL}/account/XXX-123456/storedPaymentOptions/completeAdd

Header:

Content-Type: application/json
Accept-Language: en-US
X-Auth-Token: eyJhbGciOiJSUzI1NiI{abbreviated}RW5kVG9rZW4=

{
"partnerReference": "1234567890",
"programCode": "PROG",
"accnoType": "00",
"paymentOptionCode": "MSTRCRD",
"authorizationToken": "0C64A8CAD371F2A1177A9B1B2F505B13.sbg-vm-fe02",
"useDifferentBillingAddress": false,
"localDate": "2014-03-12",
"localTime": "163835"
}

Response parameters

partnerReference
String Length: 64

Partner service call identifier.

programCode
String Length: 10

Program code

accno
String Length: 255

Account number.

paymentOptionCode
String Length: 10

Payment option code.

storedPaymentOptionReference
String Length: 36

Stored payment option reference.

initiationCountryCode
String Length: 2

Stored Payment Option issuer country ISO2 code.

initiationCountryCode3
String Length: 3

Stored Payment Option issuer country ISO3 code.

paymentProviderResponse
Object

Complete payment provider response.

localDate
YYYY-MM-DD Length: 10

The current date of the caller.

localTime
HHMMSS Length: 6

The current time of the caller.

sysDate
YYYY-MM-DD Length: 10

The current date of the KontoCloud server

sysTime
HHMMSS Length: 6

The current time of the KontoCloud server

responseCode
String Length: 4

The response code. See Response Codes in the Lookups.

responseDescription
String Length: 512

The response description. See Response Codes in the Lookups.

Response sample

Status Code:

201 (Created)

Header:

Content-Type: application/json
Accept-Language: en-US

{
"partnerReference": "1234567890",
"programCode": "PROG",
"accno": "XXX-123456",
"paymentOptionCode": "MSTRCRD",
"storedPaymentOptionReference": "5e71b97bd8aa446ba35161ec5c7af3f2",
"initiationCountryCode": "DE",
"initiationCountryCode3": "DEU",
"localDate": "2014-03-12",
"localTime": "163835",
"sysDate": "2014-03-12",
"sysTime": "153837",
"responseCode": "0000",
"responseDescription": "Successful execution.",
    "additionalInformation": {
        "requestId": "aff2728481a181dc36daedc14055b516"
    }
}

 1.56 Init Verify Stored Payment Option

post {baseURL}/account/{accno}/storedPaymentOptions/{storedPaymentOptionReference}/initVerify

Initiates verification of an e-wallet user or merchant account preferred payment option.

Request parameters

accno
String Length: 255 Required

User or merchant account number.

storedPaymentOptionReference
String Length: 36 Required

Stored payment option reference.

partnerReference
String Length: 64 Required

Partner service call identifier.

programAccno
String Length: 255 Required

Program account number.

accnoType
String Length: 2 Required

Account number type. See Account Number Type in the Lookups.

localDate
YYYY-MM-DD Length: 10 Required

The current date of the caller.

localTime
HHMMSS Length: 6 Required

The current time of the caller.

Request sample

Path:

POST {baseURL}/account/XXX-123456/storedPaymentOptions/5e71b97bd8aa446ba35161ec5c7af3f2/initVerify

Header:

Content-Type: application/json
Accept-Language: en-US
X-Auth-Token: eyJhbGciOiJSUzI1NiI{abbreviated}RW5kVG9rZW4=

{
   "partnerReference": "1234567890",
   "programAccno": "123456",
   "accnoType": "00",
   "localDate": "2014-03-12",
   "localTime": "163835"
}

Response parameters

partnerReference
String Length: 64

Partner service call identifier.

programCode
String Length: 10

Program code

accno
String Length: 255

Account number.

localDate
YYYY-MM-DD Length: 10

The current date of the caller.

localTime
HHMMSS Length: 6

The current time of the caller.

sysDate
YYYY-MM-DD Length: 10

The current date of the KontoCloud server

sysTime
HHMMSS Length: 6

The current time of the KontoCloud server

responseCode
String Length: 4

The response code. See Response Codes in the Lookups.

responseDescription
String Length: 512

The response description. See Response Codes in the Lookups.

Response Sample

Status Code:

200 (OK)

Header:

Content-Type: application/json
Accept-Language: en-US

{
   "partnerReference": "1234567890",
   "programCode": "PROG",
   "accno": "XXX-123456",
   "localDate": "2014-03-12",
   "localTime": "163835",
   "sysDate": "2014-03-12",
   "sysTime": "153837",
   "responseCode": "0000",
   "responseDescription": "Successful execution.",
    "additionalInformation": {
        "requestId": "aff2728481a181dc36daedc14055b516"
    }
}

 1.57 Complete Verify Stored Payment Option

post {baseURL}/account/{accno}/storedPaymentOptions/{storedPaymentOptionReference}/completeVerify

Completes verification of an e-wallet user or merchant account preferred payment option.

Request parameters

accno
String Length: 255 Required

User or merchant account number.

storedPaymentOptionReference
String Length: 36 Required

Stored payment option reference.

partnerReference
String Length: 64 Required

Partner service call identifier.

programCode
String Length: 10 Required

Program code

accnoType
String Length: 2 Required

Account number type. See Account Number Type in the Lookups.

verificationCode
Number Length: 6 Required

Payment option verification code.

localDate
YYYY-MM-DD Length: 10 Required

The current date of the caller.

localTime
HHMMSS Length: 6 Required

The current time of the caller.

Request sample

Path:

POST {baseURL}/account/XXX-123456/storedPaymentOptions/5e71b97bd8aa446ba35161ec5c7af3f2/completeVerify

Header:

Content-Type: application/json
Accept-Language: en-US
X-Auth-Token: eyJhbGciOiJSUzI1NiI{abbreviated}RW5kVG9rZW4=

{
"partnerReference": "1234567890",
"programCode": "PROG",
"accnoType": "00",
"verificationCode": "123456",
"localDate": "2014-03-12",
"localTime": "163835"
}

Response parameters

partnerReference
String Length: 64

Partner service call identifier.

programCode
String Length: 10

Program code

accno
String Length: 255

Account number.

localDate
YYYY-MM-DD Length: 10

The current date of the caller.

localTime
HHMMSS Length: 6

The current time of the caller.

sysDate
YYYY-MM-DD Length: 10

The current date of the KontoCloud server

sysTime
HHMMSS Length: 6

The current time of the KontoCloud server

responseCode
String Length: 4

The response code. See Response Codes in the Lookups.

responseDescription
String Length: 512

The response description. See Response Codes in the Lookups.

Response sample

Status Code:

200 (OK)

Header:

Content-Type: application/json
Accept-Language: en-US

{
"partnerReference": "1234567890",
"programCode": "PROG",
"accno": "XXX-123456",
"localDate": "2014-03-12",
"localTime": "163835",
"sysDate": "2014-03-12",
"sysTime": "153837",
"responseCode": "0000",
"responseDescription": "Successful execution.",
    "additionalInformation": {
        "requestId": "aff2728481a181dc36daedc14055b516"
    }
}

 1.55 Delete Stored Payment Option

del {baseURL}/account/{accno}/storedPaymentOptions/{storedPaymentOptionReference}

Deletes a preferred payment option from an e-wallet user or merchant account.

Request parameters

accno
String Length: 255 Required

User or merchant account number.

storedPaymentOptionReference
String Length: 36 Required

Stored payment option reference.

partnerReference
String Length: 64 Required

Partner service call identifier.

programCode
String Length: 10 Required

Program code

accnoType
String Length: 2 Required

Account number type. See Account Number Type in the Lookups.

localDate
YYYY-MM-DD Length: 10 Required

The current date of the caller.

localTime
HHMMSS Length: 6 Required

The current time of the caller.

Request sample

Path:

DELETE {baseURL}/account/XXX-123456/storedPaymentOptions/5e71b97bd8aa446ba35161ec5c7af3f2

Header:

Content-Type: application/json
Accept-Language: en-US
X-Auth-Token: eyJhbGciOiJSUzI1NiI{abbreviated}RW5kVG9rZW4=

{
   "partnerReference": "1234567890",
   "programCode": "PROG",
   "accnoType": "00",
   "localDate": "2014-03-12",
   "localTime": "163835"
}

Response parameters

partnerReference
String Length: 64

Partner service call identifier.

programCode
String Length: 10

Program code

accno
String Length: 255

Account number.

localDate
YYYY-MM-DD Length: 10

The current date of the caller.

localTime
HHMMSS Length: 6

The current time of the caller.

sysDate
YYYY-MM-DD Length: 10

The current date of the KontoCloud server

sysTime
HHMMSS Length: 6

The current time of the KontoCloud server

responseCode
String Length: 4

The response code. See Response Codes in the Lookups.

responseDescription
String Length: 512

The response description. See Response Codes in the Lookups.

Response sample

Status Code:

200 (OK)

Header:

Content-Type: application/json
Accept-Language: en-US

{
   "partnerReference": "1234567890",
   "programCode": "PROG",
   "accno": "XXX-123456",
   "localDate": "2014-03-12",
   "localTime": "163835",
   "sysDate": "2014-03-12",
   "sysTime": "153837",
   "responseCode": "0000",
   "responseDescription": "Successful execution.",
    "additionalInformation": {
        "requestId": "aff2728481a181dc36daedc14055b516"
    }
}

 1.79 Set Default Stored Payment Option

post {baseURL}/account/{accno}/storedPaymentOptions/{storedPaymentOptionReference}/setDefault

Sets a default stored payment option for an e-wallet user or merchant account.

Request parameters

accno
String Length: 255 Required

User or merchant account number.

storedPaymentOptionReference
String Length: 36 Required

Stored payment option reference.

partnerReference
String Length: 64 Required

Partner service call identifier.

programCode
String Length: 10 Required

Program code

accnoType
String Length: 2 Required

Account number type. See Account Number Type in the Lookups.

localDate
YYYY-MM-DD Length: 10 Required

The current date of the caller.

localTime
HHMMSS Length: 6 Required

The current time of the caller.

Response parameters

partnerReference
String Length: 64

Partner service call identifier.

programCode
String Length: 10

Program code

accno
String Length: 255

Account number.

localDate
YYYY-MM-DD Length: 10

The current date of the caller.

localTime
HHMMSS Length: 6

The current time of the caller.

sysDate
YYYY-MM-DD Length: 10

The current date of the KontoCloud server

sysTime
HHMMSS Length: 6

The current time of the KontoCloud server

responseCode
String Length: 4

The response code. See Response Codes in the Lookups.

responseDescription
String Length: 512

The response description. See Response Codes in the Lookups.

Response sample

Status Code:

200 (OK)

Header:

Content-Type: application/json
Accept-Language: en-US

{
   "partnerReference": "1234567890",
   "programCode": "PROG",
   "accno": "XXX-123456",
   "localDate": "2014-03-12",
   "localTime": "163835",
   "sysDate": "2014-03-12",
   "sysTime": "153837",
   "responseCode": "0000",
   "responseDescription": "Successful execution.",
    "additionalInformation": {
        "requestId": "aff2728481a181dc36daedc14055b516"
    }
}

 1.21 Get Payment Options

get {baseURL}/account/{accno}/paymentOptions?partnerReference={partnerReference}&programCode={programCode}&accnoType={accnoType}&transactionTypeCode={transactionTypeCode}&localDate={localDate}&localTime={localTime}

Returns the payment options available for the account's account type.

Request parameters

accno
String Length: 255 Required

Account number.

partnerReference
String Length: 64 Required

Partner service call identifier.

programCode
String Length: 10 Required

Program code

accnoType
String Length: 2 Required

Account number type. See Account Number Type in the Lookups.

transactionTypeCode
String Length: 10 Required

Transaction type. See Transaction Type in the Lookups.

localDate
YYYY-MM-DD Length: 10 Required

The current date of the caller.

localTime
HHMMSS Length: 6 Required

The current time of the caller.

Request sample

Path:

GET {baseURL}/account/XXX-123456/paymentOptions?partnerReference=1234567890&programCode=PROG&accnoType=00&transactionTypeCode=AUTH&localDate=2014-03- 12&localTime=163835

Header:

Content-Type: application/json
Accept-Language: en-US
X-Auth-Token: eyJhbGciOiJSUzI1NiI{abbreviated}RW5kVG9rZW4=


Response parameters

partnerReference
String Length: 64

Partner service call identifier.

programCode
String Length: 10

Program code

accno
String Length: 255

Account number.

transactionTypeCode
String Length: 10

Transaction type. See Transaction Type in the Lookups.

localDate
YYYY-MM-DD Length: 10

The current date of the caller.

localTime
HHMMSS Length: 6

The current time of the caller.

sysDate
YYYY-MM-DD Length: 10

The current date of the KontoCloud server

sysTime
HHMMSS Length: 6

The current time of the KontoCloud server

responseCode
String Length: 4

The response code. See Response Codes in the Lookups.

responseDescription
String Length: 512

The response description. See Response Codes in the Lookups.

Response sample

Status Code:

200 (OK)

Header:

Content-Type: application/json
Accept-Language: en-US

{
"partnerReference": "1234567890",
"programCode": "PROG",
"accno": "XXX-123456",
"transactionTypeCode": "AUTH",
"paymentOptions": [
{
"name": "Mastercard",
"code": "MSTRCRD",
"paymentGroup": "Cards",
"paymentGroupCode": "CARDS",
"paymentSubGroup": "Credit Cards",
"paymentSubGroupCode": "CRDTCRD",
"isStorable": true,
"iconUrl": "http://www.google.com"
},
{
"name": "VISA",
"code": "VISA",
"paymentGroup": "Cards",
"paymentGroupCode": "CARDS",
"paymentSubGroup": "Credit Cards",
"paymentSubGroupCode": "CRDTCRD",
"isStorable": true,
"iconUrl": "http://www.google.com"
}
],
"localDate": "2014-03-12",
"localTime": "163835",
"sysDate": "2014-03-12",
"sysTime": "153837",
"responseCode": "0000",
"responseDescription": "Successful execution.",
    "additionalInformation": {
        "requestId": "aff2728481a181dc36daedc14055b516"
    }
}

 1.26 Get Stored Payment Options

get {baseURL}/account/{accno}/storedPaymentOptions?partnerReference={partnerReference}&programCode={programCode}&accnoType={accnoType}&localDate={localDate}&localTime={localTime}

Returns the payment options stored for an account.

Request parameters

accno
String Length: 255 Required

Account number.

partnerReference
String Length: 64 Required

Partner service call identifier.

programCode
String Length: 10 Required

Program code

accnoType
String Length: 2 Required

Account number type. See Account Number Type in the Lookups.

transactionTypeCode
String Length: 10

Transaction type. See Transaction Type in the Lookups.

localDate
YYYY-MM-DD Length: 10 Required

The current date of the caller.

localTime
HHMMSS Length: 6 Required

The current time of the caller.

Request sample

Path:

GET {baseURL}/account/XXX-123456/storedPaymentOptions?partnerReference=1234567890&programCode=PROG&accnoType=00&localDate=2014-03-12&localTime=163835

Header:

Content-Type: application/json
Accept-Language: en-US
X-Auth-Token: eyJhbGciOiJSUzI1NiI{abbreviated}RW5kVG9rZW4=


Response parameters

partnerReference
String Length: 64

Partner service call identifier.

programCode
String Length: 10

Program code

accno
String Length: 255

Account number.

localDate
YYYY-MM-DD Length: 10

The current date of the caller.

localTime
HHMMSS Length: 6

The current time of the caller.

sysDate
YYYY-MM-DD Length: 10

The current date of the KontoCloud server

sysTime
HHMMSS Length: 6

The current time of the KontoCloud server

responseCode
String Length: 4

The response code. See Response Codes in the Lookups.

responseDescription
String Length: 512

The response description. See Response Codes in the Lookups.

Response sample

Status Code:

200 (OK)

Header:

Content-Type: application/json
Accept-Language: en-US

{
"partnerReference": "1234567890",
"programCode": "PROG",
"accno": "XXX-123456",
"paymentOptions": [
{
"name": "Mastercard",
"code": "MSTRCRD",
"carrierNumber": "123***789",
"reference": "318306776d144adc94639801499736d5",
"paymentGroup": "Cards",
"paymentGroupCode": "CARDS",
"paymentSubGroup": "Credit Cards",
"paymentSubGroupCode": "CRDTCRD",
"expiryMonth": 10,
"expiryYear": 2014,
"validUntilDate": "2014-10-31",
"validUntilTime": "235959",
"bankCode": "",
"isVerifiable": true,
"statusCode": "VERIFIED",
"isDefault": false,
"billingAddress":
{
"fullName": "John Doe",
"addr1": "Green Street",
"addr2": "",
"city": "City",
"state": "",
"countryName": "Germany",
"countryCode": "DE",
"postCode": "12345"
},
"iconUrl": "http://www.google.com"
},
{
"name": "VISA",
"code": "VISA",
"carrierNumber": "987***321",
"reference": "39f581425f264e94956224331f481b0c",
"paymentGroup": "Cards",
"paymentGroupCode": "CARDS",
"paymentSubGroup": "Credit Cards",
"paymentSubGroupCode": "CRDTCRD",
"expiryMonth": 10,
"expiryYear": 2014,
"validUntilDate": "2014-10-31",
"validUntilTime": "235959","bankCode": "",
"isVerifiable": true,
"statusCode": "VERIFIED",
"isDefault": false,
"billingAddress":
{
"fullName": "John Doe",
"addr1": "Green Street",
"addr2": "",
"city": "City",
"state": "",
"countryName": "Germany",
"countryCode": "DE",
"postCode": "12345"
},
"iconUrl": "http://www.google.com"
}
]
"localDate": "2014-03-12",
"localTime": "163835",
"sysDate": "2014-03-12",
"sysTime": "153837",
"responseCode": "0000",
"responseDescription": "Successful execution.",
    "additionalInformation": {
        "requestId": "aff2728481a181dc36daedc14055b516"
    }
}

 Payment

 1.38 Init Authorize

put {baseURL}/payment/initAuthorize

This interface method is used to initialize authorizing a payment to an e-wallet user or merchant account. A call to "Init Authorize" internally performs an "Init Load Account" call, if provided 'accno' is a user account.

Please note that there are two use cases where this method is used, as part of Guest Payment authorizations and Customer Initiated Transactions using an existing stored payment option. The fields which should be used differ and are reflected in the provided samples.

Request parameters

partnerReference
String Length: 64 Required

Partner service call identifier.

programAccno
String Length: 255 Required

Program account number.

accno
String Length: 255

User or merchant account number.

accnoType
String Length: 2

Account number type. See Account Number Type in the Lookups. Required only if 'accno' is specified.

storedPaymentOptionReference
String Length: 36

Stored payment option unique reference. This value can be supplied, if 'paymentOptionCode' is not provided.

paymentOptionCode
String Length: 10

Payment option code.

presentationAmount
Decimal Length: 18,2 Required

The amount which is authorized for payment to the account.

presentationCurrCode
String Length: 3 Required

The 3-letter currency code associated with the transaction.

presentationUsage
String Length: 127 Required

Information relevant to the payment.

useDifferentBillingAddress
Boolean Required

Defines whether the stored address or a custom billing address is used.

Please note that inline with requirements introduced by Strong Customer Authentication, Guest Payment integrations require that real customer address information (with the exception of "customerFullName") be provided i.e. "useDifferentBillingAddress" must be set to true, which makes the following address parameters mandatory:

    - customerFullName

    - emailAddress

    - addr1

    - houseNumber (if not included in addr1)

    - city

    - postCode

    - countryCode

Please contact customer support where providing accurate data may not be possible in production, as this may result in transactions being rejected.

If false, in the case of CIT the address of the account owner is used; the account owner is determined by the storedPaymentOptionReference.

customerFullName
String Length: 201

Customer full name consisting of the first name and last name.

emailAddress
String

Email address.

addr1
String Length: 60

Address line 1.

addr2
String Length: 60

Address line 2.

addr3
String Length: 60

Address line 3.

houseNumber
String Length: 10

House number.

city
String Length: 50

City name.

state
String Length: 50

State name.

countryCode
String Length: 3

Country ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code.

postCode
String Length: 10

Postal code.

phone
String Length: 30

Phone number.

custom1
String Length: 255

For external party usage.

custom2
String Length: 255

For external party usage.

custom3
String Length: 255

For external party usage.

externalChannelReference
String Length: 100

External payment provider channel.

mandateReference
String Length: 35

Mandate reference.

mandateSignedDate
YYYY-MM-DD Length: 10

Mandate signing date.

mandateSignedTime
HHMMSS Length: 6

mandateSignedTime

localDate
YYYY-MM-DD Length: 10 Required

The current date of the caller.

localTime
HHMMSS Length: 6 Required

The current time of the caller.

Request sample for CIT

Path:

PUT {baseURL}/payment/initAuthorize

Header:

Content-Type: application/json
Accept-Language: en-US
X-Auth-Token: eyJhbGciOiJSUzI1NiI{abbreviated}RW5kVG9rZW4=

{
"partnerReference": "1234567890",
"programAccno": "123456",
"accno": "XXX-123456",
"accnoType": "00",
"storedPaymentOptionReference": "8ac7a49f66aaa1f50166be603cf15385",
"paymentOptionCode": "MSTRCRD",
"presentationAmount": 100,
"presentationCurrCode": "EUR",
"presentationUsage": "Deposit: 100 EUR",
"useDifferentBillingAddress": false,
"custom1": "Custom information 1",
"criteria": [
    {
        "name": "affiliate",
        "value": "ExternalShopXY"
    },
    {
        "name": "age",
        "value": "30-40"
    }
],
"localDate": "2014-03-12",
"localTime": "163835"
}

Request sample for Guest Payment

Path:

PUT {Base URL}/payment/initAuthorize

Header:

Content-Type: application/json
Accept-Language: en-US
X-Auth-Token: H4sIAAAAAAA{partial omission for brevity}EAN2bJ/6l2XX+A5kJqdP+MwAA

{
"partnerReference": "1234567890",
"programAccno": "123456",
"accno": "XXX-123456",
"accnoType": "00",
"paymentOptionCode": "MSTRCRD",
"presentationAmount": 100,
"presentationCurrCode": "EUR",
"presentationUsage": "Deposit: 100 EUR",
"useDifferentBillingAddress": true,
"customerFullName": "Jacob Smith",
"emailAddress": "user@example.com",
"addr1": "Anystreet",
"houseNumber": "321",
"city": "Anycity",
"countryCode": "DE",
"postCode": "12345",
"custom1": "Custom information 1",
"criteria": [
    {
        "name": "affiliate",
        "value": "ExternalShopXY"
    },
    {
        "name": "age",
        "value": "30-40"
    }
],
"localDate": "2014-03-12",
"localTime": "163835"
}

Response parameters

partnerReference
String Length: 64

Partner service call identifier.

programCode
String Length: 10

Program code

accno
String Length: 255

Account number.

storedPaymentOptionReference
String Length: 36

Stored payment option unique reference. This value can be supplied, if 'paymentOptionCode' is not provided.

uniqueReference
String Length: 36

This is the uniqueReference that was assigned to the external authorization. It is received as part of authorization response from KontoCloud.

authorizationToken
String Length: 8192

Unique authorization token assigned by an external payment provider.

paymentOptionCode
String Length: 10

Payment option code.

presentationAmount
Decimal Length: 18,2

The amount which is authorized for payment to the account.

presentationCurrCode
String Length: 3

The 3-letter currency code associated with the transaction.

presentationUsage
String Length: 255

Information relevant to the payment.

custom1
String Length: 255

For external party usage.

custom2
String Length: 255

For external party usage.

custom3
String Length: 255

For external party usage.

statusCode
String Length: 10

Status code of the account. See Account Status Codes in the Lookups.

statusReason
String Length: 255

Reason for a status code.

paymentProviderResponse
Object

Complete payment provider response.

localDate
YYYY-MM-DD Length: 10

The current date of the caller.

localTime
HHMMSS Length: 6

The current time of the caller.

sysDate
YYYY-MM-DD Length: 10

The current date of the KontoCloud server

sysTime
HHMMSS Length: 6

The current time of the KontoCloud server

responseCode
String Length: 4

The response code. See Response Codes in the Lookups.

responseDescription
String Length: 512

The response description. See Response Codes in the Lookups.

Response sample for CIT

Status Code:

201 (Created)

Header:

Content-Type: application/json
Accept-Language: en-US

{
"partnerReference": "1234567890",
"programAccno": "123456",
"accno": "XXX-123456",
"storedPaymentOptionReference": "8ac7a49f66aaa1f50166be603cf15385",
"uniqueReference": "d633d423651c4cc4bb04b6be69a13ecd",
"loadAccountReference": "621b66dd7a10480487e09ddf290ae931",
"authorizationToken": "0C64A8CAD371F2A1177A9B1B2F505B13.sbg-vm-fe02",
"paymentOptionCode": "MSTRCRD",
"presentationAmount": 100,
"presentationCurrCode": "EUR",
"presentationUsage": "Deposit: 100 EUR",
"custom1": "Custom information 1",
"custom2": "",
"custom3": "",
"statusCode": "RECEIVED",
"statusReason": "",
"localDate": "2014-03-12",
"localTime": "163835",
"sysDate": "2014-03-12",
"sysTime": "153837",
"responseCode": "0000",
"responseDescription": "Successful execution.",
    "additionalInformation": {
        "requestId": "aff2728481a181dc36daedc14055b516"
    }
}

Response sample for Guest Payment

Status Code:

201 (Created)

Header:

Content-Type: application/json
Accept-Language: en-US

{
"partnerReference": "1234567890",
"programAccno": "123456",
"accno": "XXX-123456",
"uniqueReference": "d633d423651c4cc4bb04b6be69a13ecd",
"loadAccountReference": "621b66dd7a10480487e09ddf290ae931",
"authorizationToken": "0C64A8CAD371F2A1177A9B1B2F505B13.sbg-vm-fe02",
"paymentOptionCode": "MSTRCRD",
"presentationAmount": 100,
"presentationCurrCode": "EUR",
"presentationUsage": "Deposit: 100 EUR",
"custom1": "Custom information 1",
"custom2": "",
"custom3": "",
"statusCode": "RECEIVED",
"statusReason": "",
"localDate": "2014-03-12",
"localTime": "163835",
"sysDate": "2014-03-12",
"sysTime": "153837",
"responseCode": "0000",
"responseDescription": "Successful execution.",
    "additionalInformation": {
        "requestId": "aff2728481a181dc36daedc14055b516"
    }
}

 1.39 Complete Authorize

post {baseURL}/payment/{uniqueReference}/completeAuthorize

This interface method is used to complete a previously initiated authorization.

Request parameters

uniqueReference
String Length: 36 Required

This is the uniqueReference that was assigned to initializing of an external authorization. It is received as part of "Init Authorize" response from KontoCloud.

partnerReference
String Length: 64 Required

Partner service call identifier.

authorizationToken
String Length: 8192 Required

Unique authorization token assigned by an external payment provider.

externalChannelReference
String Length: 100

External payment provider channel.

useDifferentBillingAddress
Boolean

Defines whether the stored address or a custom billing address is used.
If true, the fields 'customerFullName', 'addr1', 'city', 'countryCode', 'postCode' are required.
If false, the account owner address is used.
If the field is not provided, false value is used.

customerFullName
String Length: 201

Customer full name consisting of the first name and last name.

addr1
String Length: 60

Address line 1.

addr2
String Length: 60

Address line 2.

addr3
String Length: 60

Address line 3.

houseNumber
String Length: 10

House number.

city
String Length: 50

City name.

countryCode
String Length: 3

Country ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code.

postCode
String Length: 10

Postal code.

phone
String Length: 30

Phone number.

localDate
YYYY-MM-DD Length: 10 Required

The current date of the caller.

localTime
HHMMSS Length: 6 Required

The current time of the caller.

Request sample

Path:

POST {baseURL}/payment/{uniqueReference}/completeAuthorize

Header:

Content-Type: application/json
Accept-Language: en-US
X-Auth-Token: eyJhbGciOiJSUzI1NiI{abbreviated}RW5kVG9rZW4=

{
   "partnerReference": "1234567890",
   "authorizationToken": "0C64A8CAD371F2A1177A9B1B2F505B13.sbg-vm-fe02",
   "localDate": "2014-03-12",
   "localTime": "163835"
}

Response parameters

partnerReference
String Length: 64

Partner service call identifier.

initiatorAccno
String Length: 255

Initiator account number.

accno
String Length: 255

Account number.

uniqueReference
String Length: 36

This is the uniqueReference that was assigned to the external authorization. It is received as part of authorization response from KontoCloud.

storedPaymentOptionReference
String Length: 36

Stored payment option reference.

initiationCountryCode
String Length: 2

Payment Option issuer country ISO2 code.

initiationCountryCode3
String Length: 3

Payment Option issuer country ISO3 code.

processedAmount
Decimal Length: 18,2

The amount returned by the acquirer after processing.

processedCurrCode
String Length: 3

The 3-letter currency code associated with the processed amount.

statusCode
String Length: 10

Transaction status code. See Transaction Status in the Lookups.

statusReason
String Length: 255

Reason for a status code.

paymentProviderResponse
Object

Complete payment provider response:

- Array for "PayU" payment option;

- Object for all other payment options.

localDate
YYYY-MM-DD Length: 10

The current date of the caller.

localTime
HHMMSS Length: 6

The current time of the caller.

sysDate
YYYY-MM-DD Length: 10

The current date of the KontoCloud server

sysTime
HHMMSS Length: 6

The current time of the KontoCloud server

responseCode
String Length: 4

The response code. See Response Codes in the Lookups.

responseDescription
String Length: 512

The response description. See Response Codes in the Lookups.

Response sample

Status Code:

200 (OK)

Header:

Content-Type: application/json
Accept-Language: en-US

{
   "partnerReference": "1234567890",
   "initiatorAccno": "98765",
   "accno": "XXX-123456",
   "uniqueReference": "d633d423651c4cc4bb04b6be69a13ecd",
   "storedPaymentOptionReference": "7dc5eb4673744da99859f65be192c04c",
   "initiationCountryCode": "ES",
   "initiationCountryCode3": "ESP",
   "processedAmount": 92,
   "processedCurrCode": "EUR",
   "statusCode": "AUTHORIZED",
   "statusReason": "Request Successfully Processed.",
   "localDate": "2014-03-12",
   "localTime": "163835",
   "sysDate": "2014-03-12",
   "sysTime": "153837",
   "responseCode": "0000",
   "responseDescription": "Successful execution.",
    "additionalInformation": {
        "requestId": "aff2728481a181dc36daedc14055b516"
    }
}

 1.27 Authorize

put {baseURL}/payment/authorize

This interface method is used to authorize a payment to an e-wallet or merchant account.
A call to "Authorize" internally performs an "Init Load Account" call, if an 'accno' parameter is specified.

Request parameters

partnerReference
String Length: 64 Required

Partner service call identifier.

programAccno
String Length: 255 Required

Program account number.

accno
String Length: 255

User or merchant account number.

accnoType
String Length: 2

Account number type. See Account Number Type in the Lookups. Required only if 'accno' is specified.

storedPaymentOptionReference
String Length: 36 Required

Stored payment option reference.

invoiceReference
String Length: 255

Payment invoice reference.

channelProductReference
String Length: 255

Payment channel product reference.

presentationAmount
Decimal Length: 18,2 Required

The amount which is authorized for payment to the account.

presentationCurrCode
String Length: 3 Required

The 3-letter currency code associated with the transaction.

presentationUsage
String Length: 127 Required

Information relevant to the payment.

useDifferentBillingAddress
Boolean Required

Defines whether the stored address or a custom billing address is used.

If true, the fields 'customerFullName', 'addr1', 'city', 'countryCode', 'postCode', 'emailAddress' are required.

If false, the billing address of the stored payment option is used or if a stored payment option is not provided, the account owner address.

customerFullName
String Length: 201

Customer full name consisting of the first name and last name.

addr1
String Length: 60

Address line 1.

addr2
String Length: 60

Address line 2.

addr3
String Length: 60

Address line 3.

houseNumber
String Length: 10

House number.

city
String Length: 50

City name.

state
String Length: 50

State name.

countryCode
String Length: 3

Country ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code.

postCode
String Length: 10

Postal code.

phone
String Length: 30

Phone number.

emailAddress
String Length: 255

Email address.

custom1
String Length: 255

For external party usage.

custom2
String Length: 255

For external party usage.

custom3
String Length: 255

For external party usage.

oneTimePassword
Number Length: 8

One Time Password used for confirmation during Two Factor Authentication.

localDate
YYYY-MM-DD Length: 10 Required

The current date of the caller.

localTime
HHMMSS Length: 6 Required

The current time of the caller.

Request Sample

Path:

PUT {baseURL}/payment/authorize

Header:

Content-Type: application/json
Accept-Language: en-US
X-Auth-Token: eyJhbGciOiJSUzI1NiI{abbreviated}RW5kVG9rZW4=

{
"partnerReference": "1234567890",
"programAccno": "123456",
"accno": "XXX-123456",
"accnoType": "00",
"storedPaymentOptionReference": "8ac7a49f66aaa1f50166be603cf15385", 
"invoiceReference": "Invoice-20140410-1", 
"channelProductReference": "Product-1",
"presentationAmount": 100,
"presentationCurrCode": "EUR",
"presentationUsage": "Deposit: 100 EUR", 
"useDifferentBillingAddress": true, 
"customerFullName": "Firstname Lastname",
"emailAddress": "user@example.com",
"addr1": "Address 1",
"city": "City",
"countryCode": "DE",
"postCode": "12345",
"custom1": "Custom information 1",
"criteria": [
 {
   "name": "affiliate",
   "value": "ExternalShopXY"
 },
 {
   "name": "age",
   "value": "30-40"
 }
],
"localDate": "2014-03-12",
"localTime": "163835"
}

Response parameters

partnerReference
String Length: 64

Partner service call identifier.

programAccno
String Length: 255

Program account number.

accno
String Length: 255

Account number.

uniqueReference
String Length: 36

This is the uniqueReference that was assigned to the external authorization. It is received as part of authorization response from KontoCloud.

storedPaymentOptionReference
String Length: 36

Stored payment option reference.

invoiceReference
String Length: 255

Payment invoice reference.

channelProductReference
String Length: 255

Payment channel product reference.

presentationAmount
Decimal Length: 18,2

The amount which is authorized for payment to the account.

presentationCurrCode
String Length: 3

The 3-letter currency code associated with the transaction.

presentationUsage
String Length: 127

Information relevant to the payment.

processedAmount
Decimal Length: 18,2

The amount returned by the acquirer after processing.

processedCurrCode
String Length: 3

The 3-letter currency code associated with the processed amount.

custom1
String Length: 255

For external party usage.

custom2
String Length: 255

For external party usage.

custom3
String Length: 255

For external party usage.

statusCode
String Length: 10

Status code of the account. See Account Status Codes in the Lookups.

statusReason
String Length: 255

Reason for a status code.

paymentProviderResponse
Object

Complete payment provider response.

localDate
YYYY-MM-DD Length: 10

The current date of the caller.

localTime
HHMMSS Length: 6

The current time of the caller.

sysDate
YYYY-MM-DD Length: 10

The current date of the KontoCloud server

sysTime
HHMMSS Length: 6

The current time of the KontoCloud server

responseCode
String Length: 4

The response code. See Response Codes in the Lookups.

responseDescription
String Length: 512

The response description. See Response Codes in the Lookups.

Response sample

Status Code:

201 (Created)

Header:

Content-Type: application/json
Accept-Language: en-US

{
"partnerReference": "1234567890",
"programAccno": "123456",
"accno": "XXX-123456",
"uniqueReference": "d633d423651c4cc4bb04b6be69a13ecd",
"loadAccountReference": "621b66dd7a10480487e09ddf290ae931",
"storedPaymentOptionReference": "",
"invoiceReference": "Invoice-20140410-1",
"channelProductReference": "Product-1",
"presentationAmount": 100,
"presentationCurrCode": "EUR",
"presentationUsage": "Deposit: 100 EUR",
"processedAmount": 100,
"processedCurrCode": "EUR",
"custom1": "Custom information 1",
"custom2": "",
"custom3": "",
"statusCode": "AUTHORIZED",
"statusReason": "",
"localDate": "2014-03-12",
"localTime": "163835",
"sysDate": "2014-03-12",
"sysTime": "153837",
"responseCode": "0000",
"responseDescription": "Successful execution.",
    "additionalInformation": {
        "requestId": "aff2728481a181dc36daedc14055b516"
    }
}

 1.29 Capture

post {baseURL}/payment/{uniqueReference}/capture

This interface method is used to capture a payment to an e-wallet account previously authorized via a call to "Init Authorize"+"Complete Authorize" or "Authorize".
A call to "Capture" internally performs a "Load Account" call, if an 'accno' parameter is specified during authorization.

Request parameters

uniqueReference
String Length: 36 Required

This is the uniqueReference that was assigned to the external authorization. It is received as part of authorization response from KontoCloud.

partnerReference
String Length: 64 Required

Partner service call identifier.

modifiedUsage
String Length: 127

Information relevant to the payment.

custom1
String Length: 255

For external party usage.

custom2
String Length: 255

For external party usage.

custom3
String Length: 255

For external party usage.

localDate
YYYY-MM-DD Length: 10 Required

The current date of the caller.

localTime
HHMMSS Length: 6 Required

The current time of the caller.

Request sample

Path:

POST {baseURL}/payment/d633d423651c4cc4bb04b6be69a13ecd/capture

Header:

Content-Type: application/json
Accept-Language: en-US
X-Auth-Token: eyJhbGciOiJSUzI1NiI{abbreviated}RW5kVG9rZW4=

{
"partnerReference": "1234567890",
"modifiedAmount": 92,
"modifiedAmountCurrCode": "EUR",
"custom1": "Custom information 1",
"localDate": "2014-03-12",
"localTime": "163835"
}

Response parameters

partnerReference
String Length: 64

Partner service call identifier.

initiatorAccno
String Length: 255

Initiator account number.

accno
String Length: 255

Account number.

uniqueReference
String Length: 36

Unique transaction reference assigned by KontoCloud upon authorization.

modifiedAmount
Decimal Length: 18,2

The amount which is captured for payment to the account.

modifiedAmountCurrCode
String Length: 3

The 3-letter currency code associated with the transaction.

processedAmount
Decimal Length: 18,2

The amount returned by the acquirer after processing.

processedCurrCode
String Length: 3

The 3-letter currency code associated with the processed amount.

custom1
String Length: 255

For external party usage.

custom2
String Length: 255

For external party usage.

custom3
String Length: 255

For external party usage.

statusCode
String Length: 10

Transaction status code. See Transaction Status in the Lookups.

statusReason
String Length: 255

Reason for a status code.

paymentProviderResponse
Object

Complete payment provider response:

- Array for "PayU" payment option;

- Object for all other payment options.

localDate
YYYY-MM-DD Length: 10

The current date of the caller.

localTime
HHMMSS Length: 6

The current time of the caller.

sysDate
YYYY-MM-DD Length: 10

The current date of the KontoCloud server

sysTime
HHMMSS Length: 6

The current time of the KontoCloud server

responseCode
String Length: 4

The response code. See Response Codes in the Lookups.

responseDescription
String Length: 512

The response description. See Response Codes in the Lookups.

Response sample

Status Code:

201 (Created)

Header:

Content-Type: application/json
Accept-Language: en-US

{
"partnerReference": "1234567890",
"initiatorAccno": "98765",
"accno": "XXX-123456",
"uniqueReference": "d633d423651c4cc4bb04b6be69a13ecd",
"modifiedAmount": 92,
"modifiedAmountCurrCode": "EUR",
"processedAmount": 92,
"processedCurrCode": "EUR",
"custom1": "Custom information 1",
"custom2": "",
"custom3": "",
"statusCode": "CAPTURED",
"statusReason": "",
"localDate": "2014-03-12",
"localTime": "163835",
"sysDate": "2014-03-12",
"sysTime": "153837",
"responseCode": "0000",
"responseDescription": "Successful execution",
    "additionalInformation": {
        "requestId": "aff2728481a181dc36daedc14055b516"
    }
}

 1.75 Refund

post {baseURL}/payment/{uniqueReference}/refund

This interface method is used to refund a previously captured external authorization.

Request parameters

partnerReference
String Length: 64 Required

Partner service call identifier.

uniqueReference
String Length: 36 Required

This is the uniqueReference that was assigned to the external authorization. It is received as part of authorization response from KontoCloud.

refundAmount
Decimal Length: 18,2

Amount being refunded. It cannot exceed the amount of the refunded transaction. If the value is not provided the full refund is performed.

refundUsage
String Length: 255

Information relevant to the refund.

refundType
String Length: 1

The code defining what type of refund will be performed. Available types of refund listed in "Refund Type" lookup.

refundSourceAccno
String Length: 36

User's or merchant's Account from which the 'refundAmount' will be refunded in case of a partial chain refund. This account must be one of the target accountsofdependent"Payment"or "Load Account".

custom1
String Length: 255

For external party usage.

custom2
String Length: 255

For external party usage.

custom3
String Length: 255

For external party usage.

localDate
YYYY-MM-DD Length: 10 Required

The current date of the caller.

localTime
HHMMSS Length: 6 Required

The current time of the caller.

Request sample

Path:

POST {baseURL}/payment/d633d423651c4cc4bb04b6be69a13ecd/refund

Header:

Content-Type: application/json
Accept-Language: en-US
X-Auth-Token: eyJhbGciOiJSUzI1NiI{abbreviated}RW5kVG9rZW4=

{
"partnerReference": "1234567890", 
"refundAmount": 9,
"refundUsage": "Payment refund", 
"localDate": "2014-03-12", 
"localTime": "163835"
}

Response parameters

partnerReference
String Length: 64

Partner service call identifier.

initiatorAccno
String Length: 255

Initiator account number.

accno
String Length: 255

Account number.

uniqueReference
String Length: 36

Unique transaction reference assigned by KontoCloud upon authorization.

refundAmount
Decimal Length: 18,2

Amount being refunded. It cannot exceed the amount of the refunded transaction. If the value is not provided the full refund is performed.

refundCurrCode
String Length: 3

Currency code of the amount to be refunded.

processedAmount
Decimal Length: 18,2

The amount returned by the acquirer after processing.

processedCurrCode
String Length: 3

The 3-letter currency code associated with the processed amount.

custom1
String Length: 255

For external party usage.

custom2
String Length: 255

For external party usage.

custom3
String Length: 255

For external party usage.

statusCode
String Length: 10

Transaction status code. See Transaction Status in the Lookups.

statusReason
String Length: 255

Reason for a status code.

paymentProviderResponse
Object

Complete payment provider response:

- Array for "PayU" payment option;

- Object for all other payment options.

localDate
YYYY-MM-DD Length: 10

The current date of the caller.

localTime
HHMMSS Length: 6

The current time of the caller.

sysDate
YYYY-MM-DD Length: 10

The current date of the KontoCloud server

sysTime
HHMMSS Length: 6

The current time of the KontoCloud server

responseCode
String Length: 4

The response code. See Response Codes in the Lookups.

responseDescription
String Length: 512

The response description. See Response Codes in the Lookups.

Response sample

Status Code:

201 (Created)

Header:

Content-Type: application/json
Accept-Language: en-US

{
"partnerReference": "1234567890",
"initiatorAccno": "98765",
"accno": ["XXX-123456", "XXX-123457"], 
"uniqueReference": "d633d423651c4cc4bb04b6be69a13ecd", 
"refundAmount": 9,
"refundCurrCode": "EUR",
"processedAmount": 9,
"processedCurrCode": "EUR",
"custom1": "Custom information 1",
"custom2": "",
"custom3": "",
"statusCode": "CAPTURED",
"statusReason": "",
"localDate": "2014-03-12",
"localTime": "163835",
"sysDate": "2014-03-12",
"sysTime": "153837",
"responseCode": "0000",
"responseDescription": "Successful execution.",
    "additionalInformation": {
        "requestId": "aff2728481a181dc36daedc14055b516"
    }
}

 1.30 Cancel

post {baseURL}/payment/{uniqueReference}/cancel

This interface method is used to cancel a previously authorized payment to an e-wallet account.

Request parameters

uniqueReference
String Length: 36 Required

This is the uniqueReference that was assigned to the external authorization. It is received as part of authorization response from KontoCloud.

partnerReference
String Length: 64 Required

Partner service call identifier.

custom1
String Length: 255

For external party usage.

custom2
String Length: 255

For external party usage.

custom3
String Length: 255

For external party usage.

localDate
YYYY-MM-DD Length: 10 Required

The current date of the caller.

localTime
HHMMSS Length: 6 Required

The current time of the caller.

Request sample

Path:

POST {baseURL}/payment/d633d423651c4cc4bb04b6be69a13ecd/cancel

Header:

Content-Type: application/json
Accept-Language: en-US
X-Auth-Token: eyJhbGciOiJSUzI1NiI{abbreviated}RW5kVG9rZW4=

{
   "partnerReference": "1234567890",
   "custom1": "Custom information 1",
   "localDate": "2014-03-12",
   "localTime": "163835"
}

Response parameters

partnerReference
String Length: 64

Partner service call identifier.

initiatorAccno
String Length: 255

Initiator account number.

accno
String Length: 255

Account number.

uniqueReference
String Length: 36

Unique transaction reference assigned by KontoCloud upon authorization.

custom1
String Length: 255

For external party usage.

custom2
String Length: 255

For external party usage.

custom3
String Length: 255

For external party usage.

statusCode
String Length: 10

Transaction status code. See Transaction Status in the Lookups.

statusReason
String Length: 255

Reason for a status code.

paymentProviderResponse
Object

Complete payment provider response:

- Array for "PayU" payment option;

- Object for all other payment options.

localDate
YYYY-MM-DD Length: 10

The current date of the caller.

localTime
HHMMSS Length: 6

The current time of the caller.

sysDate
YYYY-MM-DD Length: 10

The current date of the KontoCloud server

sysTime
HHMMSS Length: 6

The current time of the KontoCloud server

responseCode
String Length: 4

The response code. See Response Codes in the Lookups.

responseDescription
String Length: 512

The response description. See Response Codes in the Lookups.

Response sample

Status Code:

201 (Created)

Header:

Content-Type: application/json
Accept-Language: en-US

{
   "partnerReference": "1234567890",
   "initiatorAccno": "98765",
   "accno": "XXX-123456",
   "uniqueReference": "d633d423651c4cc4bb04b6be69a13ecd",
   "custom1": "Custom information 1",
   "custom2": "",
   "custom3": "",
   "statusCode": "CANCELLED",
   "statusReason": "",
   "localDate": "2014-03-12",
   "localTime": "163835",
   "sysDate": "2014-03-12",
   "sysTime": "153837",
   "responseCode": "0000",
   "responseDescription": "Successful execution.",
    "additionalInformation": {
        "requestId": "aff2728481a181dc36daedc14055b516"
    }
}

 1.41 Get Payment Status

get {baseURL}/payment/{uniqueReference}/status?&partnerReference={partnerReference}&localDate={localDate}&localTime={localTime}

This interface method is used to get a status of a transaction.

Request parameters

uniqueReference
String Length: 36 Required

Unique transaction reference assigned by the KontoCloud.

partnerReference
String Length: 64 Required

Partner service call identifier.

localDate
YYYY-MM-DD Length: 10 Required

The current date of the caller.

localTime
HHMMSS Length: 6 Required

The current time of the caller.

Request sample

Path:

GET {baseURL}/payment/1234567890/status?partnerReference=1234567890&localDate=2014-03-12&localTime=163835

Header:

Content-Type: application/json
Accept-Language: en-US
X-Auth-Token: eyJhbGciOiJSUzI1NiI{abbreviated}RW5kVG9rZW4=


Response parameters

uniqueReference
String Length: 36

Unique transaction reference assigned by the KontoCloud. Same as in request.

partnerReference
String Length: 64

Partner service call identifier.

initiatorAccno
String Length: 255

Initiator account number.

initiatorName
String Length: 201

Name of the instance which initiated the payment.

accno
String Length: 255

Account number.

presentationAmount
Decimal Length: 18,2

Amount with which the payment was initiated or captured.

presentationCurrCode
String Length: 3

The 3-letter currency code associated with the transaction.

presentationUsage
String Length: 127

Information relevant to the payment.

customerFullName
String Length: 201

Customer full name consisting of the first name and last name.

addr1
String Length: 60

Address line 1.

addr2
String Length: 60

Address line 2.

addr3
String Length: 60

Address line 3.

houseNumber
String Length: 10

House number.

city
String Length: 50

City name.

state
String Length: 50

State name.

country
String Length: 100

Country name.

countryCode
String Length: 2

Country ISO 3166-1 alpha-2 code.

countryCode3
String Length: 3

Country ISO 3166-1 alpha-3 code.

postCode
String Length: 10

Postal code.

statusCode
String Length: 10

Transaction status code. See Transaction Status in the Lookups.

statusReason
String Length: 255

Reason for a status code.

localDate
YYYY-MM-DD Length: 10

The current date of the caller.

localTime
HHMMSS Length: 6

The current time of the caller.

sysDate
YYYY-MM-DD Length: 10

The current date of the KontoCloud server

sysTime
HHMMSS Length: 6

The current time of the KontoCloud server

responseCode
String Length: 4

The response code. See Response Codes in the Lookups.

responseDescription
String Length: 512

The response description. See Response Codes in the Lookups.

Response sample

Status Code:

200 (OK)

Header:

Content-Type: application/json
Accept-Language: en-US

{
   "uniqueReference": "1234567890",
   "partnerReference": "1234567890",
   "initiatorAccno": "123456",
   "initiatorName": "C4U-Malta Limited",
   "accno": "XXX-123456",
   "presentationAmount": 100.00,
   "presentationCurrCode": "EUR",
   "presentationUsage": "Buying a vodafone monthly subscription.",
   "custom1": "Custom information 1",
   "custom2": "",
   "custom3": "",
   "customerFullName": "Max Mustermann",
   "addr1": "Platz der Republik 1",
   "addr2": "",
   "addr3": "",
   "houseNumber": "",
   "city": "Berlin",
   "state": "",
   "stateCode": null,
   "country": "Germany",
   "postCode": "11011",
   "statusCode": "CAPTURED",
   "statusReason": "",
   "localDate": "2014-03-12",
   "localTime": "163835",
   "sysDate": "2014-03-12",
   "sysTime": "153837",
   "responseCode": "0000",
   "responseDescription": "Successful execution.",
    "additionalInformation": {
        "requestId": "aff2728481a181dc36daedc14055b516"
    }
}

 TPP

 Card Based Payment Instruments

 1.17 Find User Account

get {baseURL}/account/find?partnerReference={partnerReference}&programCode={programCode}&userId={userId}&localDate={localDate}&localTime={localTime}

A request to find an account number based on the user identifier.

Request parameters

accno
String Length: 255 Required

E-wallet user account number.

partnerReference
String Length: 64 Required

Partner service call identifier.

programCode
String Length: 10 Required

Program code

userId
String Length: 255 Required

User identifier: email, login, secondary email address, or uuid.

localDate
YYYY-MM-DD Length: 10 Required

The current date of the caller.

localTime
HHMMSS Length: 6 Required

The current time of the caller.

Request Sample

Path:

GET {baseURL}/account/find?partnerReference=50F45B51E07D4CE1ABB1676E3DF5BB44&programCode=COMPANY123&userId=user@example.com&localDate=2016-01-31&localTime=131415

Header:

Content-Type: application/json
Accept-Language: en-US
X-Auth-Token: eyJhbGciOiJSUzI1NiI{abbreviated}RW5kVG9rZW4=


Response parameters

partnerReference
String Length: 64

partnerReference same as in the Request.

programCode
String Length: 10

Program code

accno
String Length: 255

Account number.

localDate
YYYY-MM-DD Length: 10

The current date of the caller.

localTime
HHMMSS Length: 6

The current time of the caller.

sysDate
YYYY-MM-DD Length: 10

The current date of the KontoCloud server

sysTime
HHMMSS Length: 6

The current time of the KontoCloud server

responseCode
String Length: 4

The response code. See Response Codes in the Lookups.

responseDescription
String Length: 512

The response description. See Response Codes in the Lookups.

Response sample

Status Code:

200 (OK)

Header:

Content-Type: application/json
Accept-Language: en-US

{
 "accno": "1000104149",
 "partnerReference": "50F45B51E07D4CE1ABB1676E3DF5BB44",
 "programCode": "COMPANY123",
 "localDate": "2016-01-31",
 "localTime": "131415",
 "sysDate": "2016-01-31",
 "sysTime": "121420",
 "responseCode": "0000",
 "responseDescription": "Successful execution",
    "additionalInformation": {
        "requestId": "aff2728481a181dc36daedc14055b516"
    }
}

 1.146 Check Available Payment Amount

get {baseURL}/account/{accno}/checkAvailablePaymentAmount?partnerReference={partnerReference}&programCode={programCode}&accnoType={accnoType}&amount={amount}&currCode={currCode}&localDate={localDate}&localTime={localTime}

A request to check the availability of the amount for the payment from the specified E-Wallet account.

Request parameters

accno
String Length: 255 Required

E-wallet user account number.

partnerReference
String Length: 64 Required

Partner service call identifier.

programCode
String Length: 10 Required

Program code

accnoType
String Length: 2 Required

Account number type. See Account Number Type in the Lookups.

amount
Decimal Length: 18.2 Required

The amount to be checked for availability to payment from the account.

currCode
String Length: 3 Required

The 3-letter currency code of the checked amount.

localDate
YYYY-MM-DD Length: 10 Required

The current date of the caller.

localTime
HHMMSS Length: 6 Required

The current time of the caller.

Request Sample

Path:

GET {baseURL}/account/XXX-123456/checkAvailablePaymentAmount?partnerReference=50F45B51E07D4CE1ABB1676E3DF5BB44&programCode=COMPANY123&accnoType=00&amount=100&currCode=EUR&localDate=2019-12-02&localTime=131415

Header:

Content-Type: application/json
Accept-Language: en-US
X-Auth-Token: eyJhbGciOiJSUzI1NiI{abbreviated}RW5kVG9rZW4=


Response parameters

The response contains the following possible text values without quotes:

  • "yes" –  if the amount is available;
  • "no" – if the amount is not available.

Response Sample (Successful)

Status Code:

200 (OK)

Header:

Content-Type: text/plain
Accept-Language: en-US

yes

Response Sample (Fail Case)

Status Code:

400 (Bad Request)

Header:

Content-Type: application/json
Accept-Language: en-US

{
  "partnerReference": "50F45B51E07D4CE1ABB1676E3DF5BB44",
  "sysDate": "2000-12-31",
  "sysTime": "235959",
  "responseCode": "0008",
  "responseDescription": "Invalid account number supplied: 1234567890.",
  "additionalInformation": {
    "requestId": "aff2728481a181dc36daedc14055b516"
  }
}

 Account Information

 1.7 Account Enquiry

get {baseURL}/account/{accno}/enquiry?partnerReference={partnerReference}&programCode={programCode}&accnoType={accnoType}&startDate={startDate}&endDate={endDate}&top={top}&skip={skip}&localDate={localDate}&localTime={localTime}

Returns the transactions performed by the account holder with an option additionally to receive pending transactions in the result.

Request parameters

accno
String Length: 255 Required

E-wallet user account number.

partnerReference
String Length: 64 Required

Partner service call identifier.

programCode
String Length: 10 Required

Program code

accnoType
String Length: 2 Required

Account number type. See Account Number Type in the Lookups.

startDate
YYYY-MM-DD Length: 10

Start date for the enquiry. Only account entries on this day and beyond will be returned. If not specified, the search will return results from the first account entry.

startTime
HHMMSS Length: 6

Start time for the enquiry. If 'startTime' is provided, 'startDate' becomes required. If not specified "000000" is used as start time.

endDate
YYYY-MM-DD Length: 10

End date for the enquiry. Only account entries on this day and before will be returned. If not specified, the search will return results up to the last account entry.

endTime
HHMMSS Length: 6

End time for the enquiry. If 'endTime' is provided, 'endDate' becomes required. If not specified "235959" is used as end time.

top
Number Length: 4

Number of account entries to return. Used for requesting a specific number of the most recent account entries.

skip
Number Length: 4

Number of account entries to skip in the result set. Used for skipping a specific number of the most recent account entries.

includeNeutral
Boolean

Defines if the Neutral Account Entries should be used. 'False' – if not specified. if 'True' – both Account Entries and Neutral Account Entries should be returned.

sortDirection
String Length: 4

Defines the direction of sorting by booking date. See Sort Direction in the Lookups. If not specified, "ASC" is used.

includePendingTransactions
Boolean

A flag defining whether pending transactions should be included in the response. "False" is used if it is not provided.

localDate
YYYY-MM-DD Length: 10 Required

The current date of the caller.

localTime
HHMMSS Length: 6 Required

The current time of the caller.

Request Sample

Path:

GET {baseURL}/account/XXX-123456/enquiry?partnerReference=1234567890&programCode=PROG &accnoType=00&startDate=2014-01-01&endDate=2014-01-31&top=100& includePendingTransactions=false&skip=100 &localDate=2014-03-12&localTime=163835

Header:

Content-Type: application/json
Accept-Language: en-US
X-Auth-Token: eyJhbGciOiJSUzI1NiI{abbreviated}RW5kVG9rZW4=


Response parameters

partnerReference
String Length: 64

Partner service call identifier.

programAccno
String Length: 255

Program account number.

accno
String Length: 255

E-wallet user account number or merchant account number.

count
Number Length: 6

Total pending transactions count using the 'startDate' and 'endDate' filters.

localTime
HHMMSS Length: 6

The current time of the caller.

sysDate
YYYY-MM-DD Length: 10

The current date of the KontoCloud server

sysTime
HHMMSS Length: 6

The current time of the KontoCloud server

responseCode
String Length: 4

The response code. See Response Codes in the Lookups.

responseDescription
String Length: 512

The response description. See Response Codes in the Lookups.

Response Sample

Status Code:

200 (OK)

Header:

Content-Type: application/json
Accept-Language: en-US

{
    "partnerReference": "1234567890",
    "programCode": "PROG",
    "accno": "XXX-123456",
    "count": 2,
    "entries": [
        {
            "isPending": false,
            "bookingDate": "2014-01-15",
            "bookingTime": "221133",
            "valueDate": "2014-01-16",
            "valueTime": "102030",
            "sourceAmount": 5.00,
            "sourceCurrCode": "EUR",
            "amount": 5.00,
            "currCode": "EUR",
            "exchangeRate": 1.00,
            "balance": 45.00,
            "entryIndicator": "DBIT",
            "description": "XXXXXXXXXXXXXXXXXX",
            "name": "John Doe",
            "entryType": "Payment",
            "reference": "3150a55a754c443d86398dfab1be7afa",
            "statusCode": "SETTLED",
            "paymentOptionCode": "MSTRCRD"
        },
        {
            "isPending": false,
            "bookingDate": "2014-01-15",
            "bookingTime": "221133",
            "valueDate": "2014-01-16",
            "valueTime": "102030",
            "sourceAmount": 5.00,
            "sourceCurrCode": "EUR",
            "amount": 5.00,
            "currCode": "EUR",
            "exchangeRate": 1.00,
            "balance": 40.00,
            "entryIndicator": "DBIT",
            "description": "XXXXXXXXXXXXXXXXXX",
            "name": "John Doe",
            "entryType": "Payment",
            "reference": "f7e4fb07f0364d1288d535274bc02da6",
            "statusCode": "SETTLED",
            "paymentOptionCode": "MSTRCRD"
        }
    ],
    "localDate": "2014-03-12",
    "localTime": "163835",
    "sysDate": "2014-03-12",
    "sysTime": "153837",
    "responseCode": "0000",
    "responseDescription": "Successful execution.",
    "additionalInformation": {
        "requestId": "aff2728481a181dc36daedc14055b516"
    }
}

 1.8 Balance Enquiry

get {baseURL}/account/{accno}/balance?partnerReference={partnerReference}&programCode={programCode}&accnoType={accnoType}&localDate={localDate}&localTime={localTime}

A request for a balance enquiry returns the current available balance on the account.

Request parameters

accno
String Length: 255 Required

E-wallet user account number.

partnerReference
String Length: 64 Required

Partner service call identifier.

programCode
String Length: 10 Required

Program code

accnoType
String Length: 2 Required

Account number type. See Account Number Type in the Lookups.

localDate
YYYY-MM-DD Length: 10 Required

The current date of the caller.

localTime
HHMMSS Length: 6 Required

The current time of the caller.

Request Sample

Path:

GET {baseURL}/account/1000104149/balance?partnerReference=50F45B51E07D4CE1ABB1676E3DF5BB44&programCode=COMPANY123&accnoType=01&localDate=2016-01-31&localTime=131415

Header:

Content-Type: application/json
Accept-Language: en-US
X-Auth-Token: eyJhbGciOiJSUzI1NiI{abbreviated}RW5kVG9rZW4=


Response parameters

partnerReference
String Length: 64

Partner service call identifier.

programAccno
String Length: 255

Program account number.

accno
String Length: 255

E-wallet user account number or merchant account number.

psBal
Decimal Length: 18

Previous day closing balance.

avlBal
Decimal Length: 18

Current available balance (booked balance – blocked Amount).

bkBal
Decimal Length: 18

Booked balance: Booked balance is the total deposit on a particular day plus previous closing balance.

blkAmt
Decimal Length: 18

Total Blocked amount: Blocked amount is the authorized amount until it is captured or cancelled.

pooledAmt
Decimal Length: 18,2

Total Pooled amount: Pooled amount is authorized only on the wallet account, but not on the external payment option.

currCode
String Length: 3

Currency code of the balance returned.

localTime
HHMMSS Length: 6

The current time of the caller.

sysDate
YYYY-MM-DD Length: 10

The current date of the KontoCloud server

sysTime
HHMMSS Length: 6

The current time of the KontoCloud server

responseCode
String Length: 4

The response code. See Response Codes in the Lookups.

responseDescription
String Length: 512

The response description. See Response Codes in the Lookups.

Response Sample

Status Code:

200 (OK)

Header:

Content-Type: application/json
Accept-Language: en-US

{
 "accno": "1000104149",
 "psBal": 0,
 "avlBal": 12.34,
 "bkBal": 12.34,
 "blkAmt": 0,
 "pooledAmt": 0,
 "currCode": "EUR",
 "partnerReference": "50F45B51E07D4CE1ABB1676E3DF5BB44",
 "programCode": "COMPANY123",
 "localDate": "2016-01-31",
 "localTime": "000000",
 "sysDate": "2016-06-15",
 "sysTime": "131950",
 "responseCode": "0000",
 "responseDescription": "Successful execution",
    "additionalInformation": {
        "requestId": "aff2728481a181dc36daedc14055b516"
    }
}

 Payment Initiation

 1.42 KC-Authorize

put {baseURL}/payment/kc-authorize

This interface method is used to authorize a payment from an e-wallet account to a merchant.

Request parameters

partnerReference
String Length: 64 Required

Partner service call identifier.

depositReference
String Length: 36

uniqueReference of a transaction that was assigned to a capture external authorization request.

accno
String Length: 255 Required

E-wallet user account number.

merchantAccno
String Length: 255

Merchant account number.

programCode
String Length: 10 Required

Program code

programAccno
String Length: 255 Required

Program account number.

merchantProgramCode
String Length: 10

Destination program code. Mandatory if merchantAccno is specified as External Account Reference.

accnoType
String Length: 2 Required

Account number type. See Account Number Type in the Lookups.

paymentAmount
Decimal Length: 18,2 Required

The amount of payment .

paymentCurrCode
String Length: 3 Required

The 3-letter currency code associated with the transaction.

paymentUsage
String Length: 255 Required

Description of a performed payment.

useDifferentBillingAddress
Boolean Required

Defines whether the stored address or a custom billing address is used. If true, the fields 'customerFullName', 'addr1', 'city', 'countryCode', 'postCode' are required. If false, the account owner address is used.

customerFullName
String Length: 201

Customer full name consisting of the first name and last name.

countryCode
String Length: 3 Required

Country ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code.

addr1
String Length: 60

Customer's address line 1.

addr2
String Length: 60

Customer's address line 2.

addr3
String Length: 60

Customer's address line 3.

houseNumber
String Length: 10

Customer's house number.

city
String Length: 50

Customer's city name.

state
String Length: 50

State name.

postCode
String Length: 10

Customer's postal code.

phone
String Length: 30

Phone number.

emailAddress
String

Email address.

localDate
YYYY-MM-DD Length: 10 Required

The current date of the caller.

localTime
HHMMSS Length: 6 Required

The current time of the caller.

Request Sample

Path:

PUT {baseURL}/payment/kc-authorize

Header:

Content-Type: application/json
Accept-Language: en-US
X-Auth-Token: eyJhbGciOiJSUzI1NiI{abbreviated}RW5kVG9rZW4=

{
 "partnerReference": "50F45B51E07D4CE1ABB1676E3DF5BB44",
 "depositReference": "da530d6055b14364991e79aec1a36a74",
 "accno": "123000045",
 "merchantAccno": "000000005",
 "programAccno": "000000001",
 "accnoType": "01",
 "paymentAmount": 100.00,
 "paymentCurrCode": "EUR",
 "paymentUsage": "One off top up.",
 "useDifferentBillingAddress": false,
 "localDate": "2014-03-12",
 "localTime": "131415"
}

Response parameters

partnerReference
String Length: 64

Partner service call identifier.

uniqueReference
String Length: 36

Unique reference assigned by KontoCloud to the credit transaction.

accno
String Length: 255

E-wallet user account number or merchant account number.

merchantAccno
String Length: 255

Seller merchant account number.

programAccno
String Length: 255

Program account number.

paymentAmount
Decimal Length: 18,2

The amount of payment .

paymentCurrCode
String Length: 3

The 3-letter currency code associated with the transaction.

paymentUsage
String Length: 255

Description of a performed payment.

fxRate
Decimal Length: 18,2

Currency conversion rate between payment currency and merchant account currency used in the transaction.

statusCode
String Length: 10

Transaction status code. See Transaction Status in the Lookups.

statusReason
String Length: 255

Reason for a status code.

localTime
HHMMSS Length: 6

The current time of the caller.

sysDate
YYYY-MM-DD Length: 10

The current date of the KontoCloud server

sysTime
HHMMSS Length: 6

The current time of the KontoCloud server

responseCode
String Length: 4

The response code. See Response Codes in the Lookups.

responseDescription
String Length: 512

The response description. See Response Codes in the Lookups.

Response Sample

Status Code:

200 (OK)

Header:

Content-Type: application/json
Accept-Language: en-US

{
"partnerReference": "1234567890",
"uniqueReference": "d633d423651c4cc4bb04b6be69a13ecd",
"accno": "123000045",
"merchantAccno": "000000005",
"programAccno": "000000001",
"paymentAmount": 100.00,
"paymentCurrCode": "EUR",
"paymentUsage": "One off top up.",
"fxRate": 1.00,
"statusCode": "AUTHORIZED",
"statusReason": "",
"localDate": "2014-03-12",
"localTime": "163835",
"sysDate": "2014-03-12",
"sysTime": "153837",
"responseCode": "0000",
"responseDescription": "Successful execution.",
    "additionalInformation": {
        "requestId": "aff2728481a181dc36daedc14055b516"
    }
}

 1.121 KC-Debit Account

put {baseURL}/payment/kc-debitAccount

This interface method is used to initiate a payment from an e-wallet account to a merchant account.

Request parameters

partnerReference
String Length: 64 Required

Partner service call identifier.

depositReference
String Length: 36

uniqueReference of a transaction that was assigned to a capture external authorization request.

accno
String Length: 255 Required

E-wallet user account number or merchant account number.

programAccno
String Length: 255 Required

Initiating program account number.

merchantAccno
String Length: 255 Required

Destination merchant account number.

merchantProgramCode
String Length: 10

Destination program code. Mandatory if merchantAccno is specified as External Account Reference.

accnoType
String Length: 2 Required

Account number and merchant account number type. Refer to Account Number Type in the Lookups.

paymentAmount
Decimal Length: 18,2 Required

The amount of payment from eWallet account to merchant account.

paymentCurrCode
String Length: 3 Required

The 3-letter currency code associated with the transaction.

paymentUsage
String Length: 255 Required

Description of a performed payment.

useDifferentBillingAddress
Boolean Required

Defines whether the stored address or a custom billing address is used. If true, the fields 'customerFullName', 'addr1', 'city', 'countryCode', 'postCode' are required. If false, the account owner address is used.

customerFullName
String Length: 201

Customer full name consisting of the first name and last name.

countryCode
String Length: 3 Required

Country ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code.

addr1
String Length: 60

Customer's address line 1.

addr2
String Length: 60

Customer's address line 2.

addr3
String Length: 60

Customer's address line 3.

houseNumber
String Length: 10

Customer's house number.

city
String Length: 50

Customer's city name.

state
String Length: 50

State name.

postCode
String Length: 10

Customer's postal code.

emailAddress
String

Email address.

oneTimePassword
String Length: 8

One Time Password used for confirmation during Two Factor Authentication.

localDate
YYYY-MM-DD Length: 10 Required

The current date of the caller.

localTime
HHMMSS Length: 6 Required

The current time of the caller.

Request Sample

Path:

PUT {baseURL}/payment/kc-debitAccount

Header:

Content-Type: application/json
Accept-Language: en-US
X-Auth-Token: eyJhbGciOiJSUzI1NiI{abbreviated}RW5kVG9rZW4=

{
 "partnerReference": "50F45B51E07D4CE1ABB1676E3DF5BB44",
 "depositReference": "da530d6055b14364991e79aec1a36a74",
 "accno": "123000045",
 "programAccno": "000000001",
 "merchantAccno": "000000005",
 "merchantProgramCode": "COMPANY123",
 "accnoType": "01",
 "paymentAmount": 100.00,
 "paymentCurrCode": "EUR",
 "paymentUsage": "One off top up.",
 "useDifferentBillingAddress": false,
 "localDate": "2014-03-12",
 "localTime": "131415"
}

Response parameters

partnerReference
String Length: 64

Partner service call identifier.

uniqueReference
String Length: 36

Unique reference assigned by KontoCloud to the credit transaction.

accno
String Length: 255

E-wallet user account number or merchant account number.

programAccno
String Length: 255

Program account number.

merchantAccno
String Length: 255

Seller merchant account number.

merchantProgramCode
String Length: 10

Destination program code.

paymentAmount
Decimal Length: 18,2

The amount of payment .

paymentCurrCode
String Length: 3

The 3-letter currency code associated with the transaction.

paymentUsage
String Length: 255

Description of a performed payment.

fxRate
Decimal Length: 18

Currency conversion rate used.

statusCode
String Length: 10

Transaction status code. See Transaction Status in the Lookups.

statusReason
String Length: 255

Reason for a status code.

localTime
HHMMSS Length: 6

The current time of the caller.

sysDate
YYYY-MM-DD Length: 10

The current date of the KontoCloud server

sysTime
HHMMSS Length: 6

The current time of the KontoCloud server

responseCode
String Length: 4

The response code. See Response Codes in the Lookups.

responseDescription
String Length: 512

The response description. See Response Codes in the Lookups.

Response Sample

Status Code:

200 (OK)

Header:

Content-Type: application/json
Accept-Language: en-US

{
"uniqueReference": "653d5e9f63e24be495f3aecdcc4e9825",
"partnerReference": "1234567890",
"accno": "123000045",
"programAccno": "000000001",
"merchantAccno": "000000005",
"merchantProgramCode": "COMPANY123",
"paymentAmount": 100.00,
"paymentCurrCode": "EUR",
"paymentUsage": "One off top up.",
"fxRate": 1.00,
"statusCode": "CAPTURED",
"statusReason": "",
"localDate": "2014-03-12",
"localTime": "163835",
"sysDate": "2014-03-12",
"sysTime": "153837",
"responseCode": "0000",
"responseDescription": "Successful execution.",
    "additionalInformation": {
        "requestId": "aff2728481a181dc36daedc14055b516"
    }
}

 1.14 KC-Capture

post {baseURL}/payment/{uniqueReference}/kc-capture

This interface method is used to capture a previously authorized payment from an e-wallet account to a merchant.

Request parameters

uniqueReference
String Length: 36 Required

This is the uniqueReference that was assigned to an authorization. It is received as part of "KC-Authorize" response from KontoCloud.

partnerReference
String Length: 64 Required

Partner service call identifier.

modifiedAmount
Decimal Length: 18,2 Required

The amount of payment from the e-Wallet account to the merchant account.

modifiedAmountCurrCode
String Length: 3 Required

The 3-letter currency code associated with the transaction.

modifiedUsage
String Length: 127

Information relevant to the payment.

localDate
YYYY-MM-DD Length: 10 Required

The current date of the caller.

localTime
HHMMSS Length: 6 Required

The current time of the caller.

Request Sample

Path:

POST {baseURL}/payment/1234567890/kc-capture

Header:

Content-Type: application/json
Accept-Language: en-US
X-Auth-Token: eyJhbGciOiJSUzI1NiI{abbreviated}RW5kVG9rZW4=

{
  "partnerReference": "1234567890",
  "modifiedAmount": 100.00,
  "modifiedAmountCurrCode": "EUR",
  "localDate": "2014-03-12",
  "localTime": "163835"
}

Response parameters

uniqueReference
String Length: 36

A unique reference assigned to the authorization by KontoCloud. Same as in the request.

partnerReference
String Length: 64

Partner service call identifier.

merchantAccno
String Length: 255

Merchant account number.

accno
String Length: 255

Account number.

modifiedAmount
Decimal Length: 18,2

The amount of payment from the e-Wallet account to the merchant account.

modifiedAmountCurrCode
String Length: 3

The 3-letter currency code associated with the transaction.

processedAmount
Decimal Length: 18

The amount the member is paying from their e-Wallet account to the merchant account in the merchant account currency.

fxRate
Decimal Length: 18,2

Currency conversion rate between payment currency and merchant account currency used in the transaction.

statusCode
String Length: 10

Transaction status code. See Transaction Status in the Lookups.

statusReason
String Length: 255

Reason for a status code.

localTime
HHMMSS Length: 6

The current time of the caller.

sysDate
YYYY-MM-DD Length: 10

The current date of the KontoCloud server

sysTime
HHMMSS Length: 6

The current time of the KontoCloud server

responseCode
String Length: 4

The response code. See Response Codes in the Lookups.

responseDescription
String Length: 512

The response description. See Response Codes in the Lookups.

Response Sample

Status Code:

200 (OK)

Header:

Content-Type: application/json
Accept-Language: en-US

{
  "uniqueReference": "1234567890",
  "partnerReference": "1234567890",
  "merchantAccno": "123456",
  "accno": "XXX-123456",
  "modifiedAmount": 90.00,
  "modifiedAmountCurrCode": "EUR",
  "processedAmount": 90.00,
  "processedCurrCode": "EUR",
  "fxRate": 1.00,
  "statusCode": "CAPTURED",
  "statusReason": "",
  "localDate": "2014-03-12",
  "localTime": "163835",
  "sysDate": "2014-03-12",
  "sysTime": "153837",
  "responseCode": "0000",
  "responseDescription": "Successful execution.",
  "additionalInformation": {
    "requestId": "aff2728481a181dc36daedc14055b516"
  }
}

 1.15 KC-Cancel

post {baseURL}/payment/{uniqueReference}/kc-cancel

This interface method is used to cancel a previously authorized payment before it is captured.

Request parameters

uniqueReference
String Length: 36 Required

This is the uniqueReference that was assigned to an authorization. It is received as part of "KC-Authorize" response from KontoCloud.

partnerReference
String Length: 64 Required

Partner service call identifier.

modifiedUsage
String Length: 127

Information relevant to the payment.

localDate
YYYY-MM-DD Length: 10 Required

The current date of the caller.

localTime
HHMMSS Length: 6 Required

The current time of the caller.

Request Sample

Path:

POST {baseURL}/payment/1234567890/kc-cancel

Header:

Content-Type: application/json
Accept-Language: en-US
X-Auth-Token: eyJhbGciOiJSUzI1NiI{abbreviated}RW5kVG9rZW4=

{
  "partnerReference": "1234567890",
  "modifiedUsage": "Cancelled by the client.",
  "localDate": "2014-03-12",
  "localTime": "163835"
}

Response parameters

uniqueReference
String Length: 36

A unique reference assigned to the authorization by KontoCloud. Same as in the request.

partnerReference
String Length: 64

Partner service call identifier.

merchantAccno
String Length: 255

Merchant account number.

accno
String Length: 255

Account number.

statusCode
String Length: 10

Transaction status code. See Transaction Status in the Lookups.

statusReason
String Length: 255

Reason for a status code.

localTime
HHMMSS Length: 6

The current time of the caller.

sysDate
YYYY-MM-DD Length: 10

The current date of the KontoCloud server

sysTime
HHMMSS Length: 6

The current time of the KontoCloud server

responseCode
String Length: 4

The response code. See Response Codes in the Lookups.

responseDescription
String Length: 512

The response description. See Response Codes in the Lookups.

Response Sample

Status Code:

200 (OK)

Header:

Content-Type: application/json
Accept-Language: en-US

{
  "uniqueReference": "1234567890",
  "partnerReference": "1234567890",
  "merchantAccno": "123456",
  "accno": "XXX-123456",
  "statusCode": "CANCELLED",
  "statusReason": "",
  "localDate": "2014-03-12",
  "localTime": "163835",
  "sysDate": "2014-03-12",
  "sysTime": "153837",
  "responseCode": "0000",
  "responseDescription": "Successful execution.",
  "additionalInformation": {
    "requestId": "aff2728481a181dc36daedc14055b516"
  }
}

 1.16 KC-Refund

post {baseURL}/payment/{uniqueReference}/kc-refund

This interface method is used to refund a previously captured payment.

Request parameters

uniqueReference
String Length: 36 Required

This is the uniqueReference that was assigned to an authorization. It is received as part of "KC-Authorize" response from KontoCloud.

partnerReference
String Length: 64 Required

Partner service call identifier.

refundAmount
Decimal Length: 18,2

Amount being refunded. It cannot exceed the amount of the refunded transaction. If the value is not provided the full refund is performed.

refundUsage
String Length: 255

Information relevant to the refund.

refundType
String Length: 1

The code defining what type of refund will be performed. Available types of refund listed in "Refund Type" lookup.

localDate
YYYY-MM-DD Length: 10 Required

The current date of the caller.

localTime
HHMMSS Length: 6 Required

The current time of the caller.

Request Sample

Path:

POST {baseURL}/payment/1234567890/kc-refund

Header:

Content-Type: application/json
Accept-Language: en-US
X-Auth-Token: eyJhbGciOiJSUzI1NiI{abbreviated}RW5kVG9rZW4=

{
  "partnerReference": "1234567890",
  "refundType": "0",
  "localDate": "2014-03-12",
  "localTime": "163835"
}

Response parameters

uniqueReference
String Length: 36

A unique reference assigned to the authorization by KontoCloud. Same as in the request.

partnerReference
String Length: 64

Partner service call identifier.

refundSourceAccno
String Length: 255

Refund source account number.

accno
String Length: 255

Account number.

statusCode
String Length: 10

Transaction status code. See Transaction Status in the Lookups.

statusReason
String Length: 255

Reason for a status code.

localTime
HHMMSS Length: 6

The current time of the caller.

sysDate
YYYY-MM-DD Length: 10

The current date of the KontoCloud server

sysTime
HHMMSS Length: 6

The current time of the KontoCloud server

responseCode
String Length: 4

The response code. See Response Codes in the Lookups.

responseDescription
String Length: 512

The response description. See Response Codes in the Lookups.

Response Sample

Status Code:

200 (OK)

Header:

Content-Type: application/json
Accept-Language: en-US

{
  "uniqueReference": "1234567890",
  "partnerReference": "1234567890",
  "refundSourceAccno": "123456",
  "accno": "XXX-123456",
  "statusCode": "CAPTURED",
  "statusReason": "",
  "localDate": "2014-03-12",
  "localTime": "163835",
  "sysDate": "2014-03-12",
  "sysTime": "153837",
  "responseCode": "0000",
  "responseDescription": "Successful execution.",
  "additionalInformation": {
    "requestId": "aff2728481a181dc36daedc14055b516"
  }
}

 Ancillary Services

 Address Validation

 1.105 Perform Address Check

post {baseURL}/compliance/addressCheck

A request to check the validity of an address.

Request parameters

partnerReference
String Length: 64 Required

Partner service call identifier.

programCode
String Length: 10 Required

Program code

street
String Length: 68 Required

Street.

house
String Length: 10

House.

postalCode
String Length: 10

Postal code.

city
String Length: 50

City name.

countryCode
String Length: 3

Country ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code.

localDate
YYYY-MM-DD Length: 10 Required

The current date of the caller.

localTime
HHMMSS Length: 6 Required

The current time of the caller.

Request sample

Path:

POST {baseURL}/compliance/addressCheck

Header:

Content-Type: application/json
Accept-Language: en-US
X-Auth-Token: eyJhbGciOiJSUzI1NiI{abbreviated}RW5kVG9rZW4=

{
  "partnerReference": "50F45B51E07D4CE1ABB1676E3DF5BB44",
  "programCode": "COMPANY123",
  "street": "Rathausstraße.",
  "house": "8",
  "postalCode": "24960",
  "city": "Glücksburg",
  "line2": null,
  "line3": null,
  "countryCode": "DE",
  "localDate": "2016-01-31",
  "localTime": "131415"
}

Response parameters

partnerReference
String Length: 64

Partner service call identifier.

programCode
String Length: 10

Program code

localDate
YYYY-MM-DD Length: 10

The current date of the caller.

localTime
HHMMSS Length: 6

The current time of the caller.

sysDate
YYYY-MM-DD Length: 10

The current date of the KontoCloud server

sysTime
HHMMSS Length: 6

The current time of the KontoCloud server

responseCode
String Length: 4

The response code. See Response Codes in the Lookups.

responseDescription
String Length: 512

The response description. See Response Codes in the Lookups.

Response sample

Status Code:

200 (OK)

Header:

Content-Type: application/json
Accept-Language: en-US

{
"partnerReference": "50F45B51E07D4CE1ABB1676E3DF5BB44",
"programCode": "COMPANY123",
"addressCheckData":
{
"archiveId": "4742000025020093",
"decision": "HOUSE_CONFIRMED",
"postalCodeCorrect": true,
"normalizedAddress":
{
"street": "Rathausstr.",
"house": "8",
"houseExtension": "",
"postalCode": "24960",
"city": "Glücksburg (Ostsee)",
"countryCode": "DE"
},
"foundAddress":
{
"street": "Rathausstr.",
"house": "8",
"houseExtension": "",
"postalCode": "24960",
"city": "Glücksburg (Ostsee)",
"countryCode": "DE"
}
},
"localDate": "2014-03-12",
"localTime": "163835",
"sysDate": "2014-03-12",
"sysTime": "153837",
"responseCode": "0000",
"responseDescription": "Successful execution.",
    "additionalInformation": {
        "requestId": "aff2728481a181dc36daedc14055b516"
    }
}

 Compliance Check

 1.101 Perform Person Compliance Check

post {baseURL}/compliance/personCheck

A request to check a person's compliance via the compliance system.

Request parameters

partnerReference
String Length: 64 Required

Partner service call identifier.

merchantReference
String Length: 36

Merchant reference to identify the merchant for which the check is being performed.

programCode
String Length: 10 Required

Program code

division
String Length: 100

Division.

customerId
String Length: 255 Required

Customer identifier.

firstName
String Length: 100 Required

First name.

lastName
String Length: 100 Required

Last name.

street
String Length: 68 Required

Street.

house
String Length: 10

House.

postalCode
String Length: 10 Required

Postal code.

city
String Length: 50 Required

City name.

countryCode
String Length: 3 Required

Country ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code.

emailAddress
String Length: 255

Email address.

landlinePhone
String Length: 30

Landline phone number.

mobilePhone
String Length: 30

Mobile phone number.

dateOfBirth
YYYY-MM-DD Length: 10 Required

Date of birth.

placeOfBirth
String Length: 100

Place of birth.

gender
String Length: 6

Gender. See Gender in the Lookups.

nationality
String Length: 3

The ISO2 or ISO3 code of a country a new user is a national of.

localDate
YYYY-MM-DD Length: 10 Required

The current date of the caller.

localTime
HHMMSS Length: 6 Required

The current time of the caller.

Request sample

Path:

POST {baseURL}/compliance/personCheck

Header:

Content-Type: application/json
Accept-Language: en-US
X-Auth-Token: eyJhbGciOiJSUzI1NiI{abbreviated}RW5kVG9rZW4=

{
"partnerReference": "50F45B51E07D4CE1ABB1676E3DF5BB44",
"programCode": "COMPANY123",
"customerId": "100001073541",
"firstName": "Falk",
"lastName": "Quintus",
"street": "Rathausstr.",
"house": "2",
"postalCode": "24960",
"city": "Glücksburg",
"countryCode": "DE",
"dateOfBirth": "1965-04-14",
"gender": "MALE",
"localDate": "2016-01-31",
"localTime": "131415"
}

Response parameters

partnerReference
String Length: 64

Partner service call identifier.

programCode
String Length: 10

Program code

localDate
YYYY-MM-DD Length: 10

The current date of the caller.

localTime
HHMMSS Length: 6

The current time of the caller.

sysDate
YYYY-MM-DD Length: 10

The current date of the KontoCloud server

sysTime
HHMMSS Length: 6

The current time of the KontoCloud server

responseCode
String Length: 4

The response code. See Response Codes in the Lookups.

responseDescription
String Length: 512

The response description. See Response Codes in the Lookups.

Response sample

Status Code:

200 (OK)

Header:

Content-Type: application/json
Accept-Language: en-US

{
"partnerReference": "50F45B51E07D4CE1ABB1676E3DF5BB44",
"programCode": "COMPANY123",
"complianceData":
{
"archiveId": "4108000025015465",
"trafficLight": "YELLOW",
"hitType": "SL",
"manualReview": true,
"details":
[
{
"name": "Falk Quintus",
"birthdate": "19660201"
},
{
"name": "Quintus Falk",
"birthdate": "19660201"
}
],
"listHit": true
},
"localDate": "2014-03-12",
"localTime": "163835",
"sysDate": "2014-03-12",
"sysTime": "153837",
"responseCode": "0000",
"responseDescription": "Successful execution.",
    "additionalInformation": {
        "requestId": "aff2728481a181dc36daedc14055b516"
    }
}

 1.109 Perform Company Compliance Check

post {baseURL}/compliance/companyCheck

A request to check a company's compliance via the compliance system.

Request parameters

partnerReference
String Length: 64 Required

Partner service call identifier.

merchantReference
String Length: 36

Merchant reference to identify the merchant for which the check is being performed.

programCode
String Length: 10 Required

Program code

division
String Length: 100

Division.

customerId
String Length: 255 Required

Customer identifier.

name
String Length: 200 Required

Company name

street
String Length: 68 Required

Street.

house
String Length: 10

House.

postalCode
String Length: 10 Required

Postal code.

city
String Length: 50 Required

City name.

countryCode
String Length: 3 Required

Country ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code.

emailAddress
String Length: 255

Email address.

phone
String Length: 30

Phone number.

vatId
String Length: 20

VAT identifier without the country code.

localDate
YYYY-MM-DD Length: 10 Required

The current date of the caller.

localTime
HHMMSS Length: 6 Required

The current time of the caller.

Request sample

Path:

POST {baseURL}/compliance/companyCheck

Header:

Content-Type: application/json
Accept-Language: en-US
X-Auth-Token: eyJhbGciOiJSUzI1NiI{abbreviated}RW5kVG9rZW4=

{
"partnerReference": "50F45B51E07D4CE1ABB1676E3DF5BB44",
"programCode": "COMPANY123",
"customerId": "100001073541",
"name": "WEST SUN TRADE GMBH",
"street": "Karlstrasse",
"house": "2",
"postalCode": "76133",
"city": "Karlsruhe",
"countryCode": "de",
"vatId": "222793453",
"localDate": "2016-01-31",
"localTime": "131415"
}

Response parameters

partnerReference
String Length: 64

Partner service call identifier.

programCode
String Length: 10

Program code

localDate
YYYY-MM-DD Length: 10

The current date of the caller.

localTime
HHMMSS Length: 6

The current time of the caller.

sysDate
YYYY-MM-DD Length: 10

The current date of the KontoCloud server

sysTime
HHMMSS Length: 6

The current time of the KontoCloud server

responseCode
String Length: 4

The response code. See Response Codes in the Lookups.

responseDescription
String Length: 512

The response description. See Response Codes in the Lookups.

Response sample

Status Code:

200 (OK)

Header:

Content-Type: application/json
Accept-Language: en-US

{
"partnerReference": "50F45B51E07D4CE1ABB1676E3DF5BB44",
"programCode": "COMPANY123",
"complianceData":
{
"archiveId": "4108000025015465",
"trafficLight": "YELLOW",
"hitType": "SL",
"manualReview": true,
"details":
[
{
"name": "West Sun Trade GmbH",
"country": "DE"
},
{
"name": "WEST SUN TRADE GMBH",
"country": "DE"
}
],
"listHit": true
},
"localDate": "2014-03-12",
"localTime": "163835",
"sysDate": "2014-03-12",
"sysTime": "153837",
"responseCode": "0000",
"responseDescription": "Successful execution.",
    "additionalInformation": {
        "requestId": "aff2728481a181dc36daedc14055b516"
    }
}

 Risk Check

 1.110 Perform Person Risk Check

post {baseURL}/compliance/personRiskCheck

A request to check risks associated with a transaction.

Request parameters

partnerReference
String Length: 64 Required

Partner service call identifier.

programCode
String Length: 10 Required

Program code

division
String Length: 100

Division.

merchantAccno
String Length: 255

Merchant account number.

accnoType
String Length: 2

Account number type, applicable to merchantAccno. See Account Number Type in the Lookups.

merchantProgramCode
String Length: 10

Destination program code. Mandatory if merchantAccno is specified as External Account Reference.

customerId
String Length: 255 Required

Customer identifier.

firstName
String Length: 100 Required

First name.

lastName
String Length: 100 Required

Last name.

street
String Length: 68 Required

Street.

house
String Length: 10

House.

postalCode
String Length: 10 Required

Postal code.

city
String Length: 50 Required

City name.

countryCode
String Length: 3 Required

Country ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code.

emailAddress
String Length: 255 Required

Email address.

landlinePhone
String Length: 30

Landline phone number.

mobilePhone
String Length: 30

Mobile phone number.

dateOfBirth
YYYY-MM-DD Length: 10 Required

Date of birth.

placeOfBirth
String Length: 100

Place of birth.

gender
String Length: 6

Gender. See Gender in the Lookups.

nationality
String Length: 3

The ISO2 or ISO3 code of a country a new user is a national of.

VIN
String Length: 20 Required

Vehicle identification number.

paymentOptionCode
String Length: 10 Required

Payment option code.

localDate
YYYY-MM-DD Length: 10 Required

The current date of the caller.

localTime
HHMMSS Length: 6 Required

The current time of the caller.

Request sample

Path:

POST {baseURL}/compliance/personRiskCheck

Header:

Content-Type: application/json
Accept-Language: en-US
X-Auth-Token: eyJhbGciOiJSUzI1NiI{abbreviated}RW5kVG9rZW4=

{
"partnerReference": "50F45B51E07D4CE1ABB1676E3DF5BB44",
"programCode": "COMPANY123",
"merchantAccno": "000000005",
"accnoType": "00",
"merchantProgramCode": "COMPANY123",
"customerId": "100001073541",
"firstName": "Falk",
"lastName": "Quintus",
"street": "Rathausstr.",
"house": "2",
"postalCode": "24960",
"city": "Glücksburg",
"countryCode": "DE",
"emailAddress": "user@example.com",
"dateOfBirth": "1965-04-14",
"orderData":
{
"orderItems":
[
{
"number": "4M0.054.816A 05A",
"name": "connected Infotainment services 3 Monate",
"group": "Infotainment",
"price": 50,
"amount": 1,
"totalPrice": 50,
"itemType": "SUBSCRIPTION"
}
],
"orderValue": 50,
"channel": "In-Car App"
},
"VIN": "123456",
"paymentOptionCode": "VISA",
"localDate": "2016-01-31",
"localTime": "131415"
}

Response parameters

partnerReference
String Length: 64

Partner service call identifier.

programCode
String Length: 10

Program code

localDate
YYYY-MM-DD Length: 10

The current date of the caller.

localTime
HHMMSS Length: 6

The current time of the caller.

sysDate
YYYY-MM-DD Length: 10

The current date of the KontoCloud server

sysTime
HHMMSS Length: 6

The current time of the KontoCloud server

responseCode
String Length: 4

The response code. See Response Codes in the Lookups.

responseDescription
String Length: 512

The response description. See Response Codes in the Lookups.

Response sample

Status Code:

200 (OK)

Header:

Content-Type: application/json
Accept-Language: en-US

{
"partnerReference": "50F45B51E07D4CE1ABB1676E3DF5BB44",
"programCode": "COMPANY123",
"complianceData":
{
"archiveId": "4858000025016093",
"trafficLight": "GREEN",
"recommendation": "All checks successful",
"limit": 100,
"denialReason": ""
},
"localDate": "2014-03-12",
"localTime": "163835",
"sysDate": "2014-03-12",
"sysTime": "153837",
"responseCode": "0000",
"responseDescription": "Successful execution.",
    "additionalInformation": {
        "requestId": "aff2728481a181dc36daedc14055b516"
    }
}

 1.111 Perform Company Risk Check

post {baseURL}/compliance/companyRiskCheck

A request to check risks associated with a transaction.

Request parameters

partnerReference
String Length: 64 Required

Partner service call identifier.

programCode
String Length: 10 Required

Program code

division
String Length: 100

Division.

merchantAccno
String Length: 255

Merchant account number.

accnoType
String Length: 2

Account number type, applicable to merchantAccno. See Account Number Type in the Lookups.

merchantProgramCode
String Length: 10

Destination program code. Mandatory if merchantAccno is specified as External Account Reference.

customerId
String Length: 255 Required

Customer identifier.

name
String Length: 200 Required

Company name

street
String Length: 68 Required

Street.

house
String Length: 10

House.

postalCode
String Length: 10 Required

Postal code.

city
String Length: 50 Required

City name.

countryCode
String Length: 3 Required

Country ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code.

emailAddress
String Length: 255 Required

Email address.

phone
String Length: 30

Phone number.

VIN
String Length: 20 Required

Vehicle identification number.

paymentOptionCode
String Length: 10 Required

Payment option code.

localDate
YYYY-MM-DD Length: 10 Required

The current date of the caller.

localTime
HHMMSS Length: 6 Required

The current time of the caller.

Request sample

Path:

POST {baseURL}/compliance/companyRiskCheck

Header:

Content-Type: application/json
Accept-Language: en-US
X-Auth-Token: eyJhbGciOiJSUzI1NiI{abbreviated}RW5kVG9rZW4=

{
"partnerReference": "50F45B51E07D4CE1ABB1676E3DF5BB44",
"programCode": "COMPANY123",
"merchantAccno": "000000005",
"accnoType": "00",
"merchantProgramCode": "COMPANY123",
"customerId": "100001073541",
"name": "Meier FS AG",
"street": "Petuelring.",
"house": "130",
"postalCode": "80788",
"city": "Muenchen",
"countryCode": "DE",
"emailAddress": "user@example.com",
"orderData":
{
"orderItems":
[
{
"number": "4M0.054.816A 05A",
"name": "connected Infotainment services 3 Monate",
"group": "Infotainment",
"price": 100,
"amount": 1,
"totalPrice": 100,
"itemType": "SUBSCRIPTION"
}
],
"orderValue": 100,
"channel": "In-Car App"
},
"VIN": "123456",
"paymentOptionCode": "VISA",
"localDate": "2016-01-31",
"localTime": "131415"
}

Response parameters

partnerReference
String Length: 64

Partner service call identifier.

programCode
String Length: 10

Program code

localDate
YYYY-MM-DD Length: 10

The current date of the caller.

localTime
HHMMSS Length: 6

The current time of the caller.

sysDate
YYYY-MM-DD Length: 10

The current date of the KontoCloud server

sysTime
HHMMSS Length: 6

The current time of the KontoCloud server

responseCode
String Length: 4

The response code. See Response Codes in the Lookups.

responseDescription
String Length: 512

The response description. See Response Codes in the Lookups.

Response sample

Status Code:

200 (OK)

Header:

Content-Type: application/json
Accept-Language: en-US

{
"partnerReference": "50F45B51E07D4CE1ABB1676E3DF5BB44",
"programCode": "COMPANY123",
"complianceData":
{
"archiveId": "4858000025016093",
"trafficLight": "GREEN",
"recommendation": "All checks successful",
"limit": 100,
"denialReason": ""
},
"localDate": "2014-03-12",
"localTime": "163835",
"sysDate": "2014-03-12",
"sysTime": "153837",
"responseCode": "0000",
"responseDescription": "Successful execution.",
    "additionalInformation": {
        "requestId": "aff2728481a181dc36daedc14055b516"
    }
}

 Miscellaneous

 1.84 Get Financial Institution Data

get {baseURL}/settings/getFinancialInstitutionData?partnerReference={partnerReference}&localDate={localDate}&localTime={localTime}

Returns the financial institution's data.

Request parameters

partnerReference
String Length: 64 Required

Partner service call identifier.

localDate
YYYY-MM-DD Length: 10 Required

The current date of the caller.

localTime
HHMMSS Length: 6 Required

The current time of the caller.

Request sample

Path:

GET {baseURL}/settings/getFinancialInstitutionData?localDate=2017-08-17&localTime=052141&partnerReference=CWEP-38ddbe05265641e2a5519ff63dec79f3

Header:

Content-Type: application/json
Accept-Language: en-US


Response parameters

partnerReference
String Length: 64

Partner service call identifier.

name
String Length: 100

Financial institution name.

addr1
String Length: 34

Financial institution address Line 1.

addr2
String Length: 34

Financial institution address Line 2.

city
String Length: 50

Financial institution city name.

state
String Length: 50

Financial institution state name.

countryName
String Length: 100

Financial institution country name.

countryCode
String Length: 2

Financial institution country ISO 3166-1 alpha-2 code.

countryCode3
String Length: 3

Financial institution country ISO 3166-1 alpha-3 code.

postCode
String Length: 10

Financial institution postal code.

contactPhone
String Length: 30

Financial institution contact phone.

contactEmail
String Length: 255

Financial institution contact email.

creditorIdentifier
String Length: 35

Financial institution creditor identifier.

localDate
YYYY-MM-DD Length: 10

The current date of the caller.

localTime
HHMMSS Length: 6

The current time of the caller.

sysDate
YYYY-MM-DD Length: 10

The current date of the KontoCloud server

sysTime
HHMMSS Length: 6

The current time of the KontoCloud server

responseCode
String Length: 4

The response code. See Response Codes in the Lookups.

responseDescription
String Length: 512

The response description. See Response Codes in the Lookups.

executiveBoard
String Length: 1024

List of Executive Board members.

supervisoryBoard
String Length: 1024

List of Supervisory Board members.

corporationType
String Length: 100

Corporation type.

tradeRegisterNumber
String Length: 8

Trade register number.

vat
String Length: 13

VAT ID Number.

bankName
String Length: 512

Bank name.

iban
String Length: 34

IBAN.

bic
String Length: 11

BIC.

Response sample

Status Code:

200 (OK)

Header:

Content-Type: application/json
Accept-Language: en-US

{
"partnerReference": "1234567890",
"name": "ACME Corporation Financial Institution",
"addr1": "Prinzregentenstr. 1",
"addr2": "Suite 123",
"city": "Munich",
"state": "Bavaria",
"countryName": "Germany",
"countryCode": "DE",
"postCode": "80538",
"contactPhone": "123456789",
"contactEmail": "user@example.com",
"creditIdentifier": "DE98ZZZ09999999999",
"executiveBoard": "Dr. Ernst Ohmayer, Marcus Graefe",
"supervisoryBoard": "Dr. Mario Hermann Daberkow (Chairman), Dr. Christian",
"corporationType": "SOCIÉTÉ ANONYME",
"tradeRegisterNumber": "B215079",
"vat": "29653273",
"bankName": "BGL BNP PARIBAS",
"iban": "LU93 0030 4672 7257 0000",
"bic": "BGLLLULL",
"localDate": "2014-03-12",
"localTime": "163835",
"sysDate": "2014-03-12",
"sysTime": "153837",
"responseCode": "0000",
"responseDescription": "Successful execution.",
    "additionalInformation": {
        "requestId": "aff2728481a181dc36daedc14055b516"
    }
}

 Lookups

 Account Number Type

Account Number Type code

Description

00

External Account Reference

01

KontoCloud Account Number

 Account Flow Status

Status code

Description

ACCEPTED

Accepted

APPROVEDFV

Approved-full-verification

CCRVWPNDNG

Compliance Check Review Pending

CLOSED

Closed

CMSREVIEW

Compliance Review

CMSREVIEWP

Compliance Review (pending)

DOCREQSTD

Documents Requested

DOCREQSTDP

Documents Requested (pending)

EDDAPPRVPC

EDD Approval Pending Compliance

EDDAPPRVPM

EDD Approval Pending Management

EDDAPPRVPO

EDD Approval Pending Operations

EDDPENDING

EDD Pending

EDDPEP

EDD PEP

FULLAPPRVD

Full Wallet Approved

MNTAPPRL

Management Approval

MNTAPPRLP

Management Approval (pending)

NEW

New

ONBDCNFRMD

On-boarding Data Confirmed

ONBDPENDG

On-boarding Data Pending

OPSREVIEW

Operations Review

OPSREVIEWP

Operations Review (pending)

POPENDING

Payment Option Pending

PRTAPPRD

Partially Approved by Management

PRTAPPRDP

Partially Approved by Management (pending)

RDDAPPRVPC

RDD Approval Pending Compliance

RDDAPPRVPO

RDD Approval Pending Operations

RDDPCVAULT

RDD Payment Credentials Vault

RDDPENDING

RDD Pending

RMDPENDING

Remediation Pending

REJECTED

Rejected

S2RAPPRVPC

SDD to RDD Approval Pending Compliance

S2RAPPRVPO

SDD to RDD Approval Pending Operations

S2RPENDING

SDD to RDD Pending

SDDAPPNDNG

SDD Approval Pending

SDDAPPROVD

SDD Approved

 Account Status

Status code

Description

ACTIVE

Active

CLOSED

Closed

INACTIVE

Inactive

REJECTED

Rejected

 Activation Methods

Method

Description

Activation by

1

Account Number & Date of Birth

Program manager / customer support

2

Account Number & Access Code

Customer

3

Login ID & Access Code

Customer

4

Login ID & Date of birth

Customer

 Compliance Check Decision

Code

Description

OK

Compliance check hit.

KO

No compliance check hit.

 Device Type

Code

Description

1

Android

2

iOS

 Document Type

Code

Description

b2bInvoice

B2B Invoice

b2bMemo

B2B Memo

credit note

Credit Note

dunning

Dunning

dunning1

Dunning 1

dunning2

Dunning 2

invoice

Invoice

invoice_cumulated

Invoice Cumulated

memo

Credit Memo

settled

Settled

ticket

Payment Ticket

 Gender

Code

Description

FEMALE

Female

MALE

Male

 Limit Category Code

Code

Description

1

General

2

General Unverified

3

Payment Option Specific

4

Payment Option Specific Unverified

 Notification Type

Code

Description

INFO

Information

SUCCESS

Success

WARNING

Warning

ERROR

Error

 Payment Group

Code

Description

BANKS

Banks

CARDS

Cards

ALTPMNT

Alternative Payments

 Payment Option Status

Title code

Description

INVERIFCTN

In Verification

VERIFIED

Verified

UNVERIFIED

Unverified

 Payment Subgroup

Code

Description

CRDTCRD

Credit Cards

DBITCRD

Debit Cards

EWALLET

E-Wallets

SEPA

SEPA

RTBNKTRSFR

Real Time Bank Transfers

 Period Code

Code

Description

1

Daily

2

Weekly

3

Monthly

4

Quarterly

5

Biannually

6

Yearly

7

Lifetime

8

Single

 Response Codes

CodeDescription
 General Response Codes
0000Successful execution.
0001One or more of the required fields have not been sent or some fields were not in a correct format: { list of all required or incorrect fields }.
0002Invalid '{parameter name}' supplied.
0003'amount' should be greater than 0.00.
0004The program does not have configured program payment provider settings for the used payment option.
0005Invalid program code: {the program code}.
0006External payment provider failed to process the operation.
0007'{parameter name}' must not be empty.
0008Invalid account number supplied: {account number}.
0011Invalid status supplied in '{parameter name}'.
0012'{parameter name}' is already in use for the program.
0013'{parameter name}' is already in use for the portal.
0014'mandateReference', 'mandateSignedDate' and 'mandateSignedTime' are required for payment option "Bank Account SEPA".
0015Payment status is different from 'Authorized'.
0017Corresponding account type is inactive.
0018Unknown user.
0019User is inactive.
0020User is locked.
0021Unknown 'transactionTypeCode'.
0022Unknown 'paymentOptionCode'.
0023Unknown currency code.
0024'mandateReference', 'mandateSignedDate' and 'mandateSignedTime' must be empty for payment options different from "Bank Account SEPA".
0026Maximum value of the '{limit name}' limit is exceeded.
0027Invalid country code supplied in: '{parameter name}'.
0028Country supplied in the 'countryCode' is not supported.
0029Specified 'programAccno' is not a program account.
0030Invalid 'fileId'.
0031Specified '{parameter name}' is not an e-wallet user account.
0032Unknown 'paymentGroupCode'.
0033Unknown 'paymentSubGroupCode'.
0034'{parameter name}' is already in use for the account.
0035Payment status is different from 'Received'.
0036Current account application status does not allow file uploading or deleting.
0037Specified '{parameter name}' is not a merchant account.
0038Digital signature of the payment provider response is incorrect.
0039The file size must be less than or equal to 10 MB.
0040Program account has insufficient funds: {program account number}.
0041User password is expired.
0043Using of the stored payment option is denied, because it is in the "Pending" status.
0044'{Parameter Name}' array contains duplicated items.
0045Using of the stored payment option is denied, because it is in the "Pending" or "Blocked" status.
0046If 'useDifferentBillingAddress' is true, 'customerFullName', 'addr1', 'city', 'countryCode', 'postCode' must be provided.
0047Database connection timeout.
0048Unknown '{parameter name}'.
0049Status of transaction specified by 'uniqueReference' is different from "Authorized".
0050Transaction specified by 'uniqueReference' has already got a dependent transaction of transaction type category "Load Account".
0051Minimum value of the '{limit name}' limit is exceeded.
0052Payer's account has insufficient funds: {account number}.
0055Failed to get order data from debtor management provider.
0056Payment status is different from 'Received', 'Authorized' or 'Capture in Progress'.
0057The file is empty.
0058Server is currently busy. Please try again.
0060Account is inactive: {account number}.
0061Merchant is inactive: {the name of corresponding Account Owner}.
0063Integration settings have not been set up: { compliance check settings | location check settings | risk check settings | vat id check settings | address autocompletion check settings | blacklist filter settings | debtor management settings}.
0064'X-Access-Token' is not a valid JWT Token.
0065User Agreement Text is not found by specified 'userAgreementReference'.
0066Value must be > 0: '{parameter name}'.
0067Specified merchant account has a currency different from the specified '{parameter name}'.
0068The operation is denied for this user: not enabled through API Authorization Sets.
0069The operation is denied for this user: {system operation code}.
0070The uploaded file content does not match the file extension.
0071Provided stored payment option has exceeded its validity period.
0073Account's maximum balance would be exceeded as a result of this transaction: {account number}.
0074Specified 'programAccno' has a currency different from the transaction currency.
0075Specified 'accno' has a currency different from the transaction currency.
0077Failed to convert currency.
0078Corresponding payment option is inactive for: {account number}.
0079Corresponding transaction type is inactive for: {account number}.
0080Account is expired: {account number}.
0081The file name length must be less than or equal to 255 characters.
0082Merchant account has insufficient funds: {merchant account number}.
0083Specified 'accno' is neither an e-wallet user account nor merchant account.
0084Specified 'accno' is an e-wallet user but the provided stored payment option is not associated to him/her.
0085For the country "{Country name}" parameter '{parameter name}' is required.
0086Transaction settlement failed, transaction is created in the "Captured" status.
0087'{parameter name}' is specified, 'accnoType' must also be specified.
0088Incorrect file extension. Supported file extensions are jpg, jpeg, png, pdf, doc, docx.
0089Mandate reference must be unique for the program.
0090The provided value in '{parameter name}' is incorrect state name or code.
0091Transaction specified by '{parameter name}' must have transaction type category "Deposit".
0092Transaction specified by 'uniqueReference' must have transaction type category "Payment".
0095Specified stored payment option has an associated payment provider different from "PAY.ON", "PAY.ON with PCI Proxy", "CyberSource", "CyberSource with TokenEx", "PayPal", "SEPA", "Virtual Payment Provider" or "Vesta with TokenEx".
0096Authorization has been denied for this request.
0097Payload has an incorrect format.
0098Concurrency error occurred.
0099Unexpected server error occurred.
1431The specified {amount} does not satisfy the currency minor unit.
1432The specified {amount} is less than the currency minimum allowed value.
9001BIN check service failed to perform the operation.
9002The 'criteria' request parameter with name '{parameter name}' is not a valid fully-qualified https URL.
9005Only "EUR" can be used with provided "Bank Account SEPA" payment option.
9006Virtual payment provider is used, 'criteria' request parameter with the following name must be provided: '{parameter name}'.
9007A payment option of payment group "Cards" is used with Virtual payment provider, 'criteria' request parameters with names "bin", "last4digits", "expiryMonth" and "expiryYear" must be provided.
9008A payment option of payment group "Banks" is used with Virtual payment provider, 'criteria' request parameters with names "bankAccount" and "bankCode" must be provided.
9009Virtual payment provider is used, 'criteria' request parameter with name "carrierNumber" must be provided.
9010The 'criteria' request parameter with name "origin" is not a valid comma-separated list of fully qualified origins (only HTTPS scheme, domain name or IP address and optional ports are allowed for each origin, every URL in origin chain must not have a trailing slash).
9011A payment option of payment group "Cards" is used with Virtual payment provider in guest payment mode, 'criteria' request parameter with name "guestPaymentOptionToken" must be provided.
9012Duplicated 'name' field values of 'criteria' exist.
9013The payment option of payment group "Cards" used with Virtual payment provider must not be expired (the last day of the month and the year specified by 'criteria' request parameters with names "expiryMonth" and "expiryYear" must not be in the past).
9014For Third Party Provider's requests of this API method 'accno' must belong to an e-wallet user.
9015The requested URL resource does not support the provided HTTP request method.
9017Either '{the first parameter name}' or '{the second parameter name}' parameter must be provided.
9018A payment option of payment group "Cards" is used with Virtual payment provider, 'criteria' request parameter with name "storedPaymentOptionReference" must be provided.
9019Financial operations between CPSP and non-CPSP merchants are prohibited.
9020Financial operations between E-Wallet users and CPSP merchants are prohibited.
9998Request cancelled because of internal time-out.
9999Request cancelled or timed-out.
 'Create Account' and 'Update Account Information' Response Codes
0101'externalAccountReference' already in use.
0102'loginID' already in use.
0103Specified 'accountApplicationFlowCode' is not applicable for an E-Wallet User Account.
0104Cannot use an email address as 'loginID'.
0105The user has not achieved the minimum allowed age.
0106Unknown 'accountApplicationFlowCode'.
0107Specified 'accountApplicationFlowCode' is inactive.
0108Password does not comply to the password policy: '{password policy description}'.
0109Account currency specified by 'currCode' is not allowed for user boarding.
0110'externalAccountReference' must be specified.
0111'externalAccountReference' must not be specified.
0130Invalid '{parameter name}' value.
0131Invalid 'timeZone' value.
0132A business user field is provided to a non-business user.
0133On account {"creation"||"update"} the 'externalAccountReference' may not be empty string.
0134The combination of KYC fields is not unique for the program.
0135Unknown 'accTypeCode'.
0136Specified 'accTypeCode' is not allowed for accounts.
0137Specified 'accTypeCode' does not correspond to E-Wallet User Category.
0138Compliance Check failed, the Account cannot be created.
0139Account application in processing due to compliance check.
0140Specified 'accTypeCode' is not active.
0141Account has not been created/updated: debtor is not maintained.
0142Specified 'userAgreementReference' is not found for the Program.
0143Specified 'userAgreementReference' is expired or not valid yet.
0144User agreement text of the account is not valid.
0145User agreement text of the account owning the specified 'storedPaymentOptionReference' is not valid.
0146Account application in processing due to fraud monitoring.
0147The expiration date of the identity document must not be in the past.
 'Change Status' Response Codes
0120Account already in the desired status.
0121Cannot change status to "Closed" or "Rejected".
0122Cannot activate the user account, because the corresponding program account is inactive.
0123Cannot change status from "Closed" or "Rejected".
 'Account Enquiry', 'Pending Transactions Enquiry' and 'Dealer Funding Enquiry' Response Codes
0160'{parameter1 name}' is greater than '{parameter2 name}'.
 'Load Account' Response Codes
0179Transaction found by the specified 'uniqueReference' has a currency different from the load currency.
0180Account load limit exceeded.
0181'loadAmount' should be greater than 0.00.
0182Program load limit exceeded.
0183'loadAmount' value exceeds the 'presentationAmount' of the transaction found by the specified 'uniqueReference'.
0184Cannot add a "Load Account" transaction to a group containing a "Payment" transaction.
0185Transaction found by the specified 'uniqueReference' must have either a single dependent transaction having "Init Load Account" transaction type and "Capture In Progress" status or no dependent transaction having "Load Account" transaction type category.
0186Current deposit has adjusted Settled Amount, '{loadAmount | paymentAmount}' and '{loadCurrCode | paymentCurrCode}' should match the deposit presentation amount and presentation currency and only one "{Load Account|Payment}" transaction can be added.
0188'loadAmount' should be greater than 0.00 and less than or equal to initiated load amount.
0189Transaction found by the specified 'uniqueReference' is neither in captured status, nor in settled status.
 'Unload Account' Response Codes
0190Account unload limit is exceeded.
0191'unloadAmount' should be greater than 0.00.
0192Account has insufficient funds: {account number}.
0194Specified 'paymentOptionCode' is not available for unloading this account.
0195Program unload limit exceeded.
 'Init Authorize' Response Codes
0223Criteria item with name = "redirectUrl" must be provided and its value must not be empty.
0224Provided stored payment option must belong to payment group "Cards".
0225Specified stored payment option has an associated payment provider different from "PAY.ON", "PAY.ON with PCI Proxy" and "Virtual Payment Provider".
0226'storedPaymentOptionReference' and 'paymentOptionCode' parameters must match the same payment option.
0227SCA mode is disabled. 'storedPaymentOptionReference' must not be provided.
 'KC-Capture' and 'Capture' Response Codes
0230'modifiedAmount' should be greater than 0.00 and less than or equal to authorized amount.
0233Transaction found by the specified 'uniqueReference' has a currency different from the capture currency.
0234Transaction found by the specified 'uniqueReference' is a "KC-Block" transaction.
0235'modifiedAmount' should be equal to authorized amount if {"PaymentsOS" І "Prepayment"} payment provider is used.
 'KC-Cancel' and 'Cancel' Response Codes
0240Cancelling is not supported for the used payment option.
0241Cancellation period for the selected transaction has exceeded.
 'KC-Refund' and 'Refund' Response Codes
0250Payment status is different from 'Captured' or 'Settled'.
0251A refund, a chargeback or a reject was performed for the referenced transaction.
0252Transaction specified by 'uniqueReference' must have transaction type category "Load Account" or "Payment".
0253Account has insufficient funds: {account number}.
0254'refundAmount' must be greater than 0.00 and less than or equal to amount available for refund: {amount which is calculated according to certain description of the validation}.
0256Refund is not supported for the used payment option.
0257Transaction found by the specified 'uniqueReference' has a dependent transaction of transaction type "KC-Block" and status "Authorized" or "Received".
0258Transaction specified by the 'uniqueReference' is not refundable.
0852Transaction specified by the 'uniqueReference' was created more than {"Transaction Policy"-> "Refund Period In Days"} days ago.
0853'refundAmount' should complete already refunded amounts to the full amount available for refund.
0855Transaction found by specified 'uniqueReference' is performed with "SofortÜberweisung" or "IDEAL" payment option, a valid IBAN is not available.
0856Transaction found by specified 'uniqueReference' is performed with "SofortÜberweisung" or "IDEAL" payment option, active payment provider settings of type "SEPA" are not available.
0857Transaction found by the specified 'uniqueReference' has a related order.
0858A transaction specified by 'uniqueReference' is linked to a {"B2B Dealer Order"||"B2C Voucher Order"}, operation is denied.
0859Only Single Transaction Refund can be applied for the specified transaction.
0860Only Full Chain Refund can be applied for the specified transaction.
0861Only Partial Chain Refund or Full Chain Refund can be applied for the specified transaction.
0862'refundSourceAccno' must be provided.
0863'refundSourceAccno' must be a target account of dependent "Load Account" and if it does not exist: target account of dependent "Payment".
0865Amount of the refunding transaction must be equal to Amount of the refunded transaction.
0866Only Single Transaction Refund or Full Chain Refund can be applied for the specified transaction.
0867Amounts of "Deposit" and "Load Account" transactions are not equal, only Full Chain Refund for the full amount can be applied for the specified transaction.
0869'refundSourceAccno' must not be provided.
0870{ "Dependent external transaction of transaction found by provided 'uniqueReference' " | "Transaction found by provided 'uniqueReference' "} is performed via payment provider "Prepayment" and has status different from "Settled". It cannot be refunded.
 'Find User Account' Response Codes
0260Specified user does not have an account in the specified program.
 'Get Applicable Limits' and 'Check Limits' Response Codes
0320Unsupported combination of input parameters is used. Please use one of the following: 1. 'transactionTypeCode' and 'paymentOptionCode' and 'storedPaymentOptionReference' are not provided; 2. 'transactionTypeCode' and 'paymentOptionCode' are provided; 3. 'transactionTypeCode' and 'storedPaymentOptionReference' are provided; 4. 'transactionTypeCode' is provided.
0321Either 'paymentOptionCode' or 'storedPaymentOptionReference' or none of them must be specified.
0322'isVerified' is required, if 'paymentOptionCode' is provided.
 'Authorize' and 'Pay to Account' Response Codes
0361If 'accno' is not specified 'emailAddress' must be passed with "{currently used payment provider}" payment provider.
0362Compliance Check hit, transaction cannot be processed.
0363'presentationAmount' should be greater than 0.00.
0366Actual billing address must be passed for PayPal tracking, if 'accno' is a merchant account.
0367Actual payer's billing address must be passed, if a payment is done to a merchant via PayPal.
0368'emailAddress' must be passed, if a payment is done via "PayPal" and 'accno' is not specified or belongs to a merchant.
0369If 'accno' is not provided, 'useDifferentBillingAddress' must be true.
0370The provided stored payment option is not associated with the provided 'accno'.
0401Account owning the specified 'storedPaymentOptionReference' is not active.
 'Get Countries' Response Codes
0410'programCode' is provided, 'onlyProgramCountries' must also be provided.
 'Complete Authorize', 'KC-Authorize' and 'KC-Debit Account' Response Codes
0220'paymentAmount' should be greater than 0.00.
0475"{currently used payment provider}" payment provider is used, the 'criteria' request parameter with name "paymentProviderResponse" or "isStatusRequest" must be provided.
0476"{currently used payment provider}" payment provider is used and no stored payment option is defined, the 'criteria' request parameter with name "paymentProviderResponse" or "isStatusRequest" must be provided.
0477Provided 'paymentProviderResponse' does not match the provided 'authorizationToken'.
0478Virtual payment provider is used, 'criteria' request parameter with name "paymentOptionCode" must be provided.
0479Current deposit is performed via Prepayment and already has a dependent Payment transaction.
0480Invalid 'authorizationToken'.
0481"PayerID" must be provided under 'criteria' request parameter, if PayPal payment provider is used.
0482Transaction is pending on payment provider.
0483Pooling is not enabled for the account specified by 'accno'.
0484'programAccno' doesn't match the Account of the transaction found by {'uniqueReference' | 'depositReference'}.
0485The 'accno' is not specified, 'emailAddress' is required.
0486Neither 'accno' nor 'depositReference' are provided.
0487Payee is undefined when the add money beneficiary exists.
0488Status of transaction specified by 'depositReference' is different from "Captured" or "Settled".
0489Transaction found by the specified 'depositReference' already has a dependent transaction having "Payment" transaction type category.
0490Payee differs from the add money beneficiary.
0491Unsupported 'paymentBrand' in payment provider response.
0493{'merchantAccno' || 'accno'} is specified as External Account Reference, the {'merchantProgramCode' || 'programCode'} is required.
0494Payment option was not defined for "Init Authorize". Payment option received from the payment provider must belong to payment group "Cards".
0495Storing a payment option was selected by the user during payment data input. This is forbidden for merchant accounts.
0496Payment option returned by the payment provider does not match the payment option specified in the {"Init Authorize" || "Init Add Stored Payment Option"} request.
0497The specified 'accno' must have an unexpired default stored payment option.
0498The sum of amounts of all dependent payment transactions exceeds the amount of the transaction found by the specified 'depositReference'.
0499'paymentAmount' should be equal to the authorized amount if the transaction found by the specified 'uniqueReference' has a related order.
0500For Third Party Provider's requests of this API method 'accno' must belong to an e-wallet user and 'depositReference' must not be provided.
 'Issue Token' Response Codes
0018The user with the specified 'userId' and 'password' must exist for the WebAPI Portal and must not be locked.
0019The user with the specified 'userId' must be active.
0041The password of the user with the specified 'userId' must not be expired.
 2FA Response Codes
0550The user has "{the user 2FA status}" 2FA status which is not supported. Supported statuses: {the list of comma-separated 2FA statuses (each of them in quotes)}.
0551The user Portal does not support Two-Factor Authentication.
0552The One-Time Password request is blocked due to too many requests.
0553The repeated One-Time Password request is blocked due to too many requests.
0554The Mobile Phone, required to configure 2FA, is not specified for the user or is not valid.
0555The configuration of 2FA has not been completed.
0556Confirmation with 2FA is required. 'oneTimePassword' must be provided (use the value sent to the user via SMS).
0557'oneTimePassword' parameter must be a {"Digits" parameter from current version of 2FA KC Algorithm}-digit number.
0558'oneTimePassword' is incorrect.
0559An incorrect 'oneTimePassword' is provided for {" Max Unsuccessful 2FA Attempts" setting value} times. Corresponding user has been locked.
0560Confirmation with a verification code is required. 'twoFASetupCode' must be provided (use the value sent to the user email address).
0561'twoFASetupCode' is incorrect.
0562An incorrect 'twoFASetupCode' is provided for {" Max Unsuccessful 2FA Attempts" setting value} times. Corresponding user has been locked.
0563The verification code which has been sent to the user email address is expired.
0564The one-time password which has been sent to the user via SMS is expired.
0571An error occurred during external call to SMS provider.
0572An error occurred while sending an SMS by an external provider.
0573The phone number provided as '{parameter name}' request parameter is not valid.
 'Add Stored Payment Option', 'Init Add Stored Payment Option', 'Complete Add Stored Payment Option' and 'Delete Stored Payment Option' Response Codes
0620'paymentOptionCode' is not storable.
0621Specified 'paymentProvider' is not applicable for an E-Wallet User Account.
0623An error occurred while registering a payment option with an external provider.
0625The 'criteria' request parameter with name "callbackURL" is required with "{currently used payment provider}" payment provider
0626"returnURL" and "cancelURL" must be provided under 'criteria' request parameter, if PayPal payment provider is used.
0628Pooled transactions exist for the specified account, a default stored payment option cannot be deleted.
0630If different billing address is used 'emailAddress' must be passed with "{Payment Provider Name}" payment provider.
0631The specified 'storedPaymentOptionReference' is used for payout in the deferred account closing and cannot be deleted.
0632The 'criteria' request parameter with 'name'="paymentProviderResponse" is required with "{currently used payment provider}" payment provider.
0633'paymentOptionCode' must refer to payment group "Banks" or "Cards" or payment option "PayPal" or payment option "Klarna".
0634Another account has stored payment option with the same reference and currently used payment provider.
0635Only "EUR" can be used as currency with provided "{currently used payment provider}" payment provider.
0636Payment option with the same 'storedPaymentOptionReference' has already been added to the account: {accno}.
0638Virtual payment provider is used, 'paymentOptionCode' is required.
0639"{currently used payment provider}" payment provider is used and 'criteria' request parameter with name "isStatusRequest" is not provided, the 'criteria' request parameter with name "redirectUrl" must be provided.
0640Invalid payment provider type.
0642"{currently used payment provider}" payment provider is used and 'criteria' request parameter with name "isStatusRequest" is provided, the 'criteria' request parameters with names "panToken" and "initiatedTransactionReference" must be provided.
0644No stored payment option is found by the provided 'authorizationToken'.
0645Status of the stored payment option found by the provided 'authorizationToken' is not "Pending".
0691'bankCode' parameter is not provided.
 'Init Verify Stored Payment Option' and 'Complete Verify Stored Payment Option' Response Codes
0660'storedPaymentOptionReference' is not verifiable.
0661'storedPaymentOptionReference' is not in "Unverified" status.
0662Verification code is incorrect.
0663Verification code is incorrect. And the amount of allowed verification attempts is exceeded. Stored payment option returns to the Unverified status.
0665Specified card is expired.
0666The specified 'accno' and 'programAccno' have different currencies.
0669'storedPaymentOptionReference' is not in "In Verification" status.
 'Close Account' Related Response Codes
0830Account application is in an incorrect status for a transition to the 'Closed' status.
0831There is no balance to be paid out to the specified stored payment option.
0832The specified 'accno' cannot be closed, because it is already scheduled for closing.
0833'storedPaymentOptionReference' parameter is required to perform payout when closing the account, if available balance of this account is greater than 0.
0834The owner of the account corresponding to the provided 'accno' already has a request to delete the sensitive data.
 'Get SEPA Mandate' Related Response Codes
0950A SEPA mandate can be only downloaded for the "Bank Account SEPA" payment options.
0951Mandate data is not available for the specified stored payment option.
 'Perform Person Compliance Check', 'Perform Company Compliance Check', 'Perform Person Risk Check' and 'Perform Company Risk Check' Response Codes
1090Compliance provider failed to perform the operation.
1091KontoCloud payment option code cannot be mapped to the provider payment option code.
1092Risk Check provider failed to perform the operation.
1094The request must contain either 'storedPaymentOptionReference' or 'useDifferentBillingAddress' = true, 'customerFullName', 'addr1', 'city', 'postCode' and 'countryCode' or both.
 'Perform Address Check' Response Codes
1130Address check provider failed to perform the operation.
 'VAT ID' Response Codes
1140VAT ID provider failed to perform the operation.
 'Perform Address Auto Completion' Response Codes
1210Address auto completion provider failed to perform the operation.
 'Perform Compliance Callback' Response Codes
1220Specified compliance results not found.
1221Specified 'archiveId' does not support manual review.
1222Specified compliance result corresponds to a closed or rejected account.
1223Manual Review Result cannot be set for inspected compliance check.
1224Manual Review Result is already defined for the compliance result found by specified 'archiveId'.
 'External Id'Response Codes
1250Specified Program's ID Provider not configured.
1251Provided UUID is already in use in the combination with the provided ID Provider in the specified Program.
1252Provided UUID not found for the provided 'accno' in the specified Program.
1253Only one UUID of the external ID Provider can be added for the user.
1254Last user's UUID cannot be deleted.
 'Get User Agreement Text' and 'Get Current User Agreement Text' Response Codes
1260Current user agreement version is not found.
1261Current user agreement text is not found.
1262Either 'userAgreementReference' or 'culture' must be specified.
 'KC-Block', 'KC-Unblock' Response Codes
1330If 'refundAmount' is true, the transaction defined by 'uniqueReference' must have a dependent deposit transaction.
1331Transaction found by the specified 'uniqueReference' is not a "KC-Block" transaction.
1332Transaction found by the specified 'depositReference' already has a dependent transaction of transaction type category "Payment".
1333Transaction found by 'depositReference' does not have associated stored payment option.
 Response Codes for headers validation
2010If the resolved program payment provider settings refers to "PaymentsOS" payment provider, 'X-Ip-Address' header must be specified.

 Sort Direction

Code

Description

ASC

Ascending

DESC

Descending

 Time Zone

Time zone id

Dateline Standard Time

UTC-11

Hawaiian Standard Time

Alaskan Standard Time

Pacific Standard Time

(Mexico) Pacific Standard Time

US Mountain Standard Time

Mountain Standard Time

(Mexico) Mountain Standard Time

Central America Standard Time

Central Standard Time

Central Standard Time

(Mexico) Canada Central Standard Time

SA Pacific Standard Time

Eastern Standard Time

US Eastern Standard Time

Venezuela Standard Time

Paraguay Standard Time

Atlantic Standard Time

Central Brazilian Standard Time

SA Western Standard Time

Pacific SA Standard Time

Newfoundland Standard Time

E. South America Standard Time

Argentina Standard Time

SA Eastern Standard Time

Greenland Standard Time

Montevideo Standard Time

Bahia Standard Time

UTC-02

Azores Standard Time

Cape Verde Standard

Morocco Standard Time

UTC

GMT Standard Time

Greenwich Standard Time

W. Europe Standard Time

Central Europe Standard Time

Romance Standard Time

Central European Standard Time

W. Central Africa Standard Time

Namibia Standard Time

Jordan Standard Time

GTB Standard Time

Middle East Standard Time

Egypt Standard Time

Syria Standard Time

South Africa Standard Time

FLE Standard Time

Turkey Standard Time

Israel Standard Time

Kaliningrad Standard Time

Libya Standard Time

Arabic Standard Time

Arab Standard Time

Belarus Standard Time

Russian Standard Time

E. Africa Standard Time

Iran Standard Time

Arabian Standard Time

Azerbaijan Standard Time

Russia Time

Zone 3 Mauritius Standard Time

Georgian Standard Time

Caucasus Standard Time

Afghanistan Standard Time

West Asia Standard Time

Ekaterinburg Standard Time

Pakistan Standard Time

India Standard Time

Sri Lanka Standard Time

Nepal Standard Time

Central Asia Standard Time

Bangladesh Standard Time

N. Central Asia Standard Time

Myanmar Standard Time

SE Asia Standard Time

North Asia Standard Time

China Standard Time

North Asia East Standard Time

Singapore Standard Time

W. Australia Standard Time

Taipei Standard Time

Ulaanbaatar Standard Time

Tokyo Standard Time

Korea Standard Time

Yakutsk Standard Time

Cen. Australia Standard Time

AUS Central Standard Time

E. Australia Standard Time

AUS Eastern Standard Time

West Pacific Standard Time

Tasmania Standard Time

Magadan Standard Time

Vladivostok Standard Time

Russia Time

Zone 10

Central Pacific Standard Time

Russia Time

Zone 11

New Zealand Standard Time

UTC+12

Fiji Standard Time

Tonga Standard Time

Samoa Standard Time

Line Islands Standard Time

W. Australia Standard Time

Taipei Standard Time

Ulaanbaatar Standard Time

Tokyo Standard Time

Korea Standard Time

Yakutsk Standard Time

Cen. Australia Standard Time

AUS Central Standard Time

E. Australia Standard Time

AUS Eastern Standard Time

West Pacific Standard Time

Tasmania Standard Time

Magadan Standard Time

Vladivostok Standard Time

Russia Time

Zone 10

Central Pacific Standard Time

Russia Time

Zone 11

New Zealand Standard Time

UTC+12

Fiji Standard Time

Tonga Standard Time

Samoa Standard Time

Line Islands Standard Time

 Title

Title code

Description

0

Undefined (Cannot be submitted via API request, will be returned if an Account has been deleted.)

1

Mr

2

Mrs

3

Ms

 Transaction Status

Code

Description

AUTHORIZED

Authorized

CANCELLED

Cancelled

CAPINPROGR

Capture In Progress

CAPTURED

Captured

EXPIRED

Expired

RECEIVED

Received

SETTLED

Settled

 Transaction Type

Code

Description

2FACHECK

2FA One Time Password Check

2FARESET

2FA Reset

ACCTENQ

Account Enquiry

ADDACCEET

Add Account EET Certificate

ADDSTPMTOP

Add Stored Payment Option

AJTBAL

Adjust Balance

AUTHUSR

Authenticate User

AUTH

Authorize

BALENQ

Balance Enquiry

CARDDETOK

Card Detokenize

CHGSTS

Change Status

CHKAVAMNT

Check Available Payment Amount

CHKLIM

Check Limits

CHKUSRUNQ

Check User Uniqueness

CHRGBCK

Chargeback

CLOSEACCT

Close Account

CNCL

Cancel

CNSTADD

Add Consent

CNSTGETLST

Get Consent List

CNSTRVK

Revoke Consent

COMPASPO

Complete Add Stored Payment Option

COMPAUTH

Complete Authorize

COMPVSPO

Complete Verify Stored Payment Option

CPTR

Capture

CRTACCT

Create Account

CRTACCEXID

Create Account External Id

CRTMRCH

Create Merchant

CRPPPS

Create Program Payment Provider Setting

CRTSDEMAIL

Create Secondary Email

CRTORDR

Create Order

DBACCT

Debit Account

DELACCEET

Delete Account EET Certificate

DELACCEXID

Delete Account External Id

DELAPPDOCF

Delete Application Document File

DELSDEMAIL

Delete Secondary Email

DELSPO

Delete Stored Payment Option

EDTSDEMAIL

Edit Secondary Email

EXPORTORDR

Export Orders

EXPRTRN

Expire Transaction

FNDUSRACCT

Find User Account

GETACCEXID

Get Account External Ids

GETACCTINF

Get Account Information

GETACCTSTT

Get Account State

GETAPPDOCS

Get Application Documents

GETAPPDOCF

Get Application Document File

GETAPPLLIM

Get Applicable Limits

GETCNTRS

Get Countries

GETCRNCS

Get Currencies

GETCSPPMTO

Get Country Specific Payment Options

GETDBRIV

Get Debtor Invoice

GETFIDATA

Get Financial Institution Data

GETNTFTN

Get Notifications

GETORDRINF

Get Order Information

GETPSTPMTO

Get Portable Stored Payment Options

GETPMST

Get Payment Status

GETPMTOPTS

Get Payment Options

GETPRGACTS

Get Program Accounts

GETSDEMAIL

Get Secondary Emails

GETSEPAMDT

Get SEPA Mandate

GETSTPMTOP

Get Stored Payment Options

GETTRNRFRN

Get Transaction References

GETTFRRCPT

Get Transfer Recipients

GETUAGRT

Get User Agreement Text

GETUSERINF

Get User Information

GETUSRPD

Get User Personal Data

INITASPO

Init Add Stored Payment Option

INITAUTH

Init Authorize

INITLDACCT

Init Load Account

INITVSPO

Init Verify Stored Payment Option

ISSOATOKEN

Issue Oauth Token

ISSUETOKEN

Issue Token

KC-AUTH

KC-Authorize

KC-BLOCK

KC-Block

KC-CHRGBCK

KC-Chargeback

KC-CNCL

KC-Cancel

KC-CPTR

KC-Capture

KC-DBACCT

KC-Debit Account

KC-MCRAUTH

KC-MicroAuthorize

KC-RFND

KC-Refund

KC-RJCT

KC-Reject

KC-UNBLOCK

KC-Unblock

LDACCT

Load Account

LOGOUTUSR

Logout User

LSTACCEET

List Account EET Certificates

MTNDBRBSTR

Maintain Debtor Business Transaction

MTNDBRMRDT

Maintain Debtor Master Data

OBFCARNUM

Obfuscate Carrier Number

PTACCT

Pay to Account

PING

Ping

PNDTRNSENQ

Pending Transactions Enquiry

PFMADDRAC

Perform Address Auto Completion

PFMADDRCHK

Perform Address Check

PFMANEXTCB

Perform AriadNEXT Callback

PFMCCMCHK

Perform Company Compliance Check

PFMCRSKCHK

Perform Company Risk Check

PFMCMCB

Perfrom Compliance Callback

PFMDBRBLCB

Perform Debtor Billing Callback

PFMDBRERCB

Perform Debtor Error Callback

PFMDBRIVCB

Perform Debtor Invoice Callback

PFMIDNOWCB

Perform IDnow Callback

PFMPCMCHK

Perform Person Compliance Check

PFMPOSCB

Perform PaymentsOS Callback

PFMPRSKCHK

Perform Person Risk Check

PFMVATCHK

Perform VATID Check

PRCPMT

Process Payment

REGACCTDVC

Register Account Device

REPORTEET

Report EET

RFND

Refund

RJCT

Reject

SETDFLTSPO

Set Default Stored Payment Option

SETMNEMAIL

Set Main Email

STTLTRN

Settle Transaction

TFRAMNT

Transfer Amount

TUNNELCB

Tunneling Callback

ULDACCT

Unload Account

URGACCTDVC

Unregister Account Device

UPDACCTINF

Update Account Information

UPDDBRBSTR

Update Debtor Business Transaction Status

UPDORDRACT

Update Order Activation

UPGRDACCT

Upgrade Account

UPLAPPDOCF

Upload Application Document File

VRFYTFRRPT

Verify Transfer Recipient

VLDTIBAN

Validate IBAN

 Unit Code

Code

Description

1

Total Transaction

2

Total Value

 Format Type

Code

Description

JSON

JSON format of the agreement

PDF

PDF format of the agreement

 Two Factor Authentication Status

Status code

Description

2FADIS

Two Factor Authentication is disabled.

2FANOTCONF

Two Factor Authentication is activated but not configured.

2FAINPROC

Two Factor Authentication is activated and configuration is in process.

2FACONF

Two Factor Authentication is activated and configured.

 Refund Type

Code

Description

0

Only the single specified transaction will be refunded.

1

Full Chain of related transactions will be refunded.

2

Partial Chain refund. Only two transactions will be refunded: external transaction and related internal transaction.

 Payment Option Code

Code

Description

AMEX

American Express

APPLPAY

Apple Pay

BNKACCT

Bank Account

CRTBANCAIR

Carte Bancaire

DISCOVER

Discover

GGLPAY

Google Pay

GIROPAY

GiroPay

IDEAL

IDEAL

JCB

JCB

KLARNA

Klarna

MSTRCRD

Mastercard

MSTRO

Maestro

PAYPAL

PayPal

PAYU

PayU Pay-by-Link

PAYUBLK

BLIK

PAYUTWST

TWISTO Pay Later

PAYUINST

PayU Installments

PREPMNT

Prepayment

VISA

VISA

VISADBIT

VISA Debit

VISAELTRN

VISA Electron

 Debtor Management Errors

Debtor Management Errors, delivered via "Debtor Error Callback" Notifications, if Enabled.

Note: Only Errors with Type "E" for "Error" would require an action (retry, ask support, etc).

TypeDescription
EError
WWarning
IInfo

 MASTERDATA Errors

CodeTypeDescription
0001EExternal Error: Company Code is not implemented
0002IFill log table
0003Ithe external Customer: & is in mode: & test flag: &
0004EError generation UUID
0005ENo customizing set was found! / KSI / CN_WEB_C maintain!
0006IThe customizing set: & is used.
0007WCustomizing in table & is missing.
0008IThe incoming company code & was converted to &
0009ICustomizing for table & is processed
0010Irecurring customer recursively and storing values that are enriched with customizing.
0011Icompany code &1 was delivered by the caller
0012Ivalue &1 for the field &2 comes from the customizing
0013Icomparative value &1 was found and replaced by the customizing value &1
0014Ifor the field &1 the user exit &2 will processed
0015IBAPI call
0016ESynchronization customer -> business partner is not active
0017EEnter an existing customer
0018ECustomer &1 don’t exist! Enter an existing customer number!
0019WCustomer &1 is already assigned to business partner &2
0020IBusiness partner &1 has been assigned to customer &2
0021ECustomer &1 cannot be assigned to a business partner
0022ENo business partner could be created for customer &1
0023IThe changes were called via the SourceType: &
0024E'Customer is not filled - Business partner can not be modified.'
0025IUpdate --> mapping debtor &1 to existing business partner
0026EError mapping existing business partner
0027IMapping succeeded, try saving business partners
0028ITest run has ended!
0029E*** ERROR *** The customer could not be created / modified *** ERROR
0029EPlease enter the customers language in the KVERM field - 0039 ; *** ERROR *** The customer could not be created / modified *** ERROR *** - 0029 ;
0029EDer Geschäftspartner XXX ist zur Zeit von Ihnen gesperrt - 9999 ; *** ERROR *** The customer could not be created / modified *** ERROR *** - 0029 ;
0029EDas Konto XXX wird zur Zeit vom Benutzer YYY bearbeitet. - 9999 ; *** ERROR *** The customer could not be created / modified *** ERROR *** - 0029 ;
0029ESteuernummerntyp XXX ist nicht vorhanden - 9999 ; *** ERROR *** The customer could not be created / modified *** ERROR *** - 0029 ;
0029EBei interner Nummernvergabe darf keine Debitorennummer übergeben werden - 9999 ; *** ERROR *** The customer could not be created / modified *** ERROR *** - 0029 ;
0029ECustomer number range is not valid - 0034 ; *** ERROR *** The customer could not be created / modified *** ERROR *** - 0029 ;
0029EEintrag XXXX YYYY nicht vorhanden in SKB1 (Überprüfen Sie die Eingabe) - 9999 ; SKB1-AKONT: Ungültiger Wert(Fremdschlüsselprüfung fehlgeschlagen) - 9999 ; Sachkonto YYYY im Buchungskreis XXXX ist nicht vorhanden - 9999 ; KNB1-AKONT: Plausibilätsprüfung ist fehlgeschlagen - 9999 ; *** ERROR *** The customer could not be created / modified *** ERROR *** - 0029 ;
0029EFür Land XX ist die Region YY nicht definiert - 9999 ; *** ERROR *** The customer could not be created / modified *** ERROR *** - 0029 ;
0029EGeben Sie eine Identifikationsart oder einen Identifikationstyp an - 9999 ; *** ERROR *** The customer could not be created / modified *** ERROR *** - 0029 ;
0029EPostleitzahl ##### darf an Stelle 1 bis 5 nur Ziffern enthalten - 9999 ; *** ERROR *** The customer could not be created / modified *** ERROR *** - 0029 ;
0029EPostleitzahl 0000 muss die Länge 5 oder 10 haben - 9999 ; *** ERROR *** The customer could not be created / modified *** ERROR *** - 0029 ;
0029ETax code 2  ist länger als 11 Zeichen - 9999 ; *** ERROR *** The customer could not be created / modified *** ERROR *** - 0029 ;
0032ENo name was entered for the transferred customer
0033IThe user exit &1 will processed
0034ECustomer number range is not valid
0035EData inconsistency between KNA1, BUT000 and /KSI/CN_T_MAPDEB
0036EField Kunnr max. 10 digits
0037Ecustomer number was not given
0038EBank number and bank account number cannot be generated
0039EPlease enter the customer's language in the KVERM field
0040EThe given language key &1 does not exist
9999EError: Others

 ORDER / REFUND Errors

CodeTypeDescription
0000EExternal Error: wrong / missing Source Type
0001EExternal Error: Sales Organization missing
0002EExternal Error: Sales Organization not found
0003EExternal Error: Company Code not found
0004EExternal Error: Posting Period is already closed
0005EExternal Error: Customer ID missing
0006EExternal Error: SAP Customer not found
0007EInternal Error: Order Creation (BAPI)
0008EInternal Error: Invoice Creation (BAPI)
0009EInternal Error: FI DOC Posting (BAPI)
0010EError: Others
0011EInternal Error: Interface Customizing not Found
0012EExternal Error: wrong / missing Document Type
0013EExternal Error: Billing Date Missing
0014EExternal Error: Non-tax condition total amount cannot be 0,00
0015EExternal Error: Postal Code (additional address)
9000EExternal Error: Tax Error
9000EExternal Error: Tax Rate (SeqNr) and the corresponding MWST Condition Amount (CondValue) do not match
9001EExternal Error: Wrong Tax Percentage
9002EExternal Error: VIN Missing
9003EExternal Error: Model Code Missing
9004EExternal Error: reference Sales Organization missing (B2B)
9005EExternal Error: Discount Percentage missing
9007EExternal Error: Standing Order / Period of Time missing
9008EInternal Error: Tax Customizing Missing
9009EExternal Error: for Tax SeqNr 0%, condition amount 0,00 expected
9009EExternal Error: Voucher Code missing!
9010EExternal Error: Position Text Missing
9011EInternal Error: FI Posting Error
9012EInternal Error: FI follow-up Postings save failure
9013EExternal Error: No Country found (Field KVERM)
9014EExternal Error: corresponding B2C Invoice missing (for B2B Invoice)
9015EExternal Error: corresponding B2C Invoice missing (for B2C Credit Memo)
9016EExternal Error: corresponding B2B Credit Memo missing (for B2C Credit Memo)
9017EExternal Error: corresponding B2B Invoice missing (for B2B Credit Memo)
9018EExternal Error: EEA Company Tax Error
9019EExternal Error: for Tax SeqNr 0%, condition amount not equal 0,00 expected
9020EExternal Error: Tax Error (Credit Memo tax rate must be equal to the tax rate in the corresponding invoice) 
9999EError: Others

 PAYMENTS Errors

CodeTypeDescription
0001EExternal Error: Company Code &1 is not implemented
0002EDuplicate key! PAYID: & ORDERID: & PROVID: &
0003EExternal Error: Not existing debtor
0004EExternal Error: Not existing OrderID
0005IThe incoming timestamp: & was successfully converted to: &.
0006EConversion of the incoming timestamp: & failed
0007EOne of the values is missing: PAYID: & ORDERID: & PROVID: &
0008IPayment information successfully created!
0009EAn unexpected error occurred while saving.
0010EExternal customer number is missing
0011EThere is no internal to the external customer number.
0012EPayment method '&1' or payment provider '&2' is not in customizing.
0013EPayment UUID could not be determined

 DOC IDs Errors

CodeTypeDescription
0001EExternal Error: Sales Organization missing
0002EExternal Error: Sales Organization not found
0003EExternal Error: FI Document ID missing
0004EInternal Error: Archive Record ID not found