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.

Type

Payments by Online Bank Transfer

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

O

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

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, e.g. EUR, USD, GBP. Only PLN and EUR is 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)

OrderDesc

ans..768

M

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

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.

SellingPoint

ans..50

O

Selling point

Service

ans..50

O

products or service sold

Channel

ans..64

O

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

Language

a2

O

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

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.

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.

Please find a sample here: Custom

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

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

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"

MAC

an64

M

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

• HMAC Authentication (Request)

• HMAC Authentication (Notify)

OrderDesc

ans..768

M

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

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

a2

O

2-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 regulationsand information obligationof ”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

Articlelist

string

O

Article list, base64 encoded value

items

array

M

Array of items, e.g.: {"items": [{items1 ...}{item2...}]}

items.id

ans..30

M

Product number

items.description

ans..30

M

Product description

items.quantity

ans..30

M

Product quantity

items.amount

n..10

M

Product price

items.name

n..10

M

Product name

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.

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.

Please find a sample here: Custom

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

O

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

Status

a..50

M

OK or AUTHORIZE_REQUEST (URLSuccess) as well as 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.

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.

TransactionID

an..20

O

Unique transaction number from PPRO or P24 direct method.

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.

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.

Please find a sample here: Custom

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

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

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

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)

refnr

ans..40

O

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

ErrorText

ans..128

C

Detailed PPRO error message.

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

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)

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

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, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

TransID

ans..64

M

TransactionID provided by you which should be unique for each payment

refnr

ans..40

O

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

PayID

an32

M

ID assigned by Paygate for this transaction

Action

a..20

M

The parameter Action defines the type of transaction:

Credit

PayID

an32

M

ID assigned by Paygate for this transaction

Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

Code

an8

M

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