This option is available when the multipayout feature is enabled. Only for accounts at BNP Paribas Bank.
Transactions are performed according to the description in point 3.1, with one additional parameter in the data.multipayout[] object:
| Parameter | Type | Required | Description |
|---|---|---|---|
iban |
string | ✔️ | Bank account number |
amount |
integer(1-999999999) | ✔️ | Transaction amount in the smallest currency unit, e.g. grosz. |
label |
string | ✔️ | Recipient name (max 35 characters), Allowed characters: A-Za-z0-9-"',. as well as the space character (0x20) and characters in the UNICODE range 00C0 - 02C0 (including Polish diacritical characters), |
title |
string | - | Transfer title (max 105 characters), Allowed characters: A-Za-z0-9#&_-"',.\/ as well as the space character (0x20) and characters in the UNICODE range 00C0 - 02C0 (including Polish diacritical characters), optional parameter. Its presence causes the given transaction to be separated on the recipient's account. Important: Providing this parameter for one element requires it to be provided for the others. |
If the sum of the
amountfields in themultipayoutparameter is lower than the total order amount, the remaining funds will go to the default account of the store owner.The minimum and maximum transaction amount is given in the table in point [11. Minimum and maximum values of transaction and refund amounts].
Example request:
{
"type": "sale",
"serviceId": "62f574ed-d4ad-4a7e-9981-89ed7284aaba",
"amount": 9900,
"currency": "PLN",
"orderId": "12",
"clientIp": "192.168.10.2",
"paymentMethod": "pbl",
"paymentMethodChannel": "bnpparibas",
"successReturnUrl": "https://domain.com/success",
"failureReturnUrl": "https://domain.com/failure",
"customer": {
"firstName": "Maciej",
"lastName": "Kowalski",
"email": "jan.kowalski@example.com"
},
"data": {
"multipayout": [
{
"iban": "PL55105000026800208114085773",
"amount": 100,
"label": "Company name 0"
},
{
"iban": "PL55105000026800208114085773",
"amount": 200,
"label": "Company name 1"
}
]
}
}