easyCredit Ratenkauf

Logo

Info

EasyCredit ratenkauf is a provider of hire purchase and purchase on invoice in Germany. After the customer is forwarded to easyCredit they undertake the calculation of all possible installments.

Type

Payments by Invoice and Installments

Format

Description

a

alphabetical

as

alphabetical with special characters

n

numeric

an

alphanumeric

ans

alphanumeric with special characters

ns

numeric with special characters

bool

boolean expression (true or false)

3

fixed length with 3 digits/characters

..3

variable length with maximum 3 digits/characters

enum

enumeration of allowed values

dttm

ISODateTime (YYYY-MM-DDThh:mm:ss)

Abbreviation

Description

Comment

CND

condition

M

mandatory

If a parameter is mandatory, then it must be present

O

optional

If a parameter is optional, then it can be present, but it is not required

C

conditional

If a parameter is conditional, then there is a conditional rule which specifies whether it is mandatory or optional

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

TransID

ans..64

M

TransactionID provided by you which should be unique for each payment

refnr

ans..30

O

Merchant’s unique reference number

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

The minimum and maximal value for easyCredit is 200-5000€.

Currency

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:

• HMAC Authentication (Request)

• HMAC Authentication (Notify)

Term

n..2

O

Duration in months. If applicable here the duration can be preset with a value the customer has already selected for the example calculation.

EventToken

enum

M

Defines the request to be made at easyCredit:

<INT> for initialising the transaction

URLSuccess

ans..256

M

Complete URL which calls up Paygate if payment has been successful. The URL may be called up only via port 443. This URL may not contain parameters: In order to exchange values between Paygate and shop, please use the parameter UserData.

Common notes:

• We recommend to use parameter "response=encrypt" to get an encrypted response by Paygate

• However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

URLFailure

ans..256

M

Complete URL which calls up Paygate if payment has been unsuccessful. The URL may be called up only via port 443. This URL may not contain parameters: In order to exchange values between Paygate and shop, please use the parameter UserData.

Common notes:

• We recommend to use parameter "response=encrypt" to get an encrypted response by Paygate

• However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

Response

a7

O

Status response sent by Paygate to URLSuccess and URLFailure, should be encrypted. For this purpose, transmit Response=encrypt parameter.

URLNotify

ans..256

M

Complete URL which Paygate calls up in order to notify the shop about the payment result. The URL may be called up only via port 443. It may not contain parameters: Use the UserDataparameter instead.

Common notes:

• Before follow-up actions (capture / credit / reversal) are carried out on an existing transaction, the first Notify must have been answered by the shop.

• Fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

UserData

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

Personal details

Notice: If personal details are submitted then this group must be transferred completely.

Salutation

a..15

C

Salutation MR or MRS

FirstName

ans..50

C

First name

LastName

ans..50

C

Last name

DateOfBirth

dttm

C

Date of birth in the format YYYY-MM-DD

Occupation data

Notice: If occupation data are submitted then this group must be transferred completely.

Employment

enum

C

Occupation of the customer. Possible entries are:

EMPLOYEE

EMPLOYEE_PUBLIC_SECTOR

WORKER

CIVIL_SERVANT

RETIREE

SELF_EMPLOYED

UNEMPLOYED

OTHER

MonthlyNetIncome

n..12

C

Monthly net income of the customer in the smallest currency unit (e.g. EUR Cent).

Invoicing address

Notice: If an invoicing address is given, then this must be transferred completely.

bdFirstName

ans..50

M

First name in invoicing address

bdLastName

ans..50

M

Last name in invoicing address

bdStreet

a..50

C

Street

bdStreetNr

ans..5

C

Street number

bdAddressAddition

a..50

C

Address c/o

bdZip

n5

C

Postcode

bdCity

ans..50

C

Town

bdCountryCode

a2

C

Country code for the invoicing address, 2 characters according to ISO 3166 Presently only DE is allowed.

Delivery address

Notice: If an delivery address is given, then this must be transferred completely.

PackingStation

an..30

O

Packing station

sdFirstName

ans..50

M

First name in delivery address

sdLastName

ans..50

M

Last name in delivery address

sdStreet

a..50

C

Street

sdStreetNr

ans..5

C

Street number

sdAddressAddition

a..50

C

Address c/o

sdZip

n5

C

Postcode

sdCity

ans..50

C

Town

sdCountryCode

a2

C

Country code for the delivery address, 2 characters according to ISO 3166 Presently only DE is allowed.

Contact data

Email

ans..50

M

Email address of the customer

MobileNr

ans..50

O

Customer’s mobile telephone number

Bank data

IBAN

ans..34

O

Customer's IBAN

BIC

an..11

O

Customer’s BIC

Further customer data

Phone

ans..15

O

Customer’s phone number

Title

enum

O

Title of the customer. Possible entries are:

<PROFDR> for Prof. Dr.

<DR> for Dr.

<PROF> for Prof.

<DRDR> for Dr. Dr.

MaidenName

ans..50

O

Maiden name

PlaceOfBirth

ans..50

O

Place of birth

Risk-relevant data

CustomerStatus

enum

O

Customer's status at the webshop. Possible entries are:

<NEUKUNDE>

<BESTANDSKUNDE>

<PREMIUMKUNDE>

CustomerSince

dttm

O

Start of customer relation at the webshop in the format YYYY-MM-DD

CustomerLoggedIn

enum

O

Flag if order is made from a registered customer with login or from a guest:

<YES> Customer was logged in

<NO> Customer has ordered as a guest

NumberArticles

n..5

O

Number or articles within basket

NumberOrders

n..10

O

Number of previous orders within the webshop

NegativePaymentInfo

enum

O

Negative payment information about the customer. Possible entries are:

<KEINE_ZAHLUNGSSTOERUNGEN>

<ZAHLUNGSVERZOEGERUNG>

<ZAHLUNGSAUSFALL>

<KEINE_INFORMATION>

RiskArticles

enum

O

Merchant's assessment if there is a solvency crucial article within the basket. Possible entries are:

<YES> There is a solvency crucial article within the basket

<NO> There is no solvency crucial article within the basket

Article list

ArticleList

ans..1024

O

Basket information (incl. article numbers) for the articles ordered with hire purchase. These date can have some influence on the credit decision. The article list must be created in JSON format.

1
{
2
  "shoppingCartInformation": [
3
      {
4
        "productName": "Washing Machine",
5
        "quantity": 1,
6
        "price": 599.95,
7
        "manufacturer": "Siemens",
8
        "productCategory": "Household Appliances",
9
        "articleNumber": [
10
          {
11
            "numberType": "GTIN",
12
            "number": 1111111
13
          }
14
        ]
15
      }
16
    ]
17
}

Afterwards the article list created in JSON format must be Base64 encoded.

mid

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

TransID

ans..64

M

TransactionID provided by you which should be unique for each payment

refnr

ans..30

O

Merchant’s unique reference number

Status

a..50

M

AUTHORIZE_REQUEST (URLSuccess) and FAILED (URLFailure)

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

an8

M

Error code according to Paygate Response Codes (A4 Error codes)

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:

• HMAC Authentication (Request)

• HMAC Authentication (Notify)

UserData

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

CodeExt

ans..1024

O

Error code from easyCredit ratenkauf, if agreed with Computop Helpdesk

ErrorText

ans..1024

O

Error text from easyCredit ratenkauf, if agreed with Computop Helpdesk

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

TransID

ans..64

M

TransactionID provided by you which should be unique for each payment

refnr

ans..30

O

Merchant’s unique reference number

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

The minimum and maximal value for easyCredit is 200-5000€.

Currency

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:

• HMAC Authentication (Request)

• HMAC Authentication (Notify)

EventToken

enum

M

Defines the request to be made at easyCredit:

<GET> With this EventToken all the installment information will be retrieved.

mid

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

TransID

ans..64

M

TransactionID provided by you which should be unique for each payment

refnr

ans..30

O

Merchant’s unique reference number

Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

an8

M

Error code according to Paygate Response Codes (A4 Error codes)

Financing

ans..1024

O

Contains all the necessary data for a previous initialization. They are returned in JSON format and Base64 encoded.

Example JSON format (already Base64 decoded):

1
{
2
  "decision": {
3
    "transactionId": "EWZEN7",
4
    "deviceIdentToken": "dffedf20-21df-11ec-9621-0242ac130002",
5
    "orderValue": 2614.79,
6
    "interest": 234.56,
7
    "nominalInterest": 8.64,
8
    "effectiveInterest": 8.99,
9
    "merchantSpecificInterest": 8.99,
10
    "totalValue": 2849.35,
11
    "decisionOutcome": "POSITIVE",
12
    "numberOfInstallments": 9,
13
    "minNumberOfInstallments": 2,
14
    "maxNumberOfInstallments": 60,
15
    "installment": 302,
16
    "lastInstallment": 293.58,
17
    "firstInstallmentDate": "2023-03-20",
18
    "lastInstallmentDate": "2023-03-20",
19
    "amortizationPlanText": "string",
20
    "urlPreContractualInformation": "string",
21
    "installmentPlans": [
22
      {
23
        "totalValuePlan": 0,
24
        "interests": {
25
          "effectiveInterest": 8.99,
26
          "nominalInterest": 8.64,
27
          "interest": 234.56
28
        },
29
        "paymentPlan": {
30
          "numberOfInstallments": 9,
31
          "firstInstallmentDate": "2023-03-20",
32
          "lastInstallmentDate": "2023-03-20",
33
          "installment": 302,
34
          "lastInstallment": 293.58
35
        }
36
      }
37
    ],
38
    "mtan": {
39
      "required": true,
40
      "status": "PENDING",
41
      "remainingAttempts": 2,
42
      "successful": true,
43
      "mobilePhoneNumberInvalid": true,
44
      "skipMobilePhoneNumberValidation": true
45
    },
46
    "bankAccountCheck": {
47
      "required": false,
48
      "successful": false
49
    }
50
  },
51
  "transaction": {
52
    "financingTerm": 6,
53
    "orderDetails": {
54
      "orderValue": 2614.79,
55
      "orderId": "A1ZU560",
56
      "numberOfProductsInShoppingCart": 1,
57
      "invoiceAddress": {
58
        "address": "Beuthener Str. 25",
59
        "additionalAddressInformation": "3 OG",
60
        "zip": "90471",
61
        "city": "Nürnberg",
62
        "country": "DE",
63
        "firstName": "Ralf",
64
        "lastName": "Ratenkauf"
65
      },
66
      "shippingAddress": {
67
        "address": "Beuthener Str. 25",
68
        "additionalAddressInformation": "3 OG",
69
        "zip": "90471",
70
        "city": "Nürnberg",
71
        "country": "DE",
72
        "firstName": "Ralf",
73
        "lastName": "Ratenkauf",
74
        "packageStation": true
75
      },
76
      "shoppingCartInformation": [
77
        {
78
          "productName": "Washing Machine",
79
          "quantity": 1,
80
          "price": 599.95,
81
          "manufacturer": "Siemens",
82
          "productCategory": "Household Appliances",
83
          "articleNumber": [
84
            {
85
              "numberType": "GTIN",
86
              "number": 1111111
87
            }
88
          ]
89
        }
90
      ]
91
    },
92
    "shopsystem": {
93
      "shopSystemManufacturer": "Shopware 5.5.10",
94
      "shopSystemModuleVersion": "1.6.3"
95
    },
96
    "customer": {
97
      "gender": "MR",
98
      "firstName": "Ralf",
99
      "lastName": "Ratenkauf",
100
      "birthDate": "1949-10-17",
101
      "birthName": "string",
102
      "birthPlace": "string",
103
      "title": "PROFDR",
104
      "contact": {
105
        "email": "test@test.de",
106
        "mobilePhoneNumber": "017186397426",
107
        "phoneNumber": "01771234567",
108
        "phoneNumbersConfirmed": false
109
      },
110
      "bank": {
111
        "iban": "DE06760320009210030015",
112
        "bic": "MARKDEFFXXX"
113
      },
114
      "employment": {
115
        "employmentType": "EMPLOYEE",
116
        "monthlyNetIncome": 3000
117
      },
118
      "companyName": ""
119
    },
120
    "customerRelationship": {
121
      "customerStatus": "EXISTING_CUSTOMER",
122
      "customerSince": "2007-10-10",
123
      "orderDoneWithLogin": false,
124
      "numberOfOrders": 3,
125
      "negativePaymentInformation": "NO_INFORMATION",
126
      "riskyItemsInShoppingCart": false,
127
      "logisticsServiceProvider": "Hermes"
128
    },
129
    "consent": {
130
      "sepaMandate": true,
131
      "advertisement": true,
132
      "dataProcessing": true,
133
      "consentToActInOnwnName": true
134
    },
135
    "redirectLinks": {
136
      "urlSuccess": "https://www.google.com/search?q=easycreditSuccess",
137
      "urlCancellation": "https://www.google.com/search?q=easycreditCanceled",
138
      "urlDenial": "https://www.google.com/search?q=easycreditDenied",
139
      "urlAuthorizationCallback": "https://www.google.com/search?=ratenkaufCallback"
140
    }
141
  },
142
  "status": "OPEN"
143
}

CodeExt

ans..1024

O

Error code from easyCredit ratenkauf, if agreed with Computop Helpdesk

ErrorText

ans..1024

O

Error text from easyCredit ratenkauf, if agreed with Computop Helpdesk

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

TransID

ans..64

M

TransactionID provided by you which should be unique for each payment

refnr

ans..30

O

Merchant’s unique reference number

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

The minimum and maximal value for easyCredit is 200-5000€.

Currency

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:

• HMAC Authentication (Request)

• HMAC Authentication (Notify)

EventToken

enum

M

Defines the request to be made at easyCredit:

<CON> Changes a transaction at easyCredit from PERMITTED to status CONFIRMED. The permission may not be older than 30 minutes and the previously requested easyCredit decision must be GREEN.

Date

dttm

O

Date of delivery of the sold services/goods in the format YYYY-MM-DD. Hence the delivery is automatically initiated together with the confirmation.

Notice: For automatic delivery execution the merchant must be configured accordingly at Computop. Please contact Computop Helpdesk in this case.

mid

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

TransID

ans..64

M

TransactionID provided by you which should be unique for each payment

refnr

ans..30

O

Merchant’s unique reference number

Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

an8

M

Error code according to Paygate Response Codes (A4 Error codes)

CodeExt

ans..1024

O

Error code from easyCredit ratenkauf, if agreed with Computop Helpdesk

ErrorText

ans..1024

O

Error text from easyCredit ratenkauf, if agreed with Computop Helpdesk

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

TransID

ans..64

M

TransactionID provided by you which should be unique for each payment

refnr

ans..30

O

Merchant’s unique reference number

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

The minimum and maximal value for easyCredit is 200-5000€.

Currency

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:

• HMAC Authentication (Request)

• HMAC Authentication (Notify)

Date

dttm

O

Date of delivery of the sold services/goods in the format YYYY-MM-DD. The delivery is initiated separately from the confirmation.

Notice: For manual delivery execution the merchant must be configured accordingly at Computop. This can be overridden also with the parameter Capture. Please contact Computop Helpdesk in this case.

Capture

an..6

OM

Determines the type and time of capture.

ReqId

ans..32

O

To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action.

Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly.

Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate.

mid

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

TransID

ans..64

M

TransactionID provided by you which should be unique for each payment

refnr

ans..30

O

Merchant’s unique reference number

Status

a..50

M

Request

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

an8

M

Error code according to Paygate Response Codes (A4 Error codes)

CodeExt

ans..1024

O

Error code from easyCredit ratenkauf, if agreed with Computop Helpdesk

ErrorText

ans..1024

O

Error text from easyCredit ratenkauf, if agreed with Computop Helpdesk

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

TransID

ans..64

M

TransactionID provided by you which should be unique for each payment

refnr

ans..30

O

Merchant’s unique reference number

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

The minimum and maximal value for easyCredit is 200-5000€.

Currency

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:

• HMAC Authentication (Request)

• HMAC Authentication (Notify)

Date

dttm

M

Date the merchant received the reversed transaction in the format YYYY-MM-DD

Reason

enum

M

Reason for the reversed transaction. Possible entries are:

<WIDERRUF_VOLLSTAENDIG>

<WIDERRUF_TEILWEISE>

<RUECKGABE_GARANTIE_GEWAEHRLEISTUNG>

<MINDERUNG_GARANTIE_GEWAEHRLEISTUNG>

ReqId

ans..32

O

To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action.

Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly.

Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate.

mid

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

TransID

ans..64

M

TransactionID provided by you which should be unique for each payment

refnr

ans..30

O

Merchant’s unique reference number

Status

a..50

M

Request

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

an8

M

Error code according to Paygate Response Codes (A4 Error codes)

CodeExt

ans..1024

O

Error code from easyCredit ratenkauf, if agreed with Computop Helpdesk

ErrorText

ans..1024

O

Error text from easyCredit ratenkauf, if agreed with Computop Helpdesk