We recommend setting a minimum timeout of 90 seconds, even though API requests are expected to return a response much faster
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.
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.
Although caching of the authentication token can improve performance it is important to check for potential caching related rejections of requests. This may result from expired tokens being served from your cache for requests, particularly during initial sprints focused on integration.
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
Caller user identifier in the KontoCloud system.
password
Caller password in the KontoCloud system.
localDate
The current date of the caller.
localTime
The current time of the caller.
Response parameters
token
Security token.
validUntil
Token validity period in UTC.
localDate
The current date of the caller.
localTime
The current time of the caller.
sysDate
The current date of the KontoCloud server
sysTime
The current time of the KontoCloud server
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"
}
}
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"
}
}
put {baseURL}/account
This method is used to create an e-wallet account.
Request parameters
externalAccountReference
Account reference to identify the account in the future by the partners in their system.
partnerReference
Partner service call identifier.
programCode
Program code
accountApplicationFlowCode
Code of the account application flow. A program default flow of Type "E-Wallet User" is used if a value is not provided.
currCode
Currency code of the account to be opened.
validFrom
Start date of the account.
loginID
Login ID of the customer using the service.
lastName
Customer's last name.
firstName
Customer's first name.
culture
User culture, based on RFC 4646. For example, "de-DE".
addr1
Address line 1.
addr2
Address line 2.
addr3
Address line 3.
houseNumber
House number.
city
City name.
state
State name.
countryCode
Country ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code.
postCode
Postal code.
dob
Date of birth.
placeOfBirth
Place of birth.
landlinePhone
Landline phone number.
mobilePhone
Mobile phone number.
emailAddress
Email address for any notification.
useDifferentCorrespondenceAddress
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
Correspondence address line 1.
correspondenceAddr2
Correspondence address line 2.
correspondenceAddr3
Correspondence address line 3.
correspondenceHouseNumber
Correspondence house number.
correspondenceCity
Correspondence city name.
correspondenceState
Correspondence state name.
correspondenceCountryCode
Correspondence country ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code.
correspondencePostCode
Correspondence postal code.
occupation
A job or profession.
nationality
The ISO2 or ISO3 code of a country a new user is a national of.
taxId
Tax identification number.
identificationDocumentType
Type of the new user's identification document e.g. passport.
identityNumber
Identification document number.
documentIssuingCountryCode
The ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code of a country that issued the identification document.
dateOfExpiry
Expiry date of the identification document.
sourceOfWealth
The activity which generated the new user's total net worth.
sourceOfFunds
The main activity which generates the new user's funds for this ewallet.
isPep
Is the new user or his/her family member a politically exposed person.
isBusinessUser
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
Company legal name.
businessCompanyType
Company legal type.
businessCompanyRegistrationNumber
Company registration number.
businessCompanyRegistrationCountryCode
Company registration country ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code.
businessAddr1
Company address line 1.
businessAddr2
Company address line 2.
businessAddr3
Company address line 3.
businessHouseNumber
Company house number.
businessCity
Company city name.
businessPostCode
Company post code.
businessState
Company state name.
businessCountryCode
Company country ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code.
businessUrl
Company website URL.
debtorData
Debtor Data parameters.
additionalData
Collection of additional data.
name
Name.
value
Value.
classification
classification.
salesOutlet
Shop id.
contactOther
Legal E-mail address (required for Italy)
gender
Customer's gender
language
Language.
registration
Tax number information.
registrationID
Registration ID.
registrationType
Registration type.
PIT-3 - possible values:
- "EU_VAT_NUMBER" for European companies;
- "NO_PERSON_ID" for private perosns (in some contries);
- "VAT_NUMBER" for European Economic Area companies.
riskStatus
Risk status.
salutation
Customer's salutation.
userAgreementReference
Reference to the user agreement text.
localDate
The current date of the caller.
localTime
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
Partner service call identifier.
programCode
Program code
productCode
Account product of the new account.
accTypeCode
Account type code of the account.
custCode
Customer identifier generated by KontoCloud.
externalAccountReference
Account reference to identify the account in the future by the partners in their system.
accno
Account number.
twoFAStatusCode
Two Factor Authentication Status Code. Refer to Two Factor Authentication Status Codes in the Lookups.
accFlowStatusCode
Status code of the account flow. See Account Flow Status Codes in the Lookups.
validFrom
Start date of the account.
validUntil
Expiry date of the account.
Deprecated and ignored field.
localDate
The current date of the caller.
localTime
The current time of the caller.
sysDate
The current date of the KontoCloud server
sysTime
The current time of the KontoCloud server
debtorManagementProviderResponse
Complete response of debtor management provider.
httpStatusCode
HTTP status code.
providerResponse
Response description.
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"
}
}
post {baseURL}/account/{accno}/updateInfo
Provides the ability to update an account holder's information.
Request parameters
accno
Account number.
externalAccountReference
Account reference to identify the account in the future by the partners in their system.
partnerReference
Partner service call identifier.
programCode
Program code
accTypeCode
Account type code of the account.
lastName
Customer's last name.
firstName
Customer's first name.
addr1
Address line 1.
addr2
Address line 2.
addr3
Address line 3.
houseNumber
House number.
city
City name.
postCode
Postal code.
state
State name.
countryCode
Country ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code.
dob
Date of birth.
landlinePhone
Landline phone number.
mobilePhone
Mobile phone number.
emailAddress
Email address for any notification.
nationality
The ISO2 or ISO3 code of a country a new user is a national of.
culture
User culture, based on RFC 4646. For example, "de-DE".
timeZone
User time zone id. For example, "Central European Standard Time". See Time Zone in the Lookups.
useDifferentCorrespondenceAddress
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
Correspondence address line 1.
correspondenceAddr2
Correspondence address line 2.
correspondenceAddr3
Correspondence address line 3.
correspondenceHouseNumber
Correspondence house number.
correspondenceCity
Correspondence city name.
correspondenceState
Correspondence state name.
correspondenceCountryCode
Correspondence country ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code.
correspondencePostCode
Correspondence postal code.
taxId
Tax identification number.
identificationDocumentType
Type of the new user's identification document e.g. passport.
identityNumber
Identification document number.
documentIssuingCountryCode
The ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code of a country that issued the identification document.
dateOfExpiry
Expiry date of the identification document.
notifyUser
Defines whether the account owner is notified of the account information change. Default value is false.
businessCompanyName
Company legal name.
businessCompanyType
Company legal type.
businessCompanyRegistrationNumber
Company registration number.
businessCompanyRegistrationCountryCode
Company registration country ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code.
businessAddr1
Company address line 1.
businessAddr2
Company address line 2.
businessAddr3
Company address line 3.
businessHouseNumber
Company house number.
businessCity
Company city name.
businessState
Company state name.
businessPostCode
Company post code.
businessCountryCode
Company country ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code.
businessUrl
Company website URL.
debtorData
Debtor Data parameters.
additionalData
Collection of additional data.
name
Name.
value
Value.
classification
classification.
salesOutlet
Shop id.
contactOther
Legal E-mail address (required for Italy)
gender
Customer's gender
language
Language.
registration
Tax number information.
registrationID
Registration ID.
registrationType
Registration type.
PIT-3 - possible values:
- "EU_VAT_NUMBER" for European companies;
- "NO_PERSON_ID" for private perosns (in some contries);
- "VAT_NUMBER" for European Economic Area companies.
riskStatus
Risk status.
salutation
Customer's salutation.
userAgreementReference
Reference to the user agreement text.
oneTimePassword
One Time Password used for confirmation during Two Factor Authentication.
localDate
The current date of the caller.
localTime
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
Partner service call identifier.
programCode
Program code
accno
Account number.
providerResponse
External provider data.
complianceData
Compliance data.
archiveId
Archived check result identifier.
details
List of compliance check details. Each array item contains a list of "name"->"value" pairs.
hitType
The following options are possible:
• "SL" – sanctions list,
• "BL" – black list,
• "PEP" – publicly exposed person.
manualReview
Whether a manual review is required or not.
trafficLight
The following options are possible:
• "RED" – hit,
• "YELLOW" – unsure hit,
• "GREEN" – no hit.
localDate
The current date of the caller.
localTime
The current time of the caller.
sysDate
The current date of the KontoCloud server
sysTime
The current time of the KontoCloud server
debtorManagementProviderResponse
Complete response of debtor management provider.
httpStatusCode
HTTP status code.
providerResponse
Response description.
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"
}
}
get {baseURL}/account/{accno}?partnerReference={partnerReference}&programCode={programCode}&accnoType={accnoType}&localDate={localDate}&localTime={localTime}
Returns the account holder information.
Request parameters
accno
Account number.
partnerReference
Partner service call identifier.
programCode
Program code
localDate
The current date of the caller.
localTime
The current time of the caller.
Response parameters
partnerReference
Partner service call identifier.
programCode
Program code
accno
Account number.
externalAccountReference
Account reference to identify the account in the future by the partners in their system.
merchantName
Merchant name.
lastName
Customer's last name.
firstName
Customer's first name.
addr1
Address line 1.
addr2
Address line 2.
addr3
Address line 3.
houseNumber
House number.
city
City name.
state
State name.
countryName
Country name.
countryCode
Country ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code.
postCode
Postal code.
dob
Date of birth.
landlinePhone
Landline phone number.
mobilePhone
Mobile phone number.
emailAddress
Email address for any notification.
loginID
Login ID of the customer using the service.
culture
User culture, based on RFC 4646. For example, "de-DE".
timeZone
User time zone id. For example, "Central European Standard Time". See Time Zone in the Lookups.
useDifferentCorrespondenceAddress
Defines whether a different correspondence address is used.
correspondenceAddr1
Correspondence address line 1.
correspondenceAddr2
Correspondence address line 2.
correspondenceAddr3
Correspondence address line 3.
correspondenceHouseNumber
Correspondence house number.
correspondenceCity
Correspondence city name.
correspondenceState
Correspondence state name.
correspondenceCountryName
Correspondence country name.
correspondenceCountryCode
Correspondence country ISO 3166-1 alpha-2 code.
correspondenceCountryCode3
Correspondence country ISO 3166-1 alpha-3 code.
correspondencePostCode
Correspondence postal code.
nationality
The user national country ISO2 code.
nationality3
The user national country ISO3 code.
taxId
Tax identification number.
currCode
Currency code of the account.
accTypeName
Account type of the account.
accTypeCode
Account type code of the account.
maximumAllowedBalance
Account's maximum allowed balance.
minimumAllowedBalance
Account's minimum allowed balance.
twoFAStatusCode
Two Factor Authentication Status Code. Refer to Two Factor Authentication Status Codes in the Lookups.
accFlowStatusCode
Status code of the account flow. See Account Flow Status Codes in the Lookups.
isEmailVerified
Defines whether the user's email is verified.
isMobilePhoneVerified
Defines whether the user's mobile phone number is verified.
isUserActive
Defines whether the user is active.
isUserLocked
Defines whether the user is locked.
lastLoginDate
Last user login date into the Kontocloud system.
lastLoginTime
Last user login time into the Kontocloud system.
isMtanEnabled
Defines whether MTAN support is enabled.
isBusinessUser
Defines whether business information is provided for a user.
businessCompanyName
Company legal name.
businessCompanyType
Company legal type.
businessCompanyRegistrationNumber
Company registration number.
businessCompanyRegistrationCountryCode
Company registration country ISO 3166-1 alpha-2 code.
businessCompanyRegistrationCountryCode3
Company registration country ISO 3166-1 alpha-3 code.
businessAddr1
Company address line 1.
businessAddr2
Company address line 2.
businessAddr3
Company address line 3.
businessHouseNumber
Company house number.
businessCity
Company city name.
businessPostCode
Company post code.
businessCountryCode
Company country ISO 3166-1 alpha-2 code.
businessCountryCode3
Company country ISO 3166-1 alpha-3 code.
businessUrl
Company website URL.
userAgreementReference
Reference to the user agreement text.
isUserAgreementUpToDate
Identifies the User Agreement actuality.
accountValidUntil
The latest account validity date.
accountCreationDate
The account creation date.
localDate
The current date of the caller.
localTime
The current time of the caller.
sysDate
The current date of the KontoCloud server
sysTime
The current time of the KontoCloud server
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"
}
}
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
Account number.
partnerReference
Partner service call identifier.
programCode
Program code
externalRequestReference
A reference assigned to the Data Deletion Request in the external system.
closingReason
Reason for closing the accountand data deletion (if it is needed).
storedPaymentOptionReference
Stored payment option reference to payout the account balance.
localDate
The current date of the caller.
localTime
The current time of the caller.
Response parameters
partnerReference
Partner service call identifier.
programCode
Program code
accno
Account number.
dateClosed
Calendar date when the account was closed.
localDate
The current date of the caller.
localTime
The current time of the caller.
sysDate
The current date of the KontoCloud server
sysTime
The current time of the KontoCloud server
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"
}
}
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
Account number.
partnerReference
Partner service call identifier.
programCode
Program code
paymentOptionCode
Payment option code.
externalChannelReference
External payment provider channel.
mandateReference
Mandate reference.
mandateSignedDate
Mandate signing date.
mandateSignedTime
mandateSignedTime
criteria
Collection of additional request parameters passed to the payment provider.
name
Parameter name.
value
Parameter value.
currCode
Currency code of the payment option to be stored.
oneTimePassword
One Time Password used for confirmation during Two Factor Authentication.
localDate
The current date of the caller.
localTime
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
Partner service call identifier.
programCode
Program code
accno
Account number.
authorizationToken
Unique authorization token assigned by an external payment provider.
paymentOptionCode
Payment option code.
paymentProviderResponse
Complete payment provider response.
localDate
The current date of the caller.
localTime
The current time of the caller.
sysDate
The current date of the KontoCloud server
sysTime
The current time of the KontoCloud server
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"
}
}
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
User or merchant account number.
partnerReference
Partner service call identifier.
programCode
Program code
paymentOptionCode
Payment option code.
authorizationToken
Unique authorization token assigned by an external payment provider.
useDifferentBillingAddress
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
Customer full name consisting of the first name and last name.
externalChannelReference
External payment provider channel.
criteria
Collection of additional request parameters passed to the payment provider.
name
Parameter name.
value
Parameter value.
oneTimePassword
One Time Password used for confirmation during Two Factor Authentication.
localDate
The current date of the caller.
localTime
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
Partner service call identifier.
programCode
Program code
accno
Account number.
paymentOptionCode
Payment option code.
storedPaymentOptionReference
Stored payment option reference.
initiationCountryCode
Stored Payment Option issuer country ISO2 code.
initiationCountryCode3
Stored Payment Option issuer country ISO3 code.
paymentProviderResponse
Complete payment provider response.
localDate
The current date of the caller.
localTime
The current time of the caller.
sysDate
The current date of the KontoCloud server
sysTime
The current time of the KontoCloud server
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"
}
}
post {baseURL}/account/{accno}/storedPaymentOptions/{storedPaymentOptionReference}/initVerify
Initiates verification of an e-wallet user or merchant account preferred payment option.
Request parameters
accno
User or merchant account number.
storedPaymentOptionReference
Stored payment option reference.
partnerReference
Partner service call identifier.
programAccno
Program account number.
localDate
The current date of the caller.
localTime
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
Partner service call identifier.
programCode
Program code
accno
Account number.
localDate
The current date of the caller.
localTime
The current time of the caller.
sysDate
The current date of the KontoCloud server
sysTime
The current time of the KontoCloud server
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"
}
}
post {baseURL}/account/{accno}/storedPaymentOptions/{storedPaymentOptionReference}/completeVerify
Completes verification of an e-wallet user or merchant account preferred payment option.
Request parameters
accno
User or merchant account number.
storedPaymentOptionReference
Stored payment option reference.
partnerReference
Partner service call identifier.
programCode
Program code
verificationCode
Payment option verification code.
localDate
The current date of the caller.
localTime
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
Partner service call identifier.
programCode
Program code
accno
Account number.
localDate
The current date of the caller.
localTime
The current time of the caller.
sysDate
The current date of the KontoCloud server
sysTime
The current time of the KontoCloud server
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"
}
}
del {baseURL}/account/{accno}/storedPaymentOptions/{storedPaymentOptionReference}
Deletes a preferred payment option from an e-wallet user or merchant account.
Request parameters
accno
User or merchant account number.
storedPaymentOptionReference
Stored payment option reference.
partnerReference
Partner service call identifier.
programCode
Program code
localDate
The current date of the caller.
localTime
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
Partner service call identifier.
programCode
Program code
accno
Account number.
localDate
The current date of the caller.
localTime
The current time of the caller.
sysDate
The current date of the KontoCloud server
sysTime
The current time of the KontoCloud server
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"
}
}
post {baseURL}/account/{accno}/storedPaymentOptions/{storedPaymentOptionReference}/setDefault
Sets a default stored payment option for an e-wallet user or merchant account.
Request parameters
accno
User or merchant account number.
storedPaymentOptionReference
Stored payment option reference.
partnerReference
Partner service call identifier.
programCode
Program code
localDate
The current date of the caller.
localTime
The current time of the caller.
Response parameters
partnerReference
Partner service call identifier.
programCode
Program code
accno
Account number.
localDate
The current date of the caller.
localTime
The current time of the caller.
sysDate
The current date of the KontoCloud server
sysTime
The current time of the KontoCloud server
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"
}
}
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
Account number.
partnerReference
Partner service call identifier.
programCode
Program code
transactionTypeCode
Transaction type. See Transaction Type in the Lookups.
localDate
The current date of the caller.
localTime
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
Partner service call identifier.
programCode
Program code
accno
Account number.
paymentOptions
Collection of payment option data.
code
Payment option code.
iconUrl
The URL of the payment option icon.
isStorable
Defines whether the payment option can be stored.
name
Payment option name.
paymentGroup
Payment group name.
paymentSubGroup
Payment subgroup name.
localDate
The current date of the caller.
localTime
The current time of the caller.
sysDate
The current date of the KontoCloud server
sysTime
The current time of the KontoCloud server
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"
}
}
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
Account number.
partnerReference
Partner service call identifier.
programCode
Program code
localDate
The current date of the caller.
localTime
The current time of the caller.
Response parameters
partnerReference
Partner service call identifier.
programCode
Program code
accno
Account number.
paymentOptions
Collection of payment option data.
bankName
Payment carrier bank name.
billingAddress
Associated billing address.
addr1
Address Line 1.
addr2
Address Line 2.
addr3
Address Line 3.
countryCode
Country ISO 3166-1 alpha-2 code.
countryCode3
Country ISO 3166-1 alpha-3 code.
countryName
Country name.
fullName
Customer's full name.
postCode
Postal code.
state
State name.
code
Payment option code.
expiryMonth
Payment carrier expiry month.
expiryYear
Payment carrier expiry year.
iconUrl
The URL of the payment option icon.
isDefault
Defines whether the payment option is default for the specified account.
isStorable
Defines whether the payment option can be stored.
isVerifiable
Defines whether the payment option can be verified.
mandate
Mandate data. Available for "Bank Account SEPA" payment option.
financialInstitutionAddr1
Financial institution address Line 1.
financialInstitutionAddr2
Financial institution address Line 2.
financialInstitutionCity
Financial institution city name.
financialInstitutionCountryCode
Financial institution country ISO 3166-1 alpha-2 code.
financialInstitutionCountryCode3
Financial institution country ISO 3166-1 alpha-3 code.
financialInstitutionCountryName
Financial institution country name.
financialInstitutionCreditorIdentifier
Financial institution creditor identifier.
financialInstitutionName
Financial institution name.
financialInstitutionPostCode
Financial institution postal code.
financialInstitutionState
Financial institution state name.
mandateReference
Mandate reference.
mandateSignedDate
Mandate signing date.
mandateSignedTime
Mandate signing time.
name
Payment option name.
paymentGroup
Payment group name.
paymentSubGroup
Payment subgroup name.
reference
Stored payment option unique reference code.
statusCode
Stored payment option status code. See Payment Option Status in the Lookups.
validUntilDate
Payment option's validity date.
localDate
The current date of the caller.
localTime
The current time of the caller.
sysDate
The current date of the KontoCloud server
sysTime
The current time of the KontoCloud server
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"
}
}
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
Partner service call identifier.
programAccno
Program account number.
accno
User or merchant account number.
accnoType
Account number type. See Account Number Type in the Lookups. Required only if 'accno' is specified.
storedPaymentOptionReference
Stored payment option unique reference. This value can be supplied, if 'paymentOptionCode' is not provided.
paymentOptionCode
Payment option code.
presentationAmount
The amount which is authorized for payment to the account.
presentationCurrCode
The 3-letter currency code associated with the transaction.
presentationUsage
Information relevant to the payment.
useDifferentBillingAddress
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
Customer full name consisting of the first name and last name.
emailAddress
Email address.
addr1
Address line 1.
addr2
Address line 2.
addr3
Address line 3.
houseNumber
House number.
city
City name.
state
State name.
countryCode
Country ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code.
postCode
Postal code.
phone
Phone number.
custom1
For external party usage.
custom2
For external party usage.
custom3
For external party usage.
externalChannelReference
External payment provider channel.
mandateReference
Mandate reference.
mandateSignedDate
Mandate signing date.
mandateSignedTime
mandateSignedTime
criteria
Collection of additional request parameters passed to the payment provider.
name
Parameter name.
value
Parameter value.
localDate
The current date of the caller.
localTime
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
Partner service call identifier.
programCode
Program code
accno
Account number.
storedPaymentOptionReference
Stored payment option unique reference. This value can be supplied, if 'paymentOptionCode' is not provided.
uniqueReference
This is the uniqueReference that was assigned to the external authorization. It is received as part of authorization response from KontoCloud.
authorizationToken
Unique authorization token assigned by an external payment provider.
paymentOptionCode
Payment option code.
presentationAmount
The amount which is authorized for payment to the account.
presentationCurrCode
The 3-letter currency code associated with the transaction.
presentationUsage
Information relevant to the payment.
custom1
For external party usage.
custom2
For external party usage.
custom3
For external party usage.
statusReason
Reason for a status code.
paymentProviderResponse
Complete payment provider response.
localDate
The current date of the caller.
localTime
The current time of the caller.
sysDate
The current date of the KontoCloud server
sysTime
The current time of the KontoCloud server
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"
}
}
post {baseURL}/payment/{uniqueReference}/completeAuthorize
This interface method is used to complete a previously initiated authorization.
Request parameters
uniqueReference
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
Partner service call identifier.
authorizationToken
Unique authorization token assigned by an external payment provider.
externalChannelReference
External payment provider channel.
useDifferentBillingAddress
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
Customer full name consisting of the first name and last name.
addr1
Address line 1.
addr2
Address line 2.
addr3
Address line 3.
houseNumber
House number.
city
City name.
countryCode
Country ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code.
postCode
Postal code.
phone
Phone number.
criteria
Collection of additional request parameters passed to the payment provider.
name
Parameter name.
value
Parameter value.
localDate
The current date of the caller.
localTime
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
Partner service call identifier.
initiatorAccno
Initiator account number.
accno
Account number.
uniqueReference
This is the uniqueReference that was assigned to the external authorization. It is received as part of authorization response from KontoCloud.
storedPaymentOptionReference
Stored payment option reference.
initiationCountryCode
Payment Option issuer country ISO2 code.
initiationCountryCode3
Payment Option issuer country ISO3 code.
processedAmount
The amount returned by the acquirer after processing.
processedCurrCode
The 3-letter currency code associated with the processed amount.
statusReason
Reason for a status code.
paymentProviderResponse
Complete payment provider response:
- Array for "PayU" payment option;
- Object for all other payment options.
localDate
The current date of the caller.
localTime
The current time of the caller.
sysDate
The current date of the KontoCloud server
sysTime
The current time of the KontoCloud server
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"
}
}
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
Partner service call identifier.
programAccno
Program account number.
accno
User or merchant account number.
accnoType
Account number type. See Account Number Type in the Lookups. Required only if 'accno' is specified.
storedPaymentOptionReference
Stored payment option reference.
invoiceReference
Payment invoice reference.
channelProductReference
Payment channel product reference.
presentationAmount
The amount which is authorized for payment to the account.
presentationCurrCode
The 3-letter currency code associated with the transaction.
presentationUsage
Information relevant to the payment.
useDifferentBillingAddress
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
Customer full name consisting of the first name and last name.
addr1
Address line 1.
addr2
Address line 2.
addr3
Address line 3.
houseNumber
House number.
city
City name.
state
State name.
countryCode
Country ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code.
postCode
Postal code.
phone
Phone number.
emailAddress
Email address.
custom1
For external party usage.
custom2
For external party usage.
custom3
For external party usage.
criteria
Collection of additional request parameters passed to the payment provider.
name
Parameter name.
value
Parameter value.
oneTimePassword
One Time Password used for confirmation during Two Factor Authentication.
localDate
The current date of the caller.
localTime
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
Partner service call identifier.
programAccno
Program account number.
accno
Account number.
uniqueReference
This is the uniqueReference that was assigned to the external authorization. It is received as part of authorization response from KontoCloud.
storedPaymentOptionReference
Stored payment option reference.
invoiceReference
Payment invoice reference.
channelProductReference
Payment channel product reference.
presentationAmount
The amount which is authorized for payment to the account.
presentationCurrCode
The 3-letter currency code associated with the transaction.
presentationUsage
Information relevant to the payment.
processedAmount
The amount returned by the acquirer after processing.
processedCurrCode
The 3-letter currency code associated with the processed amount.
custom1
For external party usage.
custom2
For external party usage.
custom3
For external party usage.
statusReason
Reason for a status code.
paymentProviderResponse
Complete payment provider response.
localDate
The current date of the caller.
localTime
The current time of the caller.
sysDate
The current date of the KontoCloud server
sysTime
The current time of the KontoCloud server
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"
}
}
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
This is the uniqueReference that was assigned to the external authorization. It is received as part of authorization response from KontoCloud.
partnerReference
Partner service call identifier.
modifiedUsage
Information relevant to the payment.
custom1
For external party usage.
custom2
For external party usage.
custom3
For external party usage.
localDate
The current date of the caller.
localTime
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
Partner service call identifier.
initiatorAccno
Initiator account number.
accno
Account number.
uniqueReference
Unique transaction reference assigned by KontoCloud upon authorization.
modifiedAmount
The amount which is captured for payment to the account.
modifiedAmountCurrCode
The 3-letter currency code associated with the transaction.
processedAmount
The amount returned by the acquirer after processing.
processedCurrCode
The 3-letter currency code associated with the processed amount.
custom1
For external party usage.
custom2
For external party usage.
custom3
For external party usage.
statusReason
Reason for a status code.
paymentProviderResponse
Complete payment provider response:
- Array for "PayU" payment option;
- Object for all other payment options.
localDate
The current date of the caller.
localTime
The current time of the caller.
sysDate
The current date of the KontoCloud server
sysTime
The current time of the KontoCloud server
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"
}
}
post {baseURL}/payment/{uniqueReference}/refund
This interface method is used to refund a previously captured external authorization.
Request parameters
partnerReference
Partner service call identifier.
uniqueReference
This is the uniqueReference that was assigned to the external authorization. It is received as part of authorization response from KontoCloud.
refundAmount
Amount being refunded. It cannot exceed the amount of the refunded transaction. If the value is not provided the full refund is performed.
refundUsage
Information relevant to the refund.
refundType
The code defining what type of refund will be performed. Available types of refund listed in "Refund Type" lookup.
refundSourceAccno
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
For external party usage.
custom2
For external party usage.
custom3
For external party usage.
localDate
The current date of the caller.
localTime
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
Partner service call identifier.
initiatorAccno
Initiator account number.
accno
Account number.
uniqueReference
Unique transaction reference assigned by KontoCloud upon authorization.
refundAmount
Amount being refunded. It cannot exceed the amount of the refunded transaction. If the value is not provided the full refund is performed.
refundCurrCode
Currency code of the amount to be refunded.
processedAmount
The amount returned by the acquirer after processing.
processedCurrCode
The 3-letter currency code associated with the processed amount.
custom1
For external party usage.
custom2
For external party usage.
custom3
For external party usage.
statusReason
Reason for a status code.
paymentProviderResponse
Complete payment provider response:
- Array for "PayU" payment option;
- Object for all other payment options.
localDate
The current date of the caller.
localTime
The current time of the caller.
sysDate
The current date of the KontoCloud server
sysTime
The current time of the KontoCloud server
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"
}
}
post {baseURL}/payment/{uniqueReference}/cancel
This interface method is used to cancel a previously authorized payment to an e-wallet account.
Request parameters
uniqueReference
This is the uniqueReference that was assigned to the external authorization. It is received as part of authorization response from KontoCloud.
partnerReference
Partner service call identifier.
custom1
For external party usage.
custom2
For external party usage.
custom3
For external party usage.
localDate
The current date of the caller.
localTime
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
Partner service call identifier.
initiatorAccno
Initiator account number.
accno
Account number.
uniqueReference
Unique transaction reference assigned by KontoCloud upon authorization.
custom1
For external party usage.
custom2
For external party usage.
custom3
For external party usage.
statusReason
Reason for a status code.
paymentProviderResponse
Complete payment provider response:
- Array for "PayU" payment option;
- Object for all other payment options.
localDate
The current date of the caller.
localTime
The current time of the caller.
sysDate
The current date of the KontoCloud server
sysTime
The current time of the KontoCloud server
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"
}
}
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
Unique transaction reference assigned by the KontoCloud.
partnerReference
Partner service call identifier.
localDate
The current date of the caller.
localTime
The current time of the caller.
Response parameters
uniqueReference
Unique transaction reference assigned by the KontoCloud. Same as in request.
partnerReference
Partner service call identifier.
initiatorAccno
Initiator account number.
initiatorName
Name of the instance which initiated the payment.
accno
Account number.
presentationAmount
Amount with which the payment was initiated or captured.
presentationCurrCode
The 3-letter currency code associated with the transaction.
presentationUsage
Information relevant to the payment.
customerFullName
Customer full name consisting of the first name and last name.
addr1
Address line 1.
addr2
Address line 2.
addr3
Address line 3.
houseNumber
House number.
city
City name.
state
State name.
country
Country name.
countryCode
Country ISO 3166-1 alpha-2 code.
countryCode3
Country ISO 3166-1 alpha-3 code.
postCode
Postal code.
statusReason
Reason for a status code.
localDate
The current date of the caller.
localTime
The current time of the caller.
sysDate
The current date of the KontoCloud server
sysTime
The current time of the KontoCloud server
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"
}
}
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
E-wallet user account number.
partnerReference
Partner service call identifier.
programCode
Program code
userId
User identifier: email, login, secondary email address, or uuid.
localDate
The current date of the caller.
localTime
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
partnerReference same as in the Request.
programCode
Program code
accno
Account number.
localDate
The current date of the caller.
localTime
The current time of the caller.
sysDate
The current date of the KontoCloud server
sysTime
The current time of the KontoCloud server
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"
}
}
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
E-wallet user account number.
partnerReference
Partner service call identifier.
programCode
Program code
amount
The amount to be checked for availability to payment from the account.
currCode
The 3-letter currency code of the checked amount.
localDate
The current date of the caller.
localTime
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.
When this API Endpoint returns a Successful Response - the "Content-Type" Header will be "text/plain" and the Body will contain either "yes" or "no", as demonstrated.
However, if it returns an Error Response (ex. HTTP 400) - the "Content-Type" Header will be "application/json" and the Body will contain a JSON Error Data Object.
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"
}
}
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
E-wallet user account number.
partnerReference
Partner service call identifier.
programCode
Program code
startDate
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
Start time for the enquiry. If 'startTime' is provided, 'startDate' becomes required. If not specified "000000" is used as start time.
endDate
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
End time for the enquiry. If 'endTime' is provided, 'endDate' becomes required. If not specified "235959" is used as end time.
top
Number of account entries to return. Used for requesting a specific number of the most recent account entries.
skip
Number of account entries to skip in the result set. Used for skipping a specific number of the most recent account entries.
includeNeutral
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
Defines the direction of sorting by booking date. See Sort Direction in the Lookups. If not specified, "ASC" is used.
includePendingTransactions
A flag defining whether pending transactions should be included in the response. "False" is used if it is not provided.
localDate
The current date of the caller.
localTime
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
Partner service call identifier.
programAccno
Program account number.
accno
E-wallet user account number or merchant account number.
count
Total pending transactions count using the 'startDate' and 'endDate' filters.
entries
Collection of account entries data.
amount
For account entry: converted entry amount according to the account currency. For account entry: converted entry amount according to the account currency.
For transaction entry: transaction's AccountAmount.
balance
For account entry: account closed balance.
For account entry: account closed balance.
For transaction entry: empty.
bookingDate
For account entry: entry booking date.
For account entry: entry booking date.
For transaction entry: empty.
bookingTime
For account entry: entry booking time.
For account entry: entry booking time.
For transaction entry: empty.
currCode
For account entry: account currency code.
For account entry: account currency code.
For transaction entry: transaction's account currency code.
description
For account entry: entry description.
For account entry: entry description.
For transaction entry: transaction presentation usage.
entryIndicator
Entry indicator:
- "DBIT",
- "CRDT".
entryType
Entry type.
exchangeRate
Currency conversion rate used.
isPending
For account entry: False.
For transaction entry: True.
name
Entry name.
reference
For account entry: account entry unique reference. For account entry: account entry unique reference.
For transaction entry: transaction's TransactionReference.
sourceAmount
For account entry: originaloriginal entry amount.
For transaction entry: the transaction's PresentationAmount.
sourceCurrCode
For account entry: original entry currency code.
For account entry: original entry currency code.
For transaction entry: transaction's presentationCurrCode.
statusCode
For account entry: "SETTLED". For transaction entry: Transaction status code. See Transaction Status in the Lookups.
valueTime
For account entry: entry value time. For account entry: entry value time.
For transaction entry: transaction's creation time.
localTime
The current time of the caller.
sysDate
The current date of the KontoCloud server
sysTime
The current time of the KontoCloud server
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"
}
}
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
E-wallet user account number.
partnerReference
Partner service call identifier.
programCode
Program code
localDate
The current date of the caller.
localTime
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
Partner service call identifier.
programAccno
Program account number.
accno
E-wallet user account number or merchant account number.
psBal
Previous day closing balance.
avlBal
Current available balance (booked balance – blocked Amount).
bkBal
Booked balance: Booked balance is the total deposit on a particular day plus previous closing balance.
blkAmt
Total Blocked amount: Blocked amount is the authorized amount until it is captured or cancelled.
pooledAmt
Total Pooled amount: Pooled amount is authorized only on the wallet account, but not on the external payment option.
currCode
Currency code of the balance returned.
localTime
The current time of the caller.
sysDate
The current date of the KontoCloud server
sysTime
The current time of the KontoCloud server
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"
}
}
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
Partner service call identifier.
depositReference
uniqueReference of a transaction that was assigned to a capture external authorization request.
accno
E-wallet user account number.
merchantAccno
Merchant account number.
programCode
Program code
programAccno
Program account number.
merchantProgramCode
Destination program code. Mandatory if merchantAccno is specified as External Account Reference.
paymentAmount
The amount of payment .
paymentCurrCode
The 3-letter currency code associated with the transaction.
paymentUsage
Description of a performed payment.
useDifferentBillingAddress
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
Customer full name consisting of the first name and last name.
countryCode
Country ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code.
addr1
Customer's address line 1.
addr2
Customer's address line 2.
addr3
Customer's address line 3.
houseNumber
Customer's house number.
city
Customer's city name.
state
State name.
postCode
Customer's postal code.
phone
Phone number.
emailAddress
Email address.
localDate
The current date of the caller.
localTime
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
Partner service call identifier.
uniqueReference
Unique reference assigned by KontoCloud to the credit transaction.
accno
E-wallet user account number or merchant account number.
merchantAccno
Seller merchant account number.
programAccno
Program account number.
paymentAmount
The amount of payment .
paymentCurrCode
The 3-letter currency code associated with the transaction.
paymentUsage
Description of a performed payment.
fxRate
Currency conversion rate between payment currency and merchant account currency used in the transaction.
statusReason
Reason for a status code.
localTime
The current time of the caller.
sysDate
The current date of the KontoCloud server
sysTime
The current time of the KontoCloud server
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"
}
}
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
Partner service call identifier.
depositReference
uniqueReference of a transaction that was assigned to a capture external authorization request.
accno
E-wallet user account number or merchant account number.
programAccno
Initiating program account number.
merchantAccno
Destination merchant account number.
merchantProgramCode
Destination program code. Mandatory if merchantAccno is specified as External Account Reference.
accnoType
Account number and merchant account number type. Refer to Account Number Type in the Lookups.
paymentAmount
The amount of payment from eWallet account to merchant account.
paymentCurrCode
The 3-letter currency code associated with the transaction.
paymentUsage
Description of a performed payment.
useDifferentBillingAddress
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
Customer full name consisting of the first name and last name.
countryCode
Country ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code.
addr1
Customer's address line 1.
addr2
Customer's address line 2.
addr3
Customer's address line 3.
houseNumber
Customer's house number.
city
Customer's city name.
state
State name.
postCode
Customer's postal code.
emailAddress
Email address.
oneTimePassword
One Time Password used for confirmation during Two Factor Authentication.
localDate
The current date of the caller.
localTime
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
Partner service call identifier.
uniqueReference
Unique reference assigned by KontoCloud to the credit transaction.
accno
E-wallet user account number or merchant account number.
programAccno
Program account number.
merchantAccno
Seller merchant account number.
merchantProgramCode
Destination program code.
paymentAmount
The amount of payment .
paymentCurrCode
The 3-letter currency code associated with the transaction.
paymentUsage
Description of a performed payment.
fxRate
Currency conversion rate used.
statusReason
Reason for a status code.
localTime
The current time of the caller.
sysDate
The current date of the KontoCloud server
sysTime
The current time of the KontoCloud server
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"
}
}
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
This is the uniqueReference that was assigned to an authorization. It is received as part of "KC-Authorize" response from KontoCloud.
partnerReference
Partner service call identifier.
modifiedAmount
The amount of payment from the e-Wallet account to the merchant account.
modifiedAmountCurrCode
The 3-letter currency code associated with the transaction.
modifiedUsage
Information relevant to the payment.
localDate
The current date of the caller.
localTime
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
A unique reference assigned to the authorization by KontoCloud. Same as in the request.
partnerReference
Partner service call identifier.
merchantAccno
Merchant account number.
accno
Account number.
modifiedAmount
The amount of payment from the e-Wallet account to the merchant account.
modifiedAmountCurrCode
The 3-letter currency code associated with the transaction.
processedAmount
The amount the member is paying from their e-Wallet account to the merchant account in the merchant account currency.
fxRate
Currency conversion rate between payment currency and merchant account currency used in the transaction.
statusReason
Reason for a status code.
localTime
The current time of the caller.
sysDate
The current date of the KontoCloud server
sysTime
The current time of the KontoCloud server
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"
}
}
post {baseURL}/payment/{uniqueReference}/kc-cancel
This interface method is used to cancel a previously authorized payment before it is captured.
Request parameters
uniqueReference
This is the uniqueReference that was assigned to an authorization. It is received as part of "KC-Authorize" response from KontoCloud.
partnerReference
Partner service call identifier.
modifiedUsage
Information relevant to the payment.
localDate
The current date of the caller.
localTime
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
A unique reference assigned to the authorization by KontoCloud. Same as in the request.
partnerReference
Partner service call identifier.
merchantAccno
Merchant account number.
accno
Account number.
statusReason
Reason for a status code.
localTime
The current time of the caller.
sysDate
The current date of the KontoCloud server
sysTime
The current time of the KontoCloud server
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"
}
}
post {baseURL}/payment/{uniqueReference}/kc-refund
This interface method is used to refund a previously captured payment.
Request parameters
uniqueReference
This is the uniqueReference that was assigned to an authorization. It is received as part of "KC-Authorize" response from KontoCloud.
partnerReference
Partner service call identifier.
refundAmount
Amount being refunded. It cannot exceed the amount of the refunded transaction. If the value is not provided the full refund is performed.
refundUsage
Information relevant to the refund.
refundType
The code defining what type of refund will be performed. Available types of refund listed in "Refund Type" lookup.
localDate
The current date of the caller.
localTime
The current time of the caller.
Response parameters
uniqueReference
A unique reference assigned to the authorization by KontoCloud. Same as in the request.
partnerReference
Partner service call identifier.
refundSourceAccno
Refund source account number.
accno
Account number.
statusReason
Reason for a status code.
localTime
The current time of the caller.
sysDate
The current date of the KontoCloud server
sysTime
The current time of the KontoCloud server
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"
}
}
post {baseURL}/compliance/addressCheck
A request to check the validity of an address.
Request parameters
partnerReference
Partner service call identifier.
programCode
Program code
street
Street.
house
House.
postalCode
Postal code.
city
City name.
countryCode
Country ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code.
localDate
The current date of the caller.
localTime
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
Partner service call identifier.
programCode
Program code
addressCheckData
Address check data.
archiveId
Archived check result identifier.
decision
The following options are possible:
• "HOUSE_CONFIRMED": address confirmed;
• "STREET_CONFIRMED_HOUSE_NOT_I DENTIFIED": street confirmed / House unknown;
• "STREET_CONFIRMED_HOUSE_NOT_P ROVIDED": street confirmed / House not provided in request;
• "CITY_CONFIRMED_STREET_NOT_IDE NTIFIED": city confirmed / Street unknown;
• "NOT_CONFIRMED": location not confirmed (unknown).
foundAddress
Found address data.
city
City.
countryCode
Country ISO 3166-1 alpha-2 code.
house
House.
houseExtension
House extension.
postalCode
Postal code.
street
Street.
normalizedAddress
Normalized address data. Only for Germany.
city
City.
countryCode
Country ISO 3166-1 alpha-2 code.
house
House.
houseExtension
House extension.
postalCode
Postal code.
street
Street.
postalCodeCorrect
Defines whether the postal code is correct.
localDate
The current date of the caller.
localTime
The current time of the caller.
sysDate
The current date of the KontoCloud server
sysTime
The current time of the KontoCloud server
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"
}
}
post {baseURL}/compliance/personCheck
A request to check a person's compliance via the compliance system.
Request parameters
partnerReference
Partner service call identifier.
merchantReference
Merchant reference to identify the merchant for which the check is being performed.
programCode
Program code
division
Division.
customerId
Customer identifier.
firstName
First name.
lastName
Last name.
street
Street.
house
House.
postalCode
Postal code.
city
City name.
countryCode
Country ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code.
emailAddress
Email address.
landlinePhone
Landline phone number.
mobilePhone
Mobile phone number.
dateOfBirth
Date of birth.
placeOfBirth
Place of birth.
nationality
The ISO2 or ISO3 code of a country a new user is a national of.
localDate
The current date of the caller.
localTime
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
Partner service call identifier.
programCode
Program code
complianceData
Compliance data.
archiveId
Archived check result identifier.
details
List of compliance check details. Each array item contains a list of "name"->"value" pairs.
hitType
The following options are possible:
• "SL" – sanctions list,
• "BL" – black list,
• "PEP" – publicly exposed person.
listHit
Whether check has been manually added to the compliance white/black list.
manualReview
Whether a manual review is required or not.
trafficLight
The following options are possible:
• "RED" – hit,
• "YELLOW" – unsure hit,
• "GREEN" – no hit.
localDate
The current date of the caller.
localTime
The current time of the caller.
sysDate
The current date of the KontoCloud server
sysTime
The current time of the KontoCloud server
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"
}
}
post {baseURL}/compliance/companyCheck
A request to check a company's compliance via the compliance system.
Request parameters
partnerReference
Partner service call identifier.
merchantReference
Merchant reference to identify the merchant for which the check is being performed.
programCode
Program code
division
Division.
customerId
Customer identifier.
name
Company name
street
Street.
house
House.
postalCode
Postal code.
city
City name.
countryCode
Country ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code.
emailAddress
Email address.
phone
Phone number.
vatId
VAT identifier without the country code.
localDate
The current date of the caller.
localTime
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
Partner service call identifier.
programCode
Program code
complianceData
Compliance data.
archiveId
Archived check result identifier.
details
List of compliance check details. Each array item contains a list of "name"->"value" pairs.
hitType
The following options are possible:
• "SL" – sanctions list,
• "BL" – black list,
• "PEP" – publicly exposed person.
listHit
Whether check has been manually added to the compliance white/black list.
manualReview
Whether a manual review is required or not.
trafficLight
The following options are possible:
• "RED" – hit,
• "YELLOW" – unsure hit,
• "GREEN" – no hit.
localDate
The current date of the caller.
localTime
The current time of the caller.
sysDate
The current date of the KontoCloud server
sysTime
The current time of the KontoCloud server
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"
}
}
post {baseURL}/compliance/personRiskCheck
A request to check risks associated with a transaction.
Request parameters
partnerReference
Partner service call identifier.
programCode
Program code
division
Division.
merchantAccno
Merchant account number.
accnoType
Account number type, applicable to merchantAccno. See Account Number Type in the Lookups.
merchantProgramCode
Destination program code. Mandatory if merchantAccno is specified as External Account Reference.
customerId
Customer identifier.
firstName
First name.
lastName
Last name.
street
Street.
house
House.
postalCode
Postal code.
city
City name.
countryCode
Country ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code.
emailAddress
Email address.
landlinePhone
Landline phone number.
mobilePhone
Mobile phone number.
dateOfBirth
Date of birth.
placeOfBirth
Place of birth.
nationality
The ISO2 or ISO3 code of a country a new user is a national of.
orderData
Order data.
channel
Order channel.
orderItems
Order items collection.
amount
Number of articles.
group
Article group.
itemType
Item type.
name
Article name.
number
Article number.
price
Article price per item.
totalPrice
Total price.
orderValue
Total order value.
VIN
Vehicle identification number.
paymentOptionCode
Payment option code.
localDate
The current date of the caller.
localTime
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
Partner service call identifier.
programCode
Program code
complianceData
Compliance data.
archiveId
Archived check result identifier.
denialReason
The following values are possible for YELLOW or RED value of trafficLight:
• "BASKET_LIMIT",
• "BLACKLIST",
• "CUSTOMER_LIMIT",
• "VELOCITY".
limit
Credit limit.
recommendation
Comment on final decision.
trafficLight
The following options are possible:
• "RED" – high risk;
• "YELLOW" – over credit limit;
• "GREEN" – accepted.
localDate
The current date of the caller.
localTime
The current time of the caller.
sysDate
The current date of the KontoCloud server
sysTime
The current time of the KontoCloud server
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"
}
}
post {baseURL}/compliance/companyRiskCheck
A request to check risks associated with a transaction.
Request parameters
partnerReference
Partner service call identifier.
programCode
Program code
division
Division.
merchantAccno
Merchant account number.
accnoType
Account number type, applicable to merchantAccno. See Account Number Type in the Lookups.
merchantProgramCode
Destination program code. Mandatory if merchantAccno is specified as External Account Reference.
customerId
Customer identifier.
name
Company name
street
Street.
house
House.
postalCode
Postal code.
city
City name.
countryCode
Country ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code.
emailAddress
Email address.
phone
Phone number.
orderData
Order data.
channel
Order channel.
orderItems
Order items collection.
amount
Number of articles.
group
Article group.
itemType
Item type.
name
Article name.
number
Article number.
price
Article price per item.
totalPrice
Total price.
orderValue
Total order value.
VIN
Vehicle identification number.
paymentOptionCode
Payment option code.
localDate
The current date of the caller.
localTime
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
Partner service call identifier.
programCode
Program code
complianceData
Compliance data.
archiveId
Archived check result identifier.
denialReason
The following values are possible for YELLOW or RED value of trafficLight:
• "BASKET_LIMIT",
• "BLACKLIST",
• "CUSTOMER_LIMIT",
• "VELOCITY".
limit
Credit limit.
recommendation
Comment on final decision.
trafficLight
The following options are possible:
• "RED" – high risk;
• "YELLOW" – over credit limit;
• "GREEN" – accepted.
localDate
The current date of the caller.
localTime
The current time of the caller.
sysDate
The current date of the KontoCloud server
sysTime
The current time of the KontoCloud server
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"
}
}
get {baseURL}/settings/getFinancialInstitutionData?partnerReference={partnerReference}&localDate={localDate}&localTime={localTime}
Returns the financial institution's data.
Response parameters
partnerReference
Partner service call identifier.
name
Financial institution name.
addr1
Financial institution address Line 1.
addr2
Financial institution address Line 2.
city
Financial institution city name.
state
Financial institution state name.
countryName
Financial institution country name.
countryCode
Financial institution country ISO 3166-1 alpha-2 code.
countryCode3
Financial institution country ISO 3166-1 alpha-3 code.
postCode
Financial institution postal code.
contactPhone
Financial institution contact phone.
contactEmail
Financial institution contact email.
creditorIdentifier
Financial institution creditor identifier.
localDate
The current date of the caller.
localTime
The current time of the caller.
sysDate
The current date of the KontoCloud server
sysTime
The current time of the KontoCloud server
executiveBoard
List of Executive Board members.
supervisoryBoard
List of Supervisory Board members.
corporationType
Corporation type.
tradeRegisterNumber
Trade register number.
vat
VAT ID Number.
bankName
Bank name.
iban
IBAN.
bic
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"
}
}
Account Number Type code | Description |
00 | External Account Reference |
01 | KontoCloud Account Number |
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 |
Status code | Description |
ACTIVE | Active |
CLOSED | Closed |
INACTIVE | Inactive |
REJECTED | Rejected |
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 |
Code | Description |
OK | Compliance check hit. |
KO | No compliance check hit. |
Code | Description |
1 | Android |
2 | iOS |
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 |
Code | Description |
FEMALE | Female |
MALE | Male |
Code | Description |
1 | General |
2 | General Unverified |
3 | Payment Option Specific |
4 | Payment Option Specific Unverified |
Code | Description |
INFO | Information |
SUCCESS | Success |
WARNING | Warning |
ERROR | Error |
Code | Description |
BANKS | Banks |
CARDS | Cards |
ALTPMNT | Alternative Payments |
Title code | Description |
INVERIFCTN | In Verification |
VERIFIED | Verified |
UNVERIFIED | Unverified |
Code | Description |
CRDTCRD | Credit Cards |
DBITCRD | Debit Cards |
EWALLET | E-Wallets |
SEPA | SEPA |
RTBNKTRSFR | Real Time Bank Transfers |
Code | Description |
1 | Daily |
2 | Weekly |
3 | Monthly |
4 | Quarterly |
5 | Biannually |
6 | Yearly |
7 | Lifetime |
8 | Single |
Code | Description |
General Response Codes | |
0000 | Successful execution. |
0001 | One 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 }. |
0002 | Invalid '{parameter name}' supplied. |
0003 | 'amount' should be greater than 0.00. |
0004 | The program does not have configured program payment provider settings for the used payment option. |
0005 | Invalid program code: {the program code}. |
0006 | External payment provider failed to process the operation. |
0007 | '{parameter name}' must not be empty. |
0008 | Invalid account number supplied: {account number}. |
0011 | Invalid 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". |
0015 | Payment status is different from 'Authorized'. |
0017 | Corresponding account type is inactive. |
0018 | Unknown user. |
0019 | User is inactive. |
0020 | User is locked. |
0021 | Unknown 'transactionTypeCode'. |
0022 | Unknown 'paymentOptionCode'. |
0023 | Unknown currency code. |
0024 | 'mandateReference', 'mandateSignedDate' and 'mandateSignedTime' must be empty for payment options different from "Bank Account SEPA". |
0026 | Maximum value of the '{limit name}' limit is exceeded. |
0027 | Invalid country code supplied in: '{parameter name}'. |
0028 | Country supplied in the 'countryCode' is not supported. |
0029 | Specified 'programAccno' is not a program account. |
0030 | Invalid 'fileId'. |
0031 | Specified '{parameter name}' is not an e-wallet user account. |
0032 | Unknown 'paymentGroupCode'. |
0033 | Unknown 'paymentSubGroupCode'. |
0034 | '{parameter name}' is already in use for the account. |
0035 | Payment status is different from 'Received'. |
0036 | Current account application status does not allow file uploading or deleting. |
0037 | Specified '{parameter name}' is not a merchant account. |
0038 | Digital signature of the payment provider response is incorrect. |
0039 | The file size must be less than or equal to 10 MB. |
0040 | Program account has insufficient funds: {program account number}. |
0041 | User password is expired. |
0043 | Using of the stored payment option is denied, because it is in the "Pending" status. |
0044 | '{Parameter Name}' array contains duplicated items. |
0045 | Using of the stored payment option is denied, because it is in the "Pending" or "Blocked" status. |
0046 | If 'useDifferentBillingAddress' is true, 'customerFullName', 'addr1', 'city', 'countryCode', 'postCode' must be provided. |
0047 | Database connection timeout. |
0048 | Unknown '{parameter name}'. |
0049 | Status of transaction specified by 'uniqueReference' is different from "Authorized". |
0050 | Transaction specified by 'uniqueReference' has already got a dependent transaction of transaction type category "Load Account". |
0051 | Minimum value of the '{limit name}' limit is exceeded. |
0052 | Payer's account has insufficient funds: {account number}. |
0055 | Failed to get order data from debtor management provider. |
0056 | Payment status is different from 'Received', 'Authorized' or 'Capture in Progress'. |
0057 | The file is empty. |
0058 | Server is currently busy. Please try again. |
0060 | Account is inactive: {account number}. |
0061 | Merchant is inactive: {the name of corresponding Account Owner}. |
0063 | Integration 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. |
0065 | User Agreement Text is not found by specified 'userAgreementReference'. |
0066 | Value must be > 0: '{parameter name}'. |
0067 | Specified merchant account has a currency different from the specified '{parameter name}'. |
0068 | The operation is denied for this user: not enabled through API Authorization Sets. |
0069 | The operation is denied for this user: {system operation code}. |
0070 | The uploaded file content does not match the file extension. |
0071 | Provided stored payment option has exceeded its validity period. |
0073 | Account's maximum balance would be exceeded as a result of this transaction: {account number}. |
0074 | Specified 'programAccno' has a currency different from the transaction currency. |
0075 | Specified 'accno' has a currency different from the transaction currency. |
0077 | Failed to convert currency. |
0078 | Corresponding payment option is inactive for: {account number}. |
0079 | Corresponding transaction type is inactive for: {account number}. |
0080 | Account is expired: {account number}. |
0081 | The file name length must be less than or equal to 255 characters. |
0082 | Merchant account has insufficient funds: {merchant account number}. |
0083 | Specified 'accno' is neither an e-wallet user account nor merchant account. |
0084 | Specified 'accno' is an e-wallet user but the provided stored payment option is not associated to him/her. |
0085 | For the country "{Country name}" parameter '{parameter name}' is required. |
0086 | Transaction settlement failed, transaction is created in the "Captured" status. |
0087 | '{parameter name}' is specified, 'accnoType' must also be specified. |
0088 | Incorrect file extension. Supported file extensions are jpg, jpeg, png, pdf, doc, docx. |
0089 | Mandate reference must be unique for the program. |
0090 | The provided value in '{parameter name}' is incorrect state name or code. |
0091 | Transaction specified by '{parameter name}' must have transaction type category "Deposit". |
0092 | Transaction specified by 'uniqueReference' must have transaction type category "Payment". |
0095 | Specified 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". |
0096 | Authorization has been denied for this request. |
0097 | Payload has an incorrect format. |
0098 | Concurrency error occurred. |
0099 | Unexpected server error occurred. |
1431 | The specified {amount} does not satisfy the currency minor unit. |
1432 | The specified {amount} is less than the currency minimum allowed value. |
9001 | BIN check service failed to perform the operation. |
9002 | The 'criteria' request parameter with name '{parameter name}' is not a valid fully-qualified https URL. |
9005 | Only "EUR" can be used with provided "Bank Account SEPA" payment option. |
9006 | Virtual payment provider is used, 'criteria' request parameter with the following name must be provided: '{parameter name}'. |
9007 | A 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. |
9008 | A payment option of payment group "Banks" is used with Virtual payment provider, 'criteria' request parameters with names "bankAccount" and "bankCode" must be provided. |
9009 | Virtual payment provider is used, 'criteria' request parameter with name "carrierNumber" must be provided. |
9010 | The '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). |
9011 | A 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. |
9012 | Duplicated 'name' field values of 'criteria' exist. |
9013 | The 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). |
9014 | For Third Party Provider's requests of this API method 'accno' must belong to an e-wallet user. |
9015 | The requested URL resource does not support the provided HTTP request method. |
9017 | Either '{the first parameter name}' or '{the second parameter name}' parameter must be provided. |
9018 | A payment option of payment group "Cards" is used with Virtual payment provider, 'criteria' request parameter with name "storedPaymentOptionReference" must be provided. |
9019 | Financial operations between CPSP and non-CPSP merchants are prohibited. |
9020 | Financial operations between E-Wallet users and CPSP merchants are prohibited. |
9998 | Request cancelled because of internal time-out. |
9999 | Request cancelled or timed-out. |
'Create Account' and 'Update Account Information' Response Codes | |
0101 | 'externalAccountReference' already in use. |
0102 | 'loginID' already in use. |
0103 | Specified 'accountApplicationFlowCode' is not applicable for an E-Wallet User Account. |
0104 | Cannot use an email address as 'loginID'. |
0105 | The user has not achieved the minimum allowed age. |
0106 | Unknown 'accountApplicationFlowCode'. |
0107 | Specified 'accountApplicationFlowCode' is inactive. |
0108 | Password does not comply to the password policy: '{password policy description}'. |
0109 | Account currency specified by 'currCode' is not allowed for user boarding. |
0110 | 'externalAccountReference' must be specified. |
0111 | 'externalAccountReference' must not be specified. |
0130 | Invalid '{parameter name}' value. |
0131 | Invalid 'timeZone' value. |
0132 | A business user field is provided to a non-business user. |
0133 | On account {"creation"||"update"} the 'externalAccountReference' may not be empty string. |
0134 | The combination of KYC fields is not unique for the program. |
0135 | Unknown 'accTypeCode'. |
0136 | Specified 'accTypeCode' is not allowed for accounts. |
0137 | Specified 'accTypeCode' does not correspond to E-Wallet User Category. |
0138 | Compliance Check failed, the Account cannot be created. |
0139 | Account application in processing due to compliance check. |
0140 | Specified 'accTypeCode' is not active. |
0141 | Account has not been created/updated: debtor is not maintained. |
0142 | Specified 'userAgreementReference' is not found for the Program. |
0143 | Specified 'userAgreementReference' is expired or not valid yet. |
0144 | User agreement text of the account is not valid. |
0145 | User agreement text of the account owning the specified 'storedPaymentOptionReference' is not valid. |
0146 | Account application in processing due to fraud monitoring. |
0147 | The expiration date of the identity document must not be in the past. |
'Change Status' Response Codes | |
0120 | Account already in the desired status. |
0121 | Cannot change status to "Closed" or "Rejected". |
0122 | Cannot activate the user account, because the corresponding program account is inactive. |
0123 | Cannot 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 | |
0179 | Transaction found by the specified 'uniqueReference' has a currency different from the load currency. |
0180 | Account load limit exceeded. |
0181 | 'loadAmount' should be greater than 0.00. |
0182 | Program load limit exceeded. |
0183 | 'loadAmount' value exceeds the 'presentationAmount' of the transaction found by the specified 'uniqueReference'. |
0184 | Cannot add a "Load Account" transaction to a group containing a "Payment" transaction. |
0185 | Transaction 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. |
0186 | Current 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. |
0189 | Transaction found by the specified 'uniqueReference' is neither in captured status, nor in settled status. |
'Unload Account' Response Codes | |
0190 | Account unload limit is exceeded. |
0191 | 'unloadAmount' should be greater than 0.00. |
0192 | Account has insufficient funds: {account number}. |
0194 | Specified 'paymentOptionCode' is not available for unloading this account. |
0195 | Program unload limit exceeded. |
'Init Authorize' Response Codes | |
0223 | Criteria item with name = "redirectUrl" must be provided and its value must not be empty. |
0224 | Provided stored payment option must belong to payment group "Cards". |
0225 | Specified 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. |
0227 | SCA 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. |
0233 | Transaction found by the specified 'uniqueReference' has a currency different from the capture currency. |
0234 | Transaction 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 | |
0240 | Cancelling is not supported for the used payment option. |
0241 | Cancellation period for the selected transaction has exceeded. |
'KC-Refund' and 'Refund' Response Codes | |
0250 | Payment status is different from 'Captured' or 'Settled'. |
0251 | A refund, a chargeback or a reject was performed for the referenced transaction. |
0252 | Transaction specified by 'uniqueReference' must have transaction type category "Load Account" or "Payment". |
0253 | Account 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}. |
0256 | Refund is not supported for the used payment option. |
0257 | Transaction found by the specified 'uniqueReference' has a dependent transaction of transaction type "KC-Block" and status "Authorized" or "Received". |
0258 | Transaction specified by the 'uniqueReference' is not refundable. |
0852 | Transaction 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. |
0855 | Transaction found by specified 'uniqueReference' is performed with "SofortÜberweisung" or "IDEAL" payment option, a valid IBAN is not available. |
0856 | Transaction found by specified 'uniqueReference' is performed with "SofortÜberweisung" or "IDEAL" payment option, active payment provider settings of type "SEPA" are not available. |
0857 | Transaction found by the specified 'uniqueReference' has a related order. |
0858 | A transaction specified by 'uniqueReference' is linked to a {"B2B Dealer Order"||"B2C Voucher Order"}, operation is denied. |
0859 | Only Single Transaction Refund can be applied for the specified transaction. |
0860 | Only Full Chain Refund can be applied for the specified transaction. |
0861 | Only 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". |
0865 | Amount of the refunding transaction must be equal to Amount of the refunded transaction. |
0866 | Only Single Transaction Refund or Full Chain Refund can be applied for the specified transaction. |
0867 | Amounts 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 | |
0260 | Specified user does not have an account in the specified program. |
'Get Applicable Limits' and 'Check Limits' Response Codes | |
0320 | Unsupported 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. |
0321 | Either '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 | |
0361 | If 'accno' is not specified 'emailAddress' must be passed with "{currently used payment provider}" payment provider. |
0362 | Compliance Check hit, transaction cannot be processed. |
0363 | 'presentationAmount' should be greater than 0.00. |
0366 | Actual billing address must be passed for PayPal tracking, if 'accno' is a merchant account. |
0367 | Actual 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. |
0369 | If 'accno' is not provided, 'useDifferentBillingAddress' must be true. |
0370 | The provided stored payment option is not associated with the provided 'accno'. |
0401 | Account 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. |
0477 | Provided 'paymentProviderResponse' does not match the provided 'authorizationToken'. |
0478 | Virtual payment provider is used, 'criteria' request parameter with name "paymentOptionCode" must be provided. |
0479 | Current deposit is performed via Prepayment and already has a dependent Payment transaction. |
0480 | Invalid 'authorizationToken'. |
0481 | "PayerID" must be provided under 'criteria' request parameter, if PayPal payment provider is used. |
0482 | Transaction is pending on payment provider. |
0483 | Pooling is not enabled for the account specified by 'accno'. |
0484 | 'programAccno' doesn't match the Account of the transaction found by {'uniqueReference' | 'depositReference'}. |
0485 | The 'accno' is not specified, 'emailAddress' is required. |
0486 | Neither 'accno' nor 'depositReference' are provided. |
0487 | Payee is undefined when the add money beneficiary exists. |
0488 | Status of transaction specified by 'depositReference' is different from "Captured" or "Settled". |
0489 | Transaction found by the specified 'depositReference' already has a dependent transaction having "Payment" transaction type category. |
0490 | Payee differs from the add money beneficiary. |
0491 | Unsupported 'paymentBrand' in payment provider response. |
0493 | {'merchantAccno' || 'accno'} is specified as External Account Reference, the {'merchantProgramCode' || 'programCode'} is required. |
0494 | Payment option was not defined for "Init Authorize". Payment option received from the payment provider must belong to payment group "Cards". |
0495 | Storing a payment option was selected by the user during payment data input. This is forbidden for merchant accounts. |
0496 | Payment option returned by the payment provider does not match the payment option specified in the {"Init Authorize" || "Init Add Stored Payment Option"} request. |
0497 | The specified 'accno' must have an unexpired default stored payment option. |
0498 | The 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. |
0500 | For 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 | |
0018 | The user with the specified 'userId' and 'password' must exist for the WebAPI Portal and must not be locked. |
0019 | The user with the specified 'userId' must be active. |
0041 | The password of the user with the specified 'userId' must not be expired. |
2FA Response Codes | |
0550 | The 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)}. |
0551 | The user Portal does not support Two-Factor Authentication. |
0552 | The One-Time Password request is blocked due to too many requests. |
0553 | The repeated One-Time Password request is blocked due to too many requests. |
0554 | The Mobile Phone, required to configure 2FA, is not specified for the user or is not valid. |
0555 | The configuration of 2FA has not been completed. |
0556 | Confirmation 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. |
0559 | An incorrect 'oneTimePassword' is provided for {" Max Unsuccessful 2FA Attempts" setting value} times. Corresponding user has been locked. |
0560 | Confirmation with a verification code is required. 'twoFASetupCode' must be provided (use the value sent to the user email address). |
0561 | 'twoFASetupCode' is incorrect. |
0562 | An incorrect 'twoFASetupCode' is provided for {" Max Unsuccessful 2FA Attempts" setting value} times. Corresponding user has been locked. |
0563 | The verification code which has been sent to the user email address is expired. |
0564 | The one-time password which has been sent to the user via SMS is expired. |
0571 | An error occurred during external call to SMS provider. |
0572 | An error occurred while sending an SMS by an external provider. |
0573 | The 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. |
0621 | Specified 'paymentProvider' is not applicable for an E-Wallet User Account. |
0623 | An error occurred while registering a payment option with an external provider. |
0625 | The '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. |
0628 | Pooled transactions exist for the specified account, a default stored payment option cannot be deleted. |
0630 | If different billing address is used 'emailAddress' must be passed with "{Payment Provider Name}" payment provider. |
0631 | The specified 'storedPaymentOptionReference' is used for payout in the deferred account closing and cannot be deleted. |
0632 | The '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". |
0634 | Another account has stored payment option with the same reference and currently used payment provider. |
0635 | Only "EUR" can be used as currency with provided "{currently used payment provider}" payment provider. |
0636 | Payment option with the same 'storedPaymentOptionReference' has already been added to the account: {accno}. |
0638 | Virtual 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. |
0640 | Invalid 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. |
0644 | No stored payment option is found by the provided 'authorizationToken'. |
0645 | Status 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. |
0662 | Verification code is incorrect. |
0663 | Verification code is incorrect. And the amount of allowed verification attempts is exceeded. Stored payment option returns to the Unverified status. |
0665 | Specified card is expired. |
0666 | The specified 'accno' and 'programAccno' have different currencies. |
0669 | 'storedPaymentOptionReference' is not in "In Verification" status. |
'Close Account' Related Response Codes | |
0830 | Account application is in an incorrect status for a transition to the 'Closed' status. |
0831 | There is no balance to be paid out to the specified stored payment option. |
0832 | The 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. |
0834 | The owner of the account corresponding to the provided 'accno' already has a request to delete the sensitive data. |
'Get SEPA Mandate' Related Response Codes | |
0950 | A SEPA mandate can be only downloaded for the "Bank Account SEPA" payment options. |
0951 | Mandate 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 | |
1090 | Compliance provider failed to perform the operation. |
1091 | KontoCloud payment option code cannot be mapped to the provider payment option code. |
1092 | Risk Check provider failed to perform the operation. |
1094 | The request must contain either 'storedPaymentOptionReference' or 'useDifferentBillingAddress' = true, 'customerFullName', 'addr1', 'city', 'postCode' and 'countryCode' or both. |
'Perform Address Check' Response Codes | |
1130 | Address check provider failed to perform the operation. |
'VAT ID' Response Codes | |
1140 | VAT ID provider failed to perform the operation. |
'Perform Address Auto Completion' Response Codes | |
1210 | Address auto completion provider failed to perform the operation. |
'Perform Compliance Callback' Response Codes | |
1220 | Specified compliance results not found. |
1221 | Specified 'archiveId' does not support manual review. |
1222 | Specified compliance result corresponds to a closed or rejected account. |
1223 | Manual Review Result cannot be set for inspected compliance check. |
1224 | Manual Review Result is already defined for the compliance result found by specified 'archiveId'. |
'External Id'Response Codes | |
1250 | Specified Program's ID Provider not configured. |
1251 | Provided UUID is already in use in the combination with the provided ID Provider in the specified Program. |
1252 | Provided UUID not found for the provided 'accno' in the specified Program. |
1253 | Only one UUID of the external ID Provider can be added for the user. |
1254 | Last user's UUID cannot be deleted. |
'Get User Agreement Text' and 'Get Current User Agreement Text' Response Codes | |
1260 | Current user agreement version is not found. |
1261 | Current user agreement text is not found. |
1262 | Either 'userAgreementReference' or 'culture' must be specified. |
'KC-Block', 'KC-Unblock' Response Codes | |
1330 | If 'refundAmount' is true, the transaction defined by 'uniqueReference' must have a dependent deposit transaction. |
1331 | Transaction found by the specified 'uniqueReference' is not a "KC-Block" transaction. |
1332 | Transaction found by the specified 'depositReference' already has a dependent transaction of transaction type category "Payment". |
1333 | Transaction found by 'depositReference' does not have associated stored payment option. |
Response Codes for headers validation | |
2010 | If the resolved program payment provider settings refers to "PaymentsOS" payment provider, 'X-Ip-Address' header must be specified. |
Code | Description |
ASC | Ascending |
DESC | Descending |
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 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 |
Code | Description |
AUTHORIZED | Authorized |
CANCELLED | Cancelled |
CAPINPROGR | Capture In Progress |
CAPTURED | Captured |
EXPIRED | Expired |
RECEIVED | Received |
SETTLED | Settled |
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 |
Code | Description |
1 | Total Transaction |
2 | Total Value |
Code | Description |
JSON | JSON format of the agreement |
PDF format of the agreement |
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. |
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. |
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, delivered via "Debtor Error Callback" Notifications, if Enabled.
Note: Only Errors with Type "E" for "Error" would require an action (retry, ask support, etc).
Type | Description |
---|---|
E | Error |
W | Warning |
I | Info |
Code | Type | Description |
---|---|---|
0001 | E | External Error: Company Code is not implemented |
0002 | I | Fill log table |
0003 | I | the external Customer: & is in mode: & test flag: & |
0004 | E | Error generation UUID |
0005 | E | No customizing set was found! / KSI / CN_WEB_C maintain! |
0006 | I | The customizing set: & is used. |
0007 | W | Customizing in table & is missing. |
0008 | I | The incoming company code & was converted to & |
0009 | I | Customizing for table & is processed |
0010 | I | recurring customer recursively and storing values that are enriched with customizing. |
0011 | I | company code &1 was delivered by the caller |
0012 | I | value &1 for the field &2 comes from the customizing |
0013 | I | comparative value &1 was found and replaced by the customizing value &1 |
0014 | I | for the field &1 the user exit &2 will processed |
0015 | I | BAPI call |
0016 | E | Synchronization customer -> business partner is not active |
0017 | E | Enter an existing customer |
0018 | E | Customer &1 don’t exist! Enter an existing customer number! |
0019 | W | Customer &1 is already assigned to business partner &2 |
0020 | I | Business partner &1 has been assigned to customer &2 |
0021 | E | Customer &1 cannot be assigned to a business partner |
0022 | E | No business partner could be created for customer &1 |
0023 | I | The changes were called via the SourceType: & |
0024 | E | 'Customer is not filled - Business partner can not be modified.' |
0025 | I | Update --> mapping debtor &1 to existing business partner |
0026 | E | Error mapping existing business partner |
0027 | I | Mapping succeeded, try saving business partners |
0028 | I | Test run has ended! |
0029 | E | *** ERROR *** The customer could not be created / modified *** ERROR |
0029 | E | Please enter the customers language in the KVERM field - 0039 ; *** ERROR *** The customer could not be created / modified *** ERROR *** - 0029 ; |
0029 | E | Der Geschäftspartner XXX ist zur Zeit von Ihnen gesperrt - 9999 ; *** ERROR *** The customer could not be created / modified *** ERROR *** - 0029 ; |
0029 | E | Das Konto XXX wird zur Zeit vom Benutzer YYY bearbeitet. - 9999 ; *** ERROR *** The customer could not be created / modified *** ERROR *** - 0029 ; |
0029 | E | Steuernummerntyp XXX ist nicht vorhanden - 9999 ; *** ERROR *** The customer could not be created / modified *** ERROR *** - 0029 ; |
0029 | E | Bei interner Nummernvergabe darf keine Debitorennummer übergeben werden - 9999 ; *** ERROR *** The customer could not be created / modified *** ERROR *** - 0029 ; |
0029 | E | Customer number range is not valid - 0034 ; *** ERROR *** The customer could not be created / modified *** ERROR *** - 0029 ; |
0029 | E | Eintrag 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 ; |
0029 | E | Für Land XX ist die Region YY nicht definiert - 9999 ; *** ERROR *** The customer could not be created / modified *** ERROR *** - 0029 ; |
0029 | E | Geben Sie eine Identifikationsart oder einen Identifikationstyp an - 9999 ; *** ERROR *** The customer could not be created / modified *** ERROR *** - 0029 ; |
0029 | E | Postleitzahl ##### darf an Stelle 1 bis 5 nur Ziffern enthalten - 9999 ; *** ERROR *** The customer could not be created / modified *** ERROR *** - 0029 ; |
0029 | E | Postleitzahl 0000 muss die Länge 5 oder 10 haben - 9999 ; *** ERROR *** The customer could not be created / modified *** ERROR *** - 0029 ; |
0029 | E | Tax code 2 ist länger als 11 Zeichen - 9999 ; *** ERROR *** The customer could not be created / modified *** ERROR *** - 0029 ; |
0032 | E | No name was entered for the transferred customer |
0033 | I | The user exit &1 will processed |
0034 | E | Customer number range is not valid |
0035 | E | Data inconsistency between KNA1, BUT000 and /KSI/CN_T_MAPDEB |
0036 | E | Field Kunnr max. 10 digits |
0037 | E | customer number was not given |
0038 | E | Bank number and bank account number cannot be generated |
0039 | E | Please enter the customer's language in the KVERM field |
0040 | E | The given language key &1 does not exist |
9999 | E | Error: Others |
Code | Type | Description |
---|---|---|
0000 | E | External Error: wrong / missing Source Type |
0001 | E | External Error: Sales Organization missing |
0002 | E | External Error: Sales Organization not found |
0003 | E | External Error: Company Code not found |
0004 | E | External Error: Posting Period is already closed |
0005 | E | External Error: Customer ID missing |
0006 | E | External Error: SAP Customer not found |
0007 | E | Internal Error: Order Creation (BAPI) |
0008 | E | Internal Error: Invoice Creation (BAPI) |
0009 | E | Internal Error: FI DOC Posting (BAPI) |
0010 | E | Error: Others |
0011 | E | Internal Error: Interface Customizing not Found |
0012 | E | External Error: wrong / missing Document Type |
0013 | E | External Error: Billing Date Missing |
0014 | E | External Error: Non-tax condition total amount cannot be 0,00 |
0015 | E | External Error: Postal Code (additional address) |
9000 | E | External Error: Tax Error |
9000 | E | External Error: Tax Rate (SeqNr) and the corresponding MWST Condition Amount (CondValue) do not match |
9001 | E | External Error: Wrong Tax Percentage |
9002 | E | External Error: VIN Missing |
9003 | E | External Error: Model Code Missing |
9004 | E | External Error: reference Sales Organization missing (B2B) |
9005 | E | External Error: Discount Percentage missing |
9007 | E | External Error: Standing Order / Period of Time missing |
9008 | E | Internal Error: Tax Customizing Missing |
9009 | E | External Error: for Tax SeqNr 0%, condition amount 0,00 expected |
9009 | E | External Error: Voucher Code missing! |
9010 | E | External Error: Position Text Missing |
9011 | E | Internal Error: FI Posting Error |
9012 | E | Internal Error: FI follow-up Postings save failure |
9013 | E | External Error: No Country found (Field KVERM) |
9014 | E | External Error: corresponding B2C Invoice missing (for B2B Invoice) |
9015 | E | External Error: corresponding B2C Invoice missing (for B2C Credit Memo) |
9016 | E | External Error: corresponding B2B Credit Memo missing (for B2C Credit Memo) |
9017 | E | External Error: corresponding B2B Invoice missing (for B2B Credit Memo) |
9018 | E | External Error: EEA Company Tax Error |
9019 | E | External Error: for Tax SeqNr 0%, condition amount not equal 0,00 expected |
9020 | E | External Error: Tax Error (Credit Memo tax rate must be equal to the tax rate in the corresponding invoice) |
9999 | E | Error: Others |
Code | Type | Description |
---|---|---|
0001 | E | External Error: Company Code &1 is not implemented |
0002 | E | Duplicate key! PAYID: & ORDERID: & PROVID: & |
0003 | E | External Error: Not existing debtor |
0004 | E | External Error: Not existing OrderID |
0005 | I | The incoming timestamp: & was successfully converted to: &. |
0006 | E | Conversion of the incoming timestamp: & failed |
0007 | E | One of the values is missing: PAYID: & ORDERID: & PROVID: & |
0008 | I | Payment information successfully created! |
0009 | E | An unexpected error occurred while saving. |
0010 | E | External customer number is missing |
0011 | E | There is no internal to the external customer number. |
0012 | E | Payment method '&1' or payment provider '&2' is not in customizing. |
0013 | E | Payment UUID could not be determined |
Code | Type | Description |
---|---|---|
0001 | E | External Error: Sales Organization missing |
0002 | E | External Error: Sales Organization not found |
0003 | E | External Error: FI Document ID missing |
0004 | E | Internal Error: Archive Record ID not found |