bundleRequest * |
{
Klasa zlecenia paczki przelewów / Bundle of payments Request Class
Required: requestHeader,tppBundleId,transfersTotalAmount,typeOfTransfers
requestHeader:
{
Klasa zawierająca informacje o PSU and callback URL / PSU and callback URL Information Class
}
tppBundleId:
string
maxLength:64
Identyfikator paczki przelewów nadany przez TPP / Bundle of payments identifier set by TPP
transfersTotalAmount:
string
Łączna kwota wszystkich przelewów z paczki / The total amount of all transfers from bundle
Pattern: ^\d*\.\d{2}$
typeOfTransfers:
string
Typ przelewów, które zostaną zlecone w ramach paczki / The type of transfers that will be initiated through the bundle
Enum:
domestic , EEA , nonEEA , tax
domesticTransfers:
[
Lista struktur danych przelewów zwykłych, które zostaną zlecone. Wymagane gdy typeOfTransfers = domestic. / The list of data structures of domestic transfers to be initiated. Required when typeOfTransfers = domestic.
{
Klasa zlecenia przelewu krajowego w ramach paczki / Domestic Transfer inside bundle Request Class
Required: deliveryMode,recipient,sender,tppTransactionId,transferData
recipient:
{
Klasa zawierająca dane odbiorcy używana w żądaniach PIS / PIS Recipient Data Class
Required: accountNumber,nameAddress
nameAddress:
{
Klasa zawierająca dane nazwy i adresu w postaci czterech linii danych / Simple name and postal address Class
}
}
sender:
{
Klasa zawierająca dane nadawcy przelewu krajowego używana w żądaniach PIS / Domestic PIS services Sender Data Class
nameAddress:
{
Klasa zawierająca dane nazwy i adresu w postaci czterech linii danych / Simple name and postal address Class
}
}
transferData:
{
Klasa zawierająca dane przelewu / Transfer Data Class
}
all of:
{
Bazowa klasa dla TransferData / TransferData Base Class
description:
string
maxLength:140
Pole opisujące przelew / Description
amount:
string
Pattern: ^\d*\.\d{2}$
executionDate:
string
(date)
Data wykonania przelewu. Wymagany pod warunkiem przekazania wartości FutureDated w atrybucie executionMode. Format: YYYY-MM-DD / Date when the transfer is to be executed (YYYY-MM-DD). Required conditionally if executionMode attribute has value FutureDated.
recurrence:
{
Klasa definiująca parametry płatności cyklicznej / A class defining recurring payment parameters
Required: dayOffOffsetType,endDate,frequency,startDate
startDate:
string
(date)
Data wykonania pierwszej płatności w definiowanym cyklu. Format: YYYY-MM-DD / First payment execution date (of the defined cycle).
frequency:
{
Klasa opisująca parametry częśtotliwości wykonywania płatności cyklicznej / A class defining parameters of the frequency of recurring paymenets
Required: periodType,periodValue
periodType:
string
Typ jednostki okresu czasu / The type of unit of time period
Enum:
day , week , month
periodValue:
integer
minimum:1
Wartość jednostki okresu czasu / The value of unit of time period
}
endDate:
string
(date)
Ostatnia możliwa data wykonania płatności w definiowanym cyklu. Format: YYYY-MM-DD / The last possible payment execution date (of the defined cycle).
dayOffOffsetType:
string
Rodzaj przesunięcia, który należy zastosować do wykonania przelewu w przypadku, gdy dzień wolny jest planowaną datą przelewu / Type of offset that should be used for transfer execution in case of day off being the planned date of transfer
Enum:
before , after
}
}
tppTransactionId:
string
maxLength:64
ID transakcji nadany przez TPP / Transaction ID (TPP)
deliveryMode:
string
Tryb pilności / Urgency mode
Enum:
ExpressD0 , StandardD1
system:
string
Droga jaką przelew ma być rozliczony / The way the transfer should be settled
Enum:
Elixir , ExpressElixir , Sorbnet , BlueCash , Internal
hold:
boolean
Czy założyć blokadę (w przypadku np. zlecenia przelewu w dniu wolnym) / Indicates if payment should be holded
executionMode:
string
Tryb realizacji płatności. Nadrzędna informacja decydująca o tym w jakim trybie zostanie zrealizowana płatność. / Payment execution mode. The superior information deciding which mode is to be used to execute payment.
Enum:
Immediate , FutureDated , Recurring
}
]
EEATransfers:
[
Lista struktur danych przelewów zagranicznych SEPA, które zostaną zlecone. Wymagane gdy typeOfTransfers = EEA. / The list of data structures of SEPA foreign transfers to be initiated. Required when typeOfTransfers = EEA.
{
Klasa zlecenia przelewu zagranicznego SEPA w ramach paczki / EEA Transfer inside bundle Request Class
Required: deliveryMode,recipient,sender,tppTransactionId,transferData
recipient:
{
Klasa zawierająca dane odbiorcy używana w żądaniach PIS dla operacji zagranicznych / PIS foreign Recipient Data Class
Required: accountNumber,name
accountNumber:
string
Numer konta, format dla przelewów zagranicznych
address:
[
(1..4)
Klasa zawierająca dane adresu pocztowego / Postal address Class
]
}
sender:
{
Klasa zawierająca dane nadawcy przelewu zagranicznego używana w żądaniach PIS / Foreign PIS services Sender Data Class
name:
string
maxLength:140
Nazwa nadawcy / Sender name
}
transferData:
{
Klasa zawierająca dane przelewu / Transfer Data Class
}
all of:
{
Bazowa klasa dla TransferData / TransferData Base Class
description:
string
maxLength:140
Pole opisujące przelew / Description
amount:
string
Pattern: ^\d*\.\d{2}$
executionDate:
string
(date)
Data wykonania przelewu. Wymagany pod warunkiem przekazania wartości FutureDated w atrybucie executionMode. Format: YYYY-MM-DD / Date when the transfer is to be executed (YYYY-MM-DD). Required conditionally if executionMode attribute has value FutureDated.
recurrence:
{
Klasa definiująca parametry płatności cyklicznej / A class defining recurring payment parameters
Required: dayOffOffsetType,endDate,frequency,startDate
startDate:
string
(date)
Data wykonania pierwszej płatności w definiowanym cyklu. Format: YYYY-MM-DD / First payment execution date (of the defined cycle).
frequency:
{
Klasa opisująca parametry częśtotliwości wykonywania płatności cyklicznej / A class defining parameters of the frequency of recurring paymenets
Required: periodType,periodValue
periodType:
string
Typ jednostki okresu czasu / The type of unit of time period
Enum:
day , week , month
periodValue:
integer
minimum:1
Wartość jednostki okresu czasu / The value of unit of time period
}
endDate:
string
(date)
Ostatnia możliwa data wykonania płatności w definiowanym cyklu. Format: YYYY-MM-DD / The last possible payment execution date (of the defined cycle).
dayOffOffsetType:
string
Rodzaj przesunięcia, który należy zastosować do wykonania przelewu w przypadku, gdy dzień wolny jest planowaną datą przelewu / Type of offset that should be used for transfer execution in case of day off being the planned date of transfer
Enum:
before , after
}
}
{
Required: currency
currency:
string
maxLength:3
Waluta, domyślnie EUR przelewów zagranicznych / Currency
}
tppTransactionId:
string
maxLength:64
ID transakcji nadany przez TPP / Transaction ID (TPP)
deliveryMode:
string
Tryb pilności / Urgency mode
Enum:
ExpressD0 , StandardD1
system:
string
Droga jaką przelew ma być rozliczony / The way the transfer should be settled
Enum:
SEPA , InstantSEPA , Target
hold:
boolean
Czy założyć blokadę (w przypadku np. zlecenia przelewu w dniu wolnym) / Indicates if payment should be holded
executionMode:
string
Tryb realizacji płatności. Nadrzędna informacja decydująca o tym w jakim trybie zostanie zrealizowana płatność. / Payment execution mode. The superior information deciding which mode is to be used to execute payment.
Enum:
Immediate , FutureDated , Recurring
}
]
nonEEATransfers:
[
Lista struktur danych przelewów zagranicznych innych niż SEPA, które zostaną zlecone. Wymagane gdy typeOfTransfers = nonEEA. / The list of data structures of non SEPA foreign transfers to be initiated. Required when typeOfTransfers = nonEEA.
{
Klasa zlecenia przelewu zagranicznego innego niż SEPA w ramach paczki / NonEEA Transfer inside bundle Request Class
Required: deliveryMode,recipient,recipientBank,sender,tppTransactionId,transferData
recipient:
{
Klasa zawierająca dane odbiorcy używana w żądaniach PIS dla operacji zagranicznych / PIS foreign Recipient Data Class
Required: accountNumber,name
accountNumber:
string
Numer konta, format dla przelewów zagranicznych
address:
[
(1..4)
Klasa zawierająca dane adresu pocztowego / Postal address Class
]
}
recipientBank:
{
Klasa zawierająca dane banku używana w żądaniach AIS / AIS Bank Data Class
bicOrSwift:
string
maxLength:11
Numer BIC/SWIFT Banku / BIC/SWIFT number
name:
string
maxLength:70
Nazwa Banku / Bank's name
code:
string
maxLength:10
Kod Banku, dla przelewów zagranicznych / Bank's code
countryCode:
string
maxLength:3
Kod kraju 3166-1 / Country code
address:
[
(1..4)
Klasa zawierająca dane adresu pocztowego / Postal address Class
]
}
sender:
{
Klasa zawierająca dane nadawcy przelewu zagranicznego używana w żądaniach PIS / Foreign PIS services Sender Data Class
name:
string
maxLength:140
Nazwa nadawcy / Sender name
}
transferData:
{
Klasa zawierająca dane przelewu / Transfer Data Class
}
all of:
{
Bazowa klasa dla TransferData / TransferData Base Class
description:
string
maxLength:140
Pole opisujące przelew / Description
amount:
string
Pattern: ^\d*\.\d{2}$
executionDate:
string
(date)
Data wykonania przelewu. Wymagany pod warunkiem przekazania wartości FutureDated w atrybucie executionMode. Format: YYYY-MM-DD / Date when the transfer is to be executed (YYYY-MM-DD). Required conditionally if executionMode attribute has value FutureDated.
recurrence:
{
Klasa definiująca parametry płatności cyklicznej / A class defining recurring payment parameters
Required: dayOffOffsetType,endDate,frequency,startDate
startDate:
string
(date)
Data wykonania pierwszej płatności w definiowanym cyklu. Format: YYYY-MM-DD / First payment execution date (of the defined cycle).
frequency:
{
Klasa opisująca parametry częśtotliwości wykonywania płatności cyklicznej / A class defining parameters of the frequency of recurring paymenets
Required: periodType,periodValue
periodType:
string
Typ jednostki okresu czasu / The type of unit of time period
Enum:
day , week , month
periodValue:
integer
minimum:1
Wartość jednostki okresu czasu / The value of unit of time period
}
endDate:
string
(date)
Ostatnia możliwa data wykonania płatności w definiowanym cyklu. Format: YYYY-MM-DD / The last possible payment execution date (of the defined cycle).
dayOffOffsetType:
string
Rodzaj przesunięcia, który należy zastosować do wykonania przelewu w przypadku, gdy dzień wolny jest planowaną datą przelewu / Type of offset that should be used for transfer execution in case of day off being the planned date of transfer
Enum:
before , after
}
}
{
Required: currency
currency:
string
maxLength:3
Waluta, domyślnie EUR przelewów zagranicznych / Currency
}
transferCharges:
string
maxLength:3
Klauzula kosztowa / The cost clause
tppTransactionId:
string
maxLength:64
ID transakcji nadany przez TPP / Transaction ID (TPP)
deliveryMode:
string
Tryb pilności / Urgency mode
Enum:
ExpressD0 , UrgentD1 , StandardD2
system:
string
Droga jaką przelew ma być rozliczony / The way the transfer should be settled
Enum:
Swift
hold:
boolean
Czy założyć blokadę (w przypadku np. zlecenia przelewu w dniu wolnym) / Indicates if payment should be holded
executionMode:
string
Tryb realizacji płatności. Nadrzędna informacja decydująca o tym w jakim trybie zostanie zrealizowana płatność. / Payment execution mode. The superior information deciding which mode is to be used to execute payment.
Enum:
Immediate , FutureDated , Recurring
}
]
taxTransfers:
[
Lista struktur danych przelewów do urzędu podatkowego, które zostaną zlecone. Wymagane gdy typeOfTransfers = tax. / The list of data structures of tax transfers to be initiated. Required when typeOfTransfers = tax.
{
Klasa zlecenia przelewu podatkowego w ramach paczki / Tax Transfer inside bundle Request Class
Required: deliveryMode,recipient,sender,tppTransactionId,transferData
recipient:
{
Klasa zawierająca dane odbiorcy używana w żądaniach PIS dla operacji podatkowych / PIS Tax Recipient Data Class
Required: accountNumber,nameAddress
nameAddress:
{
Klasa zawierająca dane nazwy i adresu w postaci czterech linii danych / Simple name and postal address Class
}
}
sender:
{
Klasa zawierająca dane nadawcy przelewu krajowego używana w żądaniach PIS / Domestic PIS services Sender Data Class
nameAddress:
{
Klasa zawierająca dane nazwy i adresu w postaci czterech linii danych / Simple name and postal address Class
}
}
transferData:
{
Klasa zawierająca dane przelewu / Transfer Data Class
}
all of:
{
Bazowa klasa dla TransferData / TransferData Base Class
amount:
string
Pattern: ^\d*\.\d{2}$
executionDate:
string
(date)
Data wykonania przelewu. Wymagany pod warunkiem przekazania wartości FutureDated w atrybucie executionMode. Format: YYYY-MM-DD / Date when the transfer is to be executed (YYYY-MM-DD). Required conditionally if executionMode attribute has value FutureDated.
recurrence:
{
Klasa definiująca parametry płatności cyklicznej / A class defining recurring payment parameters
Required: dayOffOffsetType,endDate,frequency,startDate
startDate:
string
(date)
Data wykonania pierwszej płatności w definiowanym cyklu. Format: YYYY-MM-DD / First payment execution date (of the defined cycle).
frequency:
{
Klasa opisująca parametry częśtotliwości wykonywania płatności cyklicznej / A class defining parameters of the frequency of recurring paymenets
Required: periodType,periodValue
periodType:
string
Typ jednostki okresu czasu / The type of unit of time period
Enum:
day , week , month
periodValue:
integer
minimum:1
Wartość jednostki okresu czasu / The value of unit of time period
}
endDate:
string
(date)
Ostatnia możliwa data wykonania płatności w definiowanym cyklu. Format: YYYY-MM-DD / The last possible payment execution date (of the defined cycle).
dayOffOffsetType:
string
Rodzaj przesunięcia, który należy zastosować do wykonania przelewu w przypadku, gdy dzień wolny jest planowaną datą przelewu / Type of offset that should be used for transfer execution in case of day off being the planned date of transfer
Enum:
before , after
}
}
{
Required: currency
currency:
string
maxLength:3
Waluta, domyślnie EUR przelewów zagranicznych / Currency
}
usInfo:
{
Klasa informacji danych dla przelewu podatkowego do Urzędu Skarbowego lub Izby Celnej / Tax Transfer
Required: formCode,payerInfo,periodId,periodType,year
payerInfo:
{
Klasa informacji o płatniku do US / Tax Payor Information Class
Required: payorId,payorIdType
payorId:
string
maxLength:20
Identyfikator płatnika / Payor ID
payorIdType:
string
maxLength:20
Typ identyfikatora płatnika / Payor ID type
Enum:
N , P , R , 1 , 2 , 3
}
formCode:
string
maxLength:7
Symbol formularza Urzędu Skarbowego lub Izby Celnej / Tax authority form symbol
periodId:
string
maxLength:7
Numer okresu / Period number
year:
integer
(int32)
maximum:9999
obligationId:
string
maxLength:40
Identyfikator zobowiązania, z którego wynika należność podatku np. decyzja, tytuł wykonawczy, postanowienie / Obligation ID
}
tppTransactionId:
string
maxLength:64
ID transakcji nadany przez TPP / Transaction ID (TPP)
deliveryMode:
string
Tryb pilności / Urgency mode
Enum:
ExpressD0 , StandardD1
system:
string
Droga jaką przelew ma być rozliczony / The way the transfer should be settled
Enum:
Elixir , ExpressElixir
hold:
boolean
Czy założyć blokadę (w przypadku np. zlecenia przelewu w dniu wolnym) / Indicates if payment should be holded
executionMode:
string
Tryb realizacji płatności. Nadrzędna informacja decydująca o tym w jakim trybie zostanie zrealizowana płatność. / Payment execution mode. The superior information deciding which mode is to be used to execute payment.
Enum:
Immediate , FutureDated , Recurring
}
]
}
|