About Przelewy24

General information about Przelewy24


Logo

Info

Przelewy24 is an online banking method for Poland. It uses online bank authentication for account postings in real-time. Przelewy24 is supported by 18 large banks and reaches 95 % of the polish customers in online banking. The system has no transaction limit and directs customers via its online banking environment directly to the payment processing.

TypePayments by Online Bank Transfer

 

Process flow chart

Przelewy24 process flow


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


Payment with Przelewy24 via Platform form interface

To make a payment with Przelewy24 online transfer in Poland, please use the following URL:

https://www.computop-paygate.com/p24.aspx

 

Notice: For security reasons, Computop 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:

KeyFormatCNDDescription

MerchantID

ans..30

M

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

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
refnr

ans..40

O

Merchant’s unique reference number. Only characters a-zA-Z0-9,-_ are allowed.

KeyFormatCNDDescription
Amountn..10M

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

Key

Format

CND

Description

Currency

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Only PLN and EUR is permissible. Please find an overview here: A1 Currency table EN

KeyFormatCNDDescription

MAC

an64

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

Key

Format

CND

Description

OrderDesc

ans..768

M

Description of goods and prices. Intended purpose on the statement of account.

KeyFormatCNDDescription
URLSuccess

ans..256

M

Complete URL which calls up Platform 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 Platform and shop, please use the parameter UserData.

(info) Common notes:

  • We recommend to use parameter "response=encrypt" to get an encrypted response by Platform
  • However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

KeyFormatCNDDescription
URLFailure

ans..256

M

Complete URL which calls up Platform 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 Platform and shop, please use the parameter UserData.

(info) Common notes:

  • We recommend to use parameter "response=encrypt" to get an encrypted response by Platform
  • 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.

KeyFormatCNDDescription
Response

a7

O

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

KeyFormatCNDDescription
URLNotify

ans..256

M

Complete URL which Platform 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.

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

KeyFormatCNDDescription
UserData

ans..1024

O

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

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

KeyFormatCNDDescription

SellingPoint

ans..50

O

Selling point

KeyFormatCNDDescription

Service

ans..50

O

products or service sold

KeyFormatCNDDescription

Channel

ans..64OConfiguration channel of the PPRO contract (account and ContractID are stored in the system). If it exists, it may overwrite channels stored in the system.

Key

Format

CND

Description

Languagea2O2-letter language code (e.g. de) that should be preferred when presenting payment pages to the consumer
AccOwner

ans3..50

M

Name of account holder

Email

ans..100

M

E-Mail address of account holder

KeyFormatCNDDescription
Plain

ans..50

O

A single value to be set by the merchant to return some information unencrypted in response/notify, e.g. the MID. 

"Plain"-parameter is part of encrypted "Data" in Computop Paygate and therefore protected against manipulation. 

KeyFormatCND

Description

Custom
ans..1024


O

"Custom"-parameter is added to the request data before encryption and is part of encrypted "Data" in Computop Paygate request. By this they are protected against manipulation by a consumer. 

The Custom-value is added to the Computop Paygate response in plain text and the "|" is replaced by a "&". By this you can put a single value into Custom-parameter and get multiple key-value-pairs back in response for your own purpose.

Parameters for payments with Przelewy24 (via PPRO)


Przelewy24 via Direct Integration method (P24 Direct)

To make a payment with Przelewy24 online transfer via direct integration in Poland, please use the following URL:

https://www.computop-paygate.com/p24.aspx

 

Notice: For security reasons, Computop 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:

KeyFormatCNDDescription

MerchantID

ans..30

M

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

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
Amountn..10M

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

Key

Format

CND

Description

RefNr

ans..20

O

Merchant’s unique reference number

Currency

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Default value: "PLN"

KeyFormatCNDDescription

MAC

an64

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

Key

Format

CND

Description

OrderDesc

ans..768

M

Description of goods and prices. Intended purpose on the statement of account.

KeyFormatCNDDescription
URLSuccess

ans..256

M

Complete URL which calls up Platform 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 Platform and shop, please use the parameter UserData.

(info) Common notes:

  • We recommend to use parameter "response=encrypt" to get an encrypted response by Platform
  • However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

KeyFormatCNDDescription
URLFailure

ans..256

M

Complete URL which calls up Platform 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 Platform and shop, please use the parameter UserData.

(info) Common notes:

  • We recommend to use parameter "response=encrypt" to get an encrypted response by Platform
  • 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.

KeyFormatCNDDescription
Response

a7

O

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

KeyFormatCNDDescription
URLNotify

ans..256

M

Complete URL which Platform 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.

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

KeyFormatCNDDescription
UserData

ans..1024

O

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

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

Key

Format

CND

Description

Languagea2O2-letter language code (e.g. de) that should be preferred when presenting payment pages to the consumer. Default value: "pl".
bdFirstName

ans3..20

O

Customer's first name 

bdLastName

an..20

O

Customer's surname

bdStreet

ans..80

O

Customer's address

bdZip

n..10

O

Customer's postal code

bdCity

ans..50

O

Customer's city

bdCountryCode

a2

M

Country code of the customer, 2 characters according to ISO 3166. Default value: "PL"

bdPhone

ans..12

O

Customer's telephone in the following format: 481321132123

bdeMail

ans..50

M

E-Mail address of account holder

PayType 

a..10

O

Payment method. List of payment methods available through direct API.

Available values:

  • blik
AuthCode

n..10

OC

Required in case of BLIK one time payment.

6-digit, one-time BLIK code generated in the app.
*If provided then PayType = blik otherwise request will be rejected.

TermsAndConditions

an..10

OC

Required in case "PayType" parameter is provided with the request

Default: false

Acceptance of Przelewy24 regulations:

  • false – display consent on p24 website (default),
  • true – consent granted, do not display.

    In case the „true” parameter is sent, the consent – worded as follows – must be displayed on the Partner’s website: „I hereby state that I have read the regulations and information obligation of ”Przelewy24”.
    Under words regulations and information obligation there must be hyperlinks redirecting to websites with these documents. The checkbox must not be ticked by default.
ChargeAmount

ans..10

O

Delivery cost

ShippingMethod

n..1

O

Type of shipment:

Possible values:
0 – courier
1 – delivery point
2 – parcel locker
3 – package in a shop

sdStreet

ans..80

O

Shipment address: street and number

sdZip

n..10

O

Shipment zip code

sdCity

ans..50

O

Shipment city

sdCountryCode

a2

O

Country code of the shipment address, 2 characters according to ISO 3166

ArticlelistStringO

Article list, base64 encoded value.

  • Articlelist example after decoding:
{
    "items": [
        {
            "id": "123457",
            "name": "Prod1",
            "description": "Test product",
            "quantity": 3,
            "amount": 5500
        },
        {
            "id": "987654",
            "name": "Prod2",
            "description": "Test product 2",
            "quantity": 1,
            "amount": 1000
        }
    ]
}


  • Further important information:

The sum of the amounts in the JSON may differ from the value passed in the 'Amount' parameter.

itemsarrayMArray of items, e.g.: {"items": [{items1 ...}{item2...}]}
items.idans..30MProduct number
items.descriptionans..30MProduct description
items.quantityans..30MProduct quantity
items.amountn..10MProduct price
items.namen..10MProduct name

KeyFormatCNDDescription
Plain

ans..50

O

A single value to be set by the merchant to return some information unencrypted in response/notify, e.g. the MID. 

"Plain"-parameter is part of encrypted "Data" in Computop Paygate and therefore protected against manipulation. 

KeyFormatCND

Description

Custom
ans..1024


O

"Custom"-parameter is added to the request data before encryption and is part of encrypted "Data" in Computop Paygate request. By this they are protected against manipulation by a consumer. 

The Custom-value is added to the Computop Paygate response in plain text and the "|" is replaced by a "&". By this you can put a single value into Custom-parameter and get multiple key-value-pairs back in response for your own purpose.

Parameters for payments with Przelewy24 via Direct Integration


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

(info) pls. be prepared to receive additional parameters at any time and do not check the order of parameters

(info) the key (e.g. mid, RefNr) should not be checked case-sentive

KeyFormatCNDDescription

mid

ans..30

M

MerchantID, assigned by Computop

KeyFormatCNDDescription
PayID

an32

M

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

KeyFormatCNDDescription
XID

an32

M

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

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
refnr

ans..40

O

Merchant’s unique reference number. Only characters a-zA-Z0-9,-_ are allowed.

KeyFormatCNDDescription
Status

a..50

M

OK or AUTHORIZE_REQUEST (URLSuccess) as well as FAILED (URLFailure)

KeyFormatCNDDescription
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!

KeyFormatCNDDescription
Code

an8

M

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

KeyFormatCNDDescription

MAC

an64

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

KeyFormatCNDDescription
UserData

ans..1024

O

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

Key

Format

CND

Description

TID

ans..40

O

Transaction reference at Przelewy24

paymentMethod

ans..40

O

The payment method that was chosen to complete the payment by the customer.

PaymentPurpose

ans..26

C

Only with PPRO: Purpose of payment

PaymentGuarantee

a..12

C

Only with PPRO: NONE= no payment guarantee

VALIDATED= customer account valid, but no payment guarantee, FULL= payment guarantee

Notice: This parameter is only returned if the Status=OK.

ErrorText

ans..128

C

Only with PPRO: Detailed PPRO error message.

Notice: Is returned only if Status=FAILED. Use is possible only in agreement with Computop Helpdesk.

Key

Format

CND

Description

TransactionID

an..20

O

Unique transaction number from PPRO or P24 direct method.

KeyFormatCNDDescription
Plain

ans..50

O

A single value to be set by the merchant to return some information unencrypted in response/notify, e.g. the MID. 

"Plain"-parameter is part of encrypted "Data" in Computop Paygate and therefore protected against manipulation. 

KeyFormatCND

Description

Custom
ans..1024


O

"Custom"-parameter is added to the request data before encryption and is part of encrypted "Data" in Computop Paygate request. By this they are protected against manipulation by a consumer. 

The Custom-value is added to the Computop Paygate response in plain text and the "|" is replaced by a "&". By this you can put a single value into Custom-parameter and get multiple key-value-pairs back in response for your own purpose.

Return parameters for URLSuccess, URLFailure and URLNotify with Przelewy24


Credit with reference

Credits (refunds) are possible via a Server-to-Server connection. For a Credit with reference to a capture the amount of the Credit is limited to the amount of the previous capture. To carry out a credit with a reference transaction, please use the following URL:

https://www.computop-paygate.com/credit.aspx

 

Notice: For security reasons, Computop 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:

KeyFormatCNDDescription

MerchantID

ans..30

M

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

KeyFormatCNDDescription
PayID

an32

M

ID assigned by Platform for the payment to be credited

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
Amountn..10M

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

KeyFormatCNDDescription
Currency

a3

M

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

KeyFormatCNDDescription

MAC

an64

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

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

Parameters for credit payments with Przelewy24 via socket connection


The following table describes the result parameters with which the Computop Paygate responds to your system

(info) pls. be prepared to receive additional parameters at any time and do not check the order of parameters

(info) the key (e.g. mid, RefNr) should not be checked case-sentive

KeyFormatCNDDescription

mid

ans..30

M

MerchantID, assigned by Computop

KeyFormatCNDDescription
PayID

an32

M

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

KeyFormatCNDDescription
XID

an32

M

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

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

KeyFormatCNDDescription
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!

KeyFormatCNDDescription
Code

an8

M

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

KeyFormatCNDDescription
refnr

ans..40

O

Merchant’s unique reference number. Only characters a-zA-Z0-9,-_ are allowed.

KeyFormatCNDDescription

ErrorText

ans..128

C

Detailed PPRO error message.

Notice: Is returned only if Status=FAILED. Use is possible only in agreement with Computop Helpdesk.

Response parameters for credit payments with Przelewy24 via socket connection


Batch processing via the interface

Basic information about using Batch files and about their structure can be found in the Batch Manager manual. Within batch processing not alle functions are available which are usually available for the online interface.

This section describes the parameters which must be transferred within the data set (Record) for executing credits with Przelewy24 and which information can be found within the response file about the payment status.

Following table gives an overview of all batch versions that are possible for a specific action and their specialities:

Action

Version

Description

Credit

1.0 / 2.0

Standard version without return of parameter Code


1.x / 2.x

with RefNr (valid for all versions other than 1.0)

Description of the possible batch versions


The structure for a Przelewy24 payment within a Batch file to be submitted is the following:

HEAD,<MerchantID>,<Date>,<Version>
Przelewy24,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>
FOOT,<CountRecords>,<SumAmount>

Example for Master MID function:

HEAD,[Master]MerchantID,Date,2.x
Type,Action,[Slave]MID,Amount,Currency,TransID,Data (depends on Action)
FOOT,CountRecords,SumAmount

The following table describes the individual fields and values used within the data set (record) in the batch file:

Key

Format

CND

Description

Type

a..11

M

HEAD for Header, FOOT for Footer, Przelewy24 for Przelewy24

Action

a..20

M

The parameter Action defines the type of transaction:

Credit

KeyFormatCNDDescription
Amountn..10M

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

KeyFormatCNDDescription
Currency

a3

M

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

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
refnr

ans..40

O

Merchant’s unique reference number. Only characters a-zA-Z0-9,-_ are allowed.

KeyFormatCNDDescription
PayID

an32

M

ID assigned by Platform for this transaction

Description of fields within the record for Batch files

 

The record area within the response file for Batch transactions looks the following way:

HEAD,<MerchantID>,<Date>,<Version>
Przelewy24,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code>
FOOT,<CountRecords>,<SumAmount>

The following table describes the response parameters which the Batch Manager saves in the Record area for each transaction (standard parameters not explained here, such as <TransID> or <RefNR> and request parameters are returned unchanged and correspond to the call as specified before):

Key

Format

CND

Description

Action

a..20

M

The parameter Action defines the type of transaction:

Credit

KeyFormatCNDDescription
PayID

an32

M

ID assigned by Platform for this transaction

KeyFormatCNDDescription
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

KeyFormatCNDDescription
Code

an8

M

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

Description of result parameters within the record for Batch files