PRprzelewy24
Transaction service API

Transaction registration

Changed on
post/api/v1/transaction/register

Request

Request body

merchantIdinteger required

Store ID

posIdinteger required

Store ID (merchant ID by default)

sessionIdstring required

Unique identifier from the merchant's system

amountinteger required

Transaction amount expressed in grosz, e.g. 1.23 PLN = 123.

currencystring required

Currency code compliant with ISO 4217, e.g. PLN.

descriptionstring required

Transaction description

emailstring email required

Customer's email address

clientstring

Customer's full name

addressstring

Customer's address

zipstring

Customer postal code

citystring

Customer city

countrystring required

Country codes compliant with ISO 3166-1 alpha-2, e.g. PL, DE.

phonestring

Customer's phone number in the format 481321132123.

languagestring required

One of the following language codes compliant with ISO 639-1: bg, cs, de, en, es, fr, hr, hu, it, nl, pl, pt, se, sk, ro

methodinteger

Payment method identifier. The list of methods is available in the panel or through the API.

urlReturnstring uri required

Return URL after the transaction is completed

urlStatusstring uri

URL to which the transaction status is sent

timeLimitinteger

Time limit for completing the transaction, in minutes: 0 means no limit, and the maximum value is 99.

channelinteger
<p><strong>Payment channel bitmask.</strong></p> <p>To enable multiple channels, add their values together.</p> <blockquote> <strong>Example:</strong><br> bank transfers (<code>2</code>) + traditional transfer (<code>4</code>) = <code>6</code> </blockquote> <p><strong>Available bit values:</strong></p> <table> <tr><th>Value</th><th>Description</th></tr> <tr><td><code>1</code></td><td>cards + Apple Pay + Google Pay</td></tr> <tr><td><code>2</code></td><td>bank transfers</td></tr> <tr><td><code>4</code></td><td>traditional transfer</td></tr> <tr><td><code>8</code></td><td>N/A</td></tr> <tr><td><code>16</code></td><td>all 24/7 methods - makes all payment methods available</td></tr> <tr><td><code>32</code></td><td>use advance payment</td></tr> <tr><td><code>64</code></td><td>pay-by-link methods only</td></tr> <tr><td><code>128</code></td><td>installment methods</td></tr> <tr><td><code>256</code></td><td>wallets</td></tr> <tr><td><code>4096</code></td><td>cards</td></tr> <tr><td><code>8192</code></td><td>BLIK</td></tr> <tr><td><code>16384</code></td><td>all methods except BLIK</td></tr> </table> <p><strong>Note:</strong> To enable multiple channels simultaneously, add their values together.</p>
waitForResultboolean

This parameter determines whether the user is redirected back to the store immediately after making the payment or only after the transaction result (including payment confirmation) has arrived. <a href="#tag/Use-cases/How-to-enable-a-smooth-return-to-the-store-without-waiting-for-synchronous-payment-confirmation"><b>Read more</b></a>

regulationAcceptboolean

Acceptance of the Przelewy24 terms and conditions: <br/>false - display the consent on the P24 page (default),<br/>true - consent has been granted; do not display it.<br/>When sending the value “true”, the Partner's website must include consent with the following wording: “I declare that I have read and accept the terms and conditions and the information obligation of the Przelewy24 service.” <br/>The words <i>terms and conditions</i> and <i>information obligation</i> must link to the pages containing these documents. The checkbox must not be selected by default.

shippinginteger

Delivery or shipping cost.

transferLabelstring

Description displayed in the transfer title. Allowed characters: [a-z A-Z 0-9 ęółśążźćńĘÓŁŚĄŻŹĆŃ . /\ :- ].

mobileLib1

Sending this parameter is required when using SDK libraries. Set <b>mobileLib</b> to 1 and use the <b>sdkVersion</b> parameter to specify the version of the library to be used.

sdkVersionstring

Mobile library version. Specifies whether the transaction is processed on a mobile device.

signstring required

<br>Parameter checksum:<br>{<font color="brown">"sessionId":</font>"str",<font color="brown">"merchantId":</font>int,<font color="brown">"amount":</font>int,<font color="brown">"currency":</font>"str",<font color="brown">"crc":</font>"str"} <br><br>Calculated using the SHA-384 algorithm<br><br><b><font color="#DB2053">IMPORTANT!</font></b><br>When using the json_encode function, apply the following flags: <br>"JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES"

encodingstring

Character encoding system: ISO-8859-2, UTF-8, Windows-1250

methodRefIdstring

Special parameter required for certain payment processes, e.g. BLIK and one-click cards.

Example request

{
  "channel": 6
}

Response

OK

responseCodenumber

Changes

  • 5861a691aa36Revision changes
    • breaking

      removed the enum value 1.00 of the request property

    • breaking

      removed the enum value 128.00 of the request property

    • breaking

      removed the enum value 16.00 of the request property

    • breaking

      removed the enum value 16384.00 of the request property

    • breaking

      removed the enum value 2.00 of the request property

    • breaking

      removed the enum value 256.00 of the request property

    • breaking

      removed the enum value 32.00 of the request property

    • breaking

      removed the enum value 4.00 of the request property

    • breaking

      removed the enum value 4096.00 of the request property

    • breaking

      removed the enum value 64.00 of the request property

    • breaking

      removed the enum value 8.00 of the request property

    • breaking

      removed the enum value 8192.00 of the request property

    • breaking

      the //// request property type changed from no type to object

    • breaking

      the request property type changed from no type to array

    • breaking

      the request property format changed from no format to email

    • breaking

      the request property format changed from no format to uri

    • breaking

      the request property format changed from no format to uri

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • warning

      the request property's min was set to 0.00

    • info

      api operation id registerTransaction was added

    • info

      the request property default value PLN was removed

  • e9d9982466d8Revision changes
    • breaking

      added to the request property allOf list

    • warning

      removed the request property /

    • info

      added the new 16384.00 enum value to the request property

    • info

      added the new 8192.00 enum value to the request property