Maintenance Work Notice!

We will carry out maintenance work on this documentation on Tuesday, 15.06.2021 between 3 pm and 4 pm CEST. Thank you for your understanding.

Page tree

Search

Skip to end of metadata
Go to start of metadata


About Consors

General information about Consors


Logo

Info

Consors Finanz is a brand of international BNP Paribas Group and belongs to the leading consumer-finance-providers in Germany. Company's focus is consumer lending as well as sales financing within retail sector and online commerce. The new eFinancing application allows customers to enter online credit agreements faster and easier, because the application process was optimized for maximum user-friendliness.

Financing plans between 6 and 40 month can be mapped through the credit line of a Consors Finanz Mastercard. With a button the customer possibly can select from longer credit periods. Then the installment plan will be processed by an installment credit.

TypePayments by Invoice and Installments EN


Further information can be found on the webpage of Consors (https://www.consorsbank.de/home).

 

 

Process flow chart


Consors Finanz process flow



Paygate interface

Definitions

Data formats

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)


Abbreviations

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


Notice: Please note that the names of parameters can be returned in upper or lower case.


Create Consors authorisation

Before You are forwarded to Consors Finanz a Consors authorizatin must be created. For that purpose please use the following URL:


Notice: For security reasons, Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

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

TransID

ans..64

M

Merchant transaction number, which must be unique

RefNr

ans..30

O

Unique reference number

Amount

n..10

M

Total order amount in the smallest currency unit (e.g. EUR Cent) incl. rebates and taxes (minimum amount: 100€).

Currency

a3

M

Currency, three digits DIN / ISO 4217 Only EUR permissible.

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

OrderDesc

ans..768

M

Description of goods and prices etc.

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.

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.

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 UserData parameter instead.

UserData

ans..1024

O

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

ReqID

ans..32

O

To avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

bdSalutationa4OSalutation
bdFirstNameans..23OFirst name
bdLastNameans..23OLast name
bdDateofBirthans10ODate of birth in the format DD.MM.YYYY
bdPhonea..15OTtelephone number
bdMobileNra..15OMobile telephone number
bdEmailans..40OEmail address
bdStreetans..32OStreet name (also possible with street number)
bdStreetNrans..32OStreet number
bdZipn5OPostcode
bdCityans..23OTown/city
HeaderLogoans..127O

In order to display your logo during financing process submit the URL of an image file with your logo which is stored on your server (open without access protection). The image file should have png or jpg format. For an optimal presentation use a logo in landscape format with a ratio of 6:1 (width x heigth) scaling png; or about 150x25 pixels (jpg). Either Headerlogo OR BrandName can be used.

BrandNameans..15O

When using this parameter your shop name will be displayed during application process. In order to avoid shortening of shop name („…“), please sumbit only about 1x 10 chars (or. 2x 10 chars with blank space between = line break). Either Headerlogo OR BrandName can be used.

Durationa..2O

The number of month should be submitted only if a default value for the selection of possible number of month is wanted. In any case the customer can modify this default value.

FirstAmountn..10O

A down payment should be submitted only if this is really possible within the shop. The net credit amount is calculated from credit amount minus down payment. If the net credit amount is smaller than the minimum amount configured the customer will be presented an error page.

Down payment for the order in the smallest currency unit (e.g. EUR Cent)

Campaigna1O

Values: 1, 2 or 3

1: All available duractions are displayed, but ONLY the submitted duration with the special offer credit conditions; e.g. for „24“ only the duration 24 month with 0%. All other durations use the conditions for installment credit.

2: All available durations smaller or equal the submitted duration will be displayed with special offer credit conditions; e.g. for „18“ only the durations 6, 12, 18 month aer with 0%. All other durations above use the conditions for installment credit.

3: Only the submitted duration will be displayed with special offer credit conditions. No other durations are on display.

Terma..2ODuration for Campaign

Plain

ans..50

O

A value to be set by the merchant to return some information unencrypted, e.g. the MID

Custom

ans..1024

O

The merchant can submit several values separated by | which are returned unencrypted and separated by &.

Custom=session=123|id=456 will change in the answer to Session=123&id=456

Parameters for payments with Consors


The following table describes the result parameters that the Paygate transmits to your URLSuccess, URLFailure or URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:

Parameter

Format

CND

Description

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.

XID

an32

M

ID for all single transactions for one payment assigned by Paygate

TransID

ans..64

M

Merchant’s transaction number

RefNr

ans..30

O

Merchant’s unique reference number

Status

a..30

M

AUTHORIZE_REQUEST or FAILED

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

n8

M

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

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

UserData

ans..1024

O

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

OrderDescans..768OBasket

TransactionID

an..20

M

Contract number with Consors

Durationn..2MDuration choosen by customer
InstallmentAmountn..10MFinancing amount in the smallest currency unit (e.g. EUR Cent)

Plain

ans..50

O

A value to be set by the merchant to return some information unencrypted, e.g. the MID

Custom

ans..1024

O

The merchant can submit several values separated by | which are returned unencrypted and separated by &.

Custom=session=123|id=456 will change in the answer to Session=123&id=456

Return parameters for URLSuccess, URLFailure and URLNotify with Consors



Capture

Captures are possible via a Server-to-Server connection. With this call you can process only full captures, a partial capture ist not possible. In order to perform a capture for Consors via a Server-to-Server connection, please use the following URL:


Notice: For security reasons, Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

Parameter

Format

CND

Beschreibung

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

TransID

an..20

M

ID assigned by Merchant for the payment process to be captured

RefNr

ans..30

O

Merchant’s unique reference number

Amount

n..10

M

Total order amount in the smallest currency unit (e.g. EUR Cent) incl. rebates and taxes

Currency

a..3

M

Currency, three digits DIN / ISO 4217 Only EUR permissible.

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

UserData

ans..1024

O

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

ReqIDans..32OTo avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

Parameters for captures with Consors


The following table describes the Paygate response parameters:

Parameter

Format

CND

Beschreibung

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

XID

an32

M

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

TransID

an..20

M

Merchant’s transaction number

Status

a..50

M

OK or FAILED

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

n8

M

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

RefNr

ans..30

O

Merchant’s unique reference number

UserData

ans..1024

O

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

Response parameters for captures of Consors payments



Reversal

Reversals are possible via a Server-to-Server connection. If a Capture is still not done, with this call you can reverse the complete authorisation amount.  In order to reverse a transaction with Consors, please use the following URL:


Notice: For security reasons, Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

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 to be reversed

TransID

ans..64

M

Merchant ID for the identification of the payment process to be reversed

RefNrans..30OMerchant’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).

Currency

a..3

M

Currency code, three digits DIN / ISO 4217. Only MYR permissible.

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

UserDataans..1024OIf specified at request, Paygate forwards the parameter with the payment result to the shop
ReqIDans..32OTo avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

Parameters for reversals of Consors payments


The following table describes the Paygate response parameters:

Parameter

Format

CND

Description

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

XID

an32

M

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

TransID

ans..64

M

Merchant’s transaction number

Status

a..30

M

OK or FAILED

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

n8

M

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

RefNr

ans..30

O

Merchant’s unique reference number

UserDataans..1024OIf specified at request, Paygate forwards the parameter with the payment result to the shop

Response parameters for reversals of Consors payments