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 Debtor Management Ideal

General information about Debtor Management Ideal

Computop Paygate offers together with a partner/third party service provider a complete debtor management system to merchants. Via Computop merchants can maintain debtor accounts and provide information about payment status of all payment methods to the service provider to ensure account checking and traceability.


Logo

Info

The Paygate offers individually scalable solutions for financial and debtor accountings - including the downstream processes such as logistics, dunnings or debt collection.

TypeDebtors Management EN


Further information can be found on the webpage of Ideal Debtor Management (http://www.ideal-fullservice.de/debitoren-und-forderungsmanagement.html).

 

Process flow chart


Ideal debtor management 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 debtors

To create a debtor via a Server-to-Server connection, go to 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 transfer parameters to be encrypted:

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..20

M

TransactionID which should be unique for each payment

Currency

a3

M

Currency, three digits DIN / ISO 4217

MAC

an64

M

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

EventToken

a2

M

Abbreviation of the action to be done: <MD> for ManageDebtor

Master data

Salutation

ans..50

O

Salutation

FirstName

ans..50

M

First name of the custumer

LastName

ans..50

M

Last name of the customer

AddrStreet

ans..45

M

Street name

AddrStreetNr

ans..5

O

Street number

AddrAddition

ans..50

O

Address c/o

AddrZip

ans..10

O

Postcode

AddrCity

ans..45

O

City

AddrCountryCode

a2

O

Two characters country code according to ISO 3166

TaxID

ans1

M

value added tax key / tax area

DebitorID

ans..10

M

debtor number

Custgroup

ans..4

O

Customer group

AccOwner

ans..30

O

Account holder

AccBank

ans..40

O

Name of the bank

BIC

ans..11

O

BIC

IBAN

ans..34

O

IBAN

Email

ans..50

O

E-mail address

Phone

ans..20

O

Telephone number

CustomerID

n..10

M

Customer number

Parameters for creating debtors


The following table describes the result parameters with which the Paygate responds 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 (authorisation, capture, credit note) for one payment assigned by Paygate

TransID

ans..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)

Response parameters for creating debtors



Create transaction

With reference to already created debtors you can create transactions and prepayments and reverse them if necessary.

To create a transaction, please enter 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..20

M

TransactionID which should be unique for each payment

RefNr

ns..30

M

Reference to payment, e.g. invoice number, can be same as document number (OP-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

a3

M

Currency, three digits DIN / ISO 4217

AmountClass

ans..1024

M

Assignment of net amounts (max. 11 digits in smallest currency unit) of a tax code (3 digits) to proceed codes (max. 10 digits) separated by “;”.

Further assignments are separated by “+”.

Example: 4500000000;2235;101+4400000000;1595;002

Proceed code 4500000000; Amount 22,35€; tax code 101

MAC

an64

M

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

EventToken

a2

M

Abbreviation of the action to be done: <OC> for Open Position Create

PayType

ans..3

M

<CC>= credit card

<EDD>= direct debit (ELV)

<SO>= directEbanking

<PP>= PayPal

<GP>= Giropay

<PD>= PayDirekt

<SK>= cheque

<BP>= BillPay

<COD>= cash on delivery

<RG>= Invoice

<PRP>= Prepayment

DebitorID

ans..10

M

debtor number

CustomerID

n..10

M

Customer number

ShopID

ans..4

M

accounting area, e.g. 01 for shop A – will be assigned for each client

PayTerm

ans..3

O

payment term

InvoiceDate

n6

O

Invoice date in the format DDMMYY: OP_Valuta date, if invoice is due at a later time

NetAmount

n..11

M

Net amount in own currency

TaxCode1

n..3

M

Tax code 1: 101 for 19% domestic tax

NetAmount1

n..11

M

Net amount for tax code 1

TaxAmount1

n..11

M

Tax amount for tax code 1

TaxCode2

n..3

M

Tax code 2: 002 for 7% domestic tax

NetAmount2

n..11

M

Net amount for tax code 2

TaxAmount2

n..11

M

Tax amount for tax code 2

TaxCode3

n..3

M

Tax code 3: 000 for 0% domestic tax

NetAmount3

n..11

M

Net amount for tax code 3

TaxAmount3

n..11

M

Tax amount for tax code 3

Parameters for creating transactions


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..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)

Response parameters for creating transactions



Create payment with prepayment

To create a prepayment, please enter 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..20

M

TransactionID which should be unique for each payment

RefNr

ns..30

M

Reference to payment, e.g. invoice number, can be same as document number (OP-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

a3

M

Currency, three digits DIN / ISO 4217

MAC

an64

M

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

EventToken

a2

M

Abbreviation of the action to be done:

<AN> for creation

<ST> for reversal

<ZE> for paid

<UP> for Update Data Record

CustomerID

n..10

M

Customer number

ShopID

ans..4

O

accounting area, e.g. 01 for shop A – will be assigned for each client

ShoppingBasketID

n..18

M

ID of shopping cart

CreationDate

dttm8

M

Creation date of shopping cart in the format YYYYMMDD

DueDate

dttm8

M

Expiration date in the format YYYYMMDD

PayType

ans.3

M

<PRP> = prepayment

Parameters for creating prepayments


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..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)

Response parameters for creating prepayments



Reverse transaction

To reverse a transaction, please enter 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, e.g. for referencing in batch files

TransID

ans..20

M

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

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

a3

M

Currency, three digits DIN / ISO 4217

MAC

an64

M

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

EventToken

a2

M

Abbreviation of the action to be done: <OS> for Open Position Storno

Parameters for reversal of transactions


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..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)

Response parameters for reversal of transactions



Credit transaction

To credit a transaction, please enter 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..20

M

ID assigned by Merchant for the payment process to be credited

RefNr

ns..30

M

Reference to payment, e.g. invoice number, can be same as document number (OP-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

a3

M

Currency, three digits DIN / ISO 4217

MAC

an64

M

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

EventToken

a2

M

Abbreviation of the action to be done: <CR> for Credit

PayType

ans..3

M

<CC>= credit card

<EDD>= direct debit (ELV)

<SO>= directEbanking

<PP>= PayPal

<GP>= Giropay

<PD>= PayDirekt

<SK>= cheque

<BP>= BillPay

<COD>= cash on delivery

<RG>= Invoice

<PRP>= Prepayment

DebitorID

ans..10

M

debtor number

CustomerID

n..10

M

Customer number

ShopID

ans..4

M

accounting area, e.g. 01 for shop A – will be assigned for each client

PayTerm

ans..3

O

payment term

InvoiceDate

n6

O

Invoice date in the format DDMMYY: OP_Valuta date, if invoice is due at a later time

NetAmount

n..11

M

Net amount in own currency

TaxCode1

n..3

M

Tax code 1: 101 for 19% domestic tax

NetAmount1

n..11

M

Net amount for tax code 1

TaxAmount1

n..11

M

Tax amount for tax code 1

TaxCode2

n..3

M

Tax code 2: 002 for 7% domestic tax

NetAmount2

n..11

M

Net amount for tax code 2

TaxAmount2

n..11

M

Tax amount for tax code 2

TaxCode3

n..3

M

Tax code 3: 000 for 0% domestic tax

NetAmount3

n..11

M

Net amount for tax code 3

TaxAmount3

n..11

M

Tax amount for tax code 3

AmountClass

ans..1024

M

Assignment of net amounts (max. 11 digits in smallest currency unit) of a tax code (3 digits) to proceed codes (max. 10 digits) separated by “;”.

Further assignments are separated by “+”.

Example: 4500000000;2235;101+4400000000;1595;002

Proceed code 4500000000; Amount 22,35€; tax code 101

Parameters for credit of transactions


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..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)

Response parameters for credit of transactions