Additional API functionality

A Split Payment is processed using a previously registered token, in a process analogous to <a href="#tag/Transaction-service-API/operation/registerTransaction"><b>transaction/register</b></a>. When registering the token, add the <b>splitPaymentDetails</b> object intended for this transaction type.

post/api/v1/transaction/register/splitpayment

Request

Request body

merchantIdinteger required

Merchant 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</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>digital 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>Example:</strong> bank transfers + traditional transfer → <code>channel=6</code></p>
shippinginteger

Delivery or shipping cost.

transferLabelstring

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

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>"string",<font color="brown">"merchantId":</font>int,<font color="brown">"amount":</font>int,<font color="brown">"currency":</font>"string",<font color="brown">"crc":</font>"string"} <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

    • breaking

      the request's body type changed from no type to object

    • breaking

      removed the enum value 1 of the request property

    • breaking

      removed the enum value 128 of the request property

    • breaking

      removed the enum value 16 of the request property

    • breaking

      removed the enum value 16384 of the request property

    • breaking

      removed the enum value 2 of the request property

    • breaking

      removed the enum value 256 of the request property

    • breaking

      removed the enum value 32 of the request property

    • breaking

      removed the enum value 4 of the request property

    • breaking

      removed the enum value 4096 of the request property

    • breaking

      removed the enum value 64 of the request property

    • breaking

      removed the enum value 8 of the request property

    • breaking

      removed the enum value 8192 of the request property

    • 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 registerSplitPaymentTransaction was added

    • info

      added the new 16384 enum value to the request property

    • info

      added the new 8192 enum value to the request property