{ "$schema": "http://json-schema.org/draft-07/schema#", "title": "extended_TranstactionSplitPayment", "required": [ "merchantId", "posId", "sessionId", "amount", "currency", "description", "email", "country", "language", "urlReturn", "sign", "splitPaymentDetails", "description" ], "properties": { "merchantId": { "name": "merchantId", "in": "formData", "description": "Merchant identification number", "type": "integer" }, "posId": { "name": "posId", "in": "formData", "description": "Shop identification number (defaults to merchant ID)", "type": "integer" }, "sessionId": { "name": "sessionId", "in": "formData", "description": "Unique identifier from merchant's system", "type": "string", "maxLength": 100 }, "amount": { "name": "amount", "in": "formData", "description": "Transaction amount expressed in lowest currency unit, e.g. 1.23 PLN = 123", "type": "integer" }, "currency": { "name": "currency", "in": "formData", "description": "Currency compatible with ISO, e.g. PLN", "type": "string", "maxLength": 3, "default": "PLN" }, "description": { "name": "description", "in": "formData", "description": "Transaction description", "type": "string", "maxLength": 1024 }, "email": { "name": "email", "in": "formData", "description": "Customer's e-mail", "type": "string", "maxLength": 50 }, "client": { "name": "client", "in": "formData", "description": "Customer's first name and surname", "type": "string", "maxLength": 40 }, "address": { "name": "address", "in": "formData", "description": "Customer's address", "type": "string", "maxLength": 80 }, "zip": { "name": "zip", "in": "formData", "description": "Customer's postal code", "type": "string", "maxLength": 10 }, "city": { "name": "city", "in": "formData", "description": "Customer's city", "type": "string", "maxLength": 50 }, "country": { "name": "country", "in": "formData", "description": "Country codes compatible with ISO, e.g. PL, DE, etc.", "type": "string", "maxLength": 2, "default": "PL" }, "phone": { "name": "phone", "in": "formData", "description": "Customer's telephone in the following format: 481321132123", "type": "string", "maxLength": 12 }, "language": { "name": "language", "in": "formData", "description": "One of following language codes according to ISO 639-1: bg, cs, de, en, es, fr, hr, hu, it, nl, pl, pt, se, sk, ro", "type": "string", "default": "pl", "maxLength": 2 }, "method": { "name": "method", "in": "formData", "description": "Payment method ID. List of payment methods provided in the panel or available through API", "type": "integer" }, "urlReturn": { "name": "urlReturn", "in": "formData", "description": "URL address to which customer will be redirected when transaction is complete", "type": "string", "maxLength": 250 }, "urlStatus": { "name": "urlStatus", "in": "formData", "description": "URL address to which transaction status will be send", "type": "string", "maxLength": 250 }, "timeLimit": { "name": "timeLimit", "in": "formData", "description": "Time limit for transaction process, 0 - no limit, max. 99 (in minutes)", "type": "integer" }, "channel": { "name": "channel", "in": "formData", "description": " 1 - card + ApplePay + GooglePay, 2 - transfer, 4 - traditional transfer, 8 - N/A, 16 - all 24/7 \u2013 makes available all payment methods, 32 - use pre-payment, 64 \u2013 only pay-by-link methods, 128 \u2013 instalment payment forms, 256 \u2013 wallets, 4096 - card, 8192 - blik, 16384 - all methods except blik\n
To activate the specific channels, their values should be summed up.\n
Example:\ntransfer and traditional transfer: channel=6",
"type": "integer",
"enum": [
"1",
"2",
"4",
"8",
"16",
"32",
"64",
"128",
"256",
"4096",
"8192",
"16384"
]
},
"shipping": {
"name": "shipping",
"in": "formData",
"description": "Delivery cost",
"type": "integer"
},
"transferLabel": {
"name": "transferLabel",
"in": "formData",
"description": "Description forwarded to transfer's description (not in every payment methods). A parameter can contain values only \u200b\u200bin a range [a-z A-Z 0-9 \u0119\u00f3\u0142\u015b\u0105\u017c\u017a\u0107\u0144\u0118\u00d3\u0141\u015a\u0104\u017b\u0179\u0106\u0143 . / :- ]",
"type": "string",
"maxLength": 20
},
"sdkVersion": {
"name": "sdkVersion",
"in": "formData",
"description": "Version of mobile library. Determines if transaction is mobile.",
"type": "string",
"maxLength": 10
},
"sign": {
"name": "sign",
"in": "formData",
"type": "string",
"maxLength": 100,
"description": "
Checksum of parameters:
{\"sessionId\":\"string\",\"merchantId\":int,\"amount\":int,\"currency\":\"string\",\"crc\":\"string\"}
calculated with the use of sha384
IMPORTANT!:
in case json_encode function is used, the following attributes should be added
\"JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES\""
},
"encoding": {
"name": "encoding",
"in": "formData",
"description": "Coding system for characters sent: ISO-8859-2, UTF-8, Windows-1250",
"type": "string",
"maxLength": 15
},
"cart": {
"description": "cart",
"items": {
"$ref": "#/components/schemas/CartParameters"
}
},
"methodRefId": {
"name": "methodRefId",
"in": "formData",
"description": "Special parameter for some payment flows e.g. BLIK and Card one-click.",
"type": "string",
"maxLength": 250
},
"splitPaymentDetails": {
"type": "object",
"properties": {
"vatAmount": {
"type": "integer",
"description": "Kwota podatku VAT"
},
"invoiceNumber": {
"type": "string",
"description": "Numer faktury"
},
"nip": {
"type": "string",
"description": "Numer identyfikacji podatkowej"
},
"iban": {
"type": "string",
"description": "Mi\u0119dzynarodowy numer rachunku bankowego IBAN (international bank account number)"
}
},
"required": [
"vatAmount",
"invoiceNumber",
"nip"
]
}
}
}