Enterpay

Logo

Info

Enterpay is a Finnish fintech startup which has a mission to boost B2B (business-to-business) ecommerce and optimise the payment process for B2B ecommerce by automating the counterparty risk assessment process.

Invoice payments are the preferred option in B2B commerce, but these are often handled manually, which makes them time-consuming and potentially risky. As online purchases in the B2B market continue to grow rapidly, B2B buyers expect the same smooth experience that they know from B2C ecommerce. Enterpay has developed a technical solution that is equipped to meet the changing expectations of the B2B customers and allows them to make invoice payments in B2B transactions easily, quickly and securely. Enterpay’s payment scheme consists of a platform where all necessary parties can enable automated B2B trade and cooperate seamlessly. Enterpay partners with banks and PSPs so that they can offer purely digital and fully automated invoicing and factoring solution to their B2B merchant customers. The technology automatically carries out the fraud and credit risk assessment and integrates to various ecommerce platforms and payment gateways.

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 Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

Currency

a3

M

Currency, three digits DIN / ISO 4217. Only EUR permissible. Please find an overview here: A1 Currency table

EventToken

enum

m

CRT (for invoice creation)

MAC

an64

M

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

• HMAC Authentication (Request)

• HMAC Authentication (Notify)

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.

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.

Language

ans..5

O

Language (e.g. "de_DE" as default option)

ArticleList

ans..1024

M

List of articles in the following format.

name,unit_price_excluding_tax,quantity,identifier,tax_rate+

name,unit_price_excluding_tax,quantity,identifier,tax_rate+

...

InvoiceDate

dttm

O

The parameter sets the invoicing date. Parameter can't be in the past.

Format: YYYY-MM-DD

InvoiceText

ans..100

O

An optional metadata field for the user's convenience

Billing address block is optional. If the block is present, mandatory fields from the block have to be filled.

bdStreet

ans..100

M

Street address of user's billing address

bdStreet2

ans..100

O

Additional information about street address of user's billing address

bdZIP

ans..10

M

Postal code of user's billing address

bdCity

ans..100

M

City of user's billing address

bdCountryCode

ans..10

O

Country code of user's billing address

Shipping address block is optional. If the block is present, mandatory fields from the block have to be filled.

sdStreet

ans..100

M

Street address of user's delivery address

sdStreet2

ans..100

O

Additional information about street address of user's delivery address

sdZIP

ans..10

M

Postal code of user's delivery address

sdCity

ans..100

M

City of user's delivery address

sdCountryCode

ans..10

O

Country code of user's delivery address

Buyer block is optional and all the fields are optional. It is better to pass the info as it will lead to better user experience. In this case the buyer won't need to fill this information again on Enterpay side.

FirstName

ans..125

O

First name of the buyer

LastName

ans..125

O

Last name of the buyer

Phone

ans..50

O

Phone number of the buyer with country code, e.g. +35812345678

DateOfBirth

dttm

O

Date of birth of the buyer.

Format: YYYY-MM-DD

Email

ans..50

O

Email address of the buyer

CompanyName

ans..125

O

Name of the buyer's company

CompanyID

ans..40

O

Business ID of the buyer's company, e.g. 1234567-8

TaxNumber

ans..20

O

European VAT identification number of the buyer's company, e.g. FI12345678

SubMerchant block is optional and all the fields are optional

StoreName

ans..255

O

Sub Merchant's Organisation name

subMIDAddrStreet

ans..100

O

Street address of sub merchant’s billing/delivery address

subMIDAddrStreet2

ans..100

O

Additional information about street address of user’s billing/delivery address

subMIDAddrZip

ans..10

O

Postal code of sub merchant’s billing/delivery address

subMIDAddrCity

ans..100

O

City of sub merchant’s billing/delivery address

subMIDAddrCountryCode

ans..10

O

Country code of sub merchant’s billing/delivery address

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

an8

M

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

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 Enterpay, if agreed with Computop Helpdesk.

ErrorText

ans..1024

O

Error text from Enterpay, 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 Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

Currency

a3

M

Currency, three digits DIN / ISO 4217. Only EUR permissible. Please find an overview here: A1 Currency table

EventToken

enum

M

UPD (for invoice update)

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.

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.

ArticleList

ans..1024

M

List of articles in the following format.

name,unit_price_excluding_tax,quantity,identifier,tax_rate+

name,unit_price_excluding_tax,quantity,identifier,tax_rate+

...

InvoiceDate

dttm

O

The parameter sets the invoicing date. Parameter can't be in the past.

Format: YYYY-MM-DD

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)

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 Enterpay, if agreed with Computop Helpdesk.

ErrorText

ans..1024

O

Error text from Enterpay, 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 to be captured

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 Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

Currency

a3

M

Currency, three digits DIN / ISO 4217. Only EUR permissible. Please find an overview here: A1 Currency table

EventToken

enum

M

ACF (for full invoice capture)

MAC

an64

M

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

• HMAC Authentication (Request)

• HMAC Authentication (Notify)

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.

UserData

ans..1024

O

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

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)

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 Enterpay, if agreed with Computop Helpdesk.

ErrorText

ans..1024

O

Error text from Enterpay, 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 to be captured

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 Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

Currency

a3

M

Currency, three digits DIN / ISO 4217. Only EUR permissible. Please find an overview here: A1 Currency table

EventToken

enum

M

ACP (for partial invoice capture)

MAC

an64

M

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

• HMAC Authentication (Request)

• HMAC Authentication (Notify)

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.

UserData

ans..1024

O

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

ArticleList

ans..1024

M

List of articles in the following format.

quantity,name+

quantity,name+

...

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)

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 Enterpay, if agreed with Computop Helpdesk.

ErrorText

ans..1024

O

Error text from Enterpay, 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 to be reversed

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 Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

Currency

a3

M

Currency, three digits DIN / ISO 4217. Only EUR permissible. 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)

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.

UserData

ans..1024

O

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

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)

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 Enterpay, if agreed with Computop Helpdesk.

ErrorText

ans..1024

O

Error text from Enterpay, 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 to be credited

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 Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

Currency

a3

M

Currency, three digits DIN / ISO 4217. Only EUR permissible. 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)

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.

UserData

ans..1024

O

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

ArticleList

ans..1024

M

List of articles in the following format.

name,refunding_type,currency,refunded_amount+

name,refunding_type,currency,refunded_amount+

...

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)

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 Enterpay, if agreed with Computop Helpdesk.

ErrorText

ans..1024

O

Error text from Enterpay, if agreed with Computop Helpdesk.