swagger: "2.0" info: version: "2_0_5" title: "Polish API" description: "Interface specification for services provided by third parties based on access to payment accounts. Prepared by the Polish Bank Association and its affiliates" host: apiHost basePath: / schemes: - https consumes: - application/json produces: - application/json tags: - name: "AS" description: "Authorization Service" - name: "AIS" description: "Account Information Service" - name: "PIS" description: "Payment Initiation Services" - name: "CAF" description: "Confirmation of the Availability of Funds" parameters: authorizationParam: name: Authorization in: header required: true type: string description: "The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'." acceptEncodingParam: name: Accept-Encoding in: header required: true type: string enum: - gzip - deflate description: "Gzip, deflate" acceptLanguageParam: name: Accept-Language in: header required: true type: string description: "Prefered language of response" acceptCharsetParam: name: Accept-Charset in: header required: true type: string enum: - utf-8 description: "UTF-8" xjwsSignatureParam: name: X-JWS-SIGNATURE in: header required: true type: string description: "Detached JWS signature of the body of the payload" paths: /v2_0_5.1/auth/v2_0_5.1/authorize: x-swagger-router-controller: as post: summary: "Requests OAuth2 authorization code" description: "Requests OAuth2 authorization code" operationId: authorize parameters: - $ref: "#/parameters/acceptEncodingParam" - $ref: "#/parameters/acceptLanguageParam" - $ref: "#/parameters/acceptCharsetParam" - $ref: "#/parameters/xjwsSignatureParam" - name: authorizeRequest in: body description: "Data for OAuth2 Authorization Code Request" required: true schema: $ref: "#/definitions/AuthorizeRequest" tags: - AS responses: "302": description: "Redirection" headers: Content-Encoding: type: string description: "Gzip, deflate" Location: type: string description: "URI reference for redirection" "400": description: "Bad request" schema: $ref: "#/definitions/Error" "405": description: "Method Not Allowed" schema: $ref: "#/definitions/Error" "406": description: "Not Acceptable" schema: $ref: "#/definitions/Error" "415": description: "Unsupported Media Type" schema: $ref: "#/definitions/Error" "422": description: "Unprocessable entity" schema: $ref: "#/definitions/Error" "500": description: "Internal Server Error" schema: $ref: "#/definitions/Error" "503": description: "Service Unavailable" schema: $ref: "#/definitions/Error" /v2_0_5.1/auth/v2_0_5.1/authorizeExt: x-swagger-router-controller: as post: summary: "Requests OAuth2 authorization code based on One-time authorization code issued by External Authorization Tool" description: "Requests OAuth2 authorization code based One-time authorization code issued by External Authorization Tool. Authorization code will be delivered to TPP as callback request from ASPSP if PSU authentication is confirmed by EAT. Callback function must provide similar notification also in case of unsuccessful authentication or its abandonment." operationId: authorizeExt parameters: - $ref: "#/parameters/acceptEncodingParam" - $ref: "#/parameters/acceptLanguageParam" - $ref: "#/parameters/acceptCharsetParam" - $ref: "#/parameters/xjwsSignatureParam" - name: eatCodeRequest in: body description: "Data for OAuth2 Authorization Code Request extended for EAT based authentication and callback response" required: true schema: $ref: "#/definitions/EatCodeRequest" tags: - AS responses: "204": description: Successful TPP and EAT Code verification headers: Content-Encoding: type: string description: "Gzip, deflate" "400": description: "Bad request" schema: $ref: "#/definitions/Error" "405": description: "Method Not Allowed" schema: $ref: "#/definitions/Error" "406": description: "Not Acceptable" schema: $ref: "#/definitions/Error" "415": description: "Unsupported Media Type" schema: $ref: "#/definitions/Error" "422": description: "Unprocessable entity" schema: $ref: "#/definitions/Error" "500": description: "Internal Server Error" schema: $ref: "#/definitions/Error" "503": description: "Service Unavailable" schema: $ref: "#/definitions/Error" /v2_0_5.1/auth/v2_0_5.1/token: x-swagger-router-controller: as post: summary: "Requests OAuth2 access token value" description: "Requests OAuth2 access token value" operationId: token parameters: - $ref: "#/parameters/acceptEncodingParam" - $ref: "#/parameters/acceptLanguageParam" - $ref: "#/parameters/acceptCharsetParam" - $ref: "#/parameters/xjwsSignatureParam" - name: tokenRequest in: body description: "Data for OAuth2 Access Token Request" required: true schema: $ref: "#/definitions/TokenRequest" tags: - AS responses: "200": description: Success schema: $ref: "#/definitions/TokenResponse" headers: Content-Encoding: type: string description: "Gzip, deflate" X-JWS-SIGNATURE: type: string description: "Detached JWS signature of the body of the response" "400": description: "Bad request" schema: $ref: "#/definitions/Error" "401": description: "Unauthorized" schema: $ref: "#/definitions/Error" "405": description: "Method Not Allowed" schema: $ref: "#/definitions/Error" "406": description: "Not Acceptable" schema: $ref: "#/definitions/Error" "415": description: "Unsupported Media Type" schema: $ref: "#/definitions/Error" "422": description: "Unprocessable entity" schema: $ref: "#/definitions/Error" "500": description: "Internal Server Error" schema: $ref: "#/definitions/Error" "503": description: "Service Unavailable" schema: $ref: "#/definitions/Error" /v2_0_5.1/accounts/v2_0_5.1/deleteConsent: x-swagger-router-controller: ais post: summary: "Removes consent" description: "Removes consent" operationId: deleteConsent parameters: - $ref: "#/parameters/acceptEncodingParam" - $ref: "#/parameters/acceptLanguageParam" - $ref: "#/parameters/acceptCharsetParam" - name: deleteConsentRequest in: body description: "Data for delete Consent Request" required: true schema: $ref: "#/definitions/DeleteConsentRequest" tags: - AIS responses: "204": description: Success headers: Content-Encoding: type: string description: "Gzip, deflate" "400": description: "Bad request" schema: $ref: "#/definitions/Error" "401": description: "Unauthorized" schema: $ref: "#/definitions/Error" "403": description: "Forbidden" schema: $ref: "#/definitions/Error" "405": description: "Method Not Allowed" schema: $ref: "#/definitions/Error" "406": description: "Not Acceptable" schema: $ref: "#/definitions/Error" "415": description: "Unsupported Media Type" schema: $ref: "#/definitions/Error" "422": description: "Unprocessable entity" schema: $ref: "#/definitions/Error" "500": description: "Internal Server Error" schema: $ref: "#/definitions/Error" "503": description: "Service Unavailable" schema: $ref: "#/definitions/Error" /v2_0_5.1/accounts/v2_0_5.1/getAccounts: x-swagger-router-controller: ais post: summary: "Get information about all user's payment account" description: "User identification based on access token" operationId: getAccounts parameters: - $ref: "#/parameters/authorizationParam" - $ref: "#/parameters/acceptEncodingParam" - $ref: "#/parameters/acceptLanguageParam" - $ref: "#/parameters/acceptCharsetParam" - $ref: "#/parameters/xjwsSignatureParam" - name: getAccountsRequest in: body description: "Data for Accounts Request" required: true schema: $ref: "#/definitions/AccountsRequest" tags: - AIS responses: "200": description: Success schema: $ref: "#/definitions/AccountsResponse" headers: Content-Encoding: type: string description: "Gzip, deflate" #required: false X-JWS-SIGNATURE: type: string description: "Detached JWS signature of the body of the response" "400": description: "Bad request" schema: $ref: "#/definitions/Error" "401": description: "Unauthorized" schema: $ref: "#/definitions/Error" "403": description: "Forbidden" schema: $ref: "#/definitions/Error" "405": description: "Method Not Allowed" schema: $ref: "#/definitions/Error" "406": description: "Not Acceptable" schema: $ref: "#/definitions/Error" "415": description: "Unsupported Media Type" schema: $ref: "#/definitions/Error" "422": description: "Unprocessable entity" schema: $ref: "#/definitions/Error" "429": description: "Request limit for the requested service exceeded" schema: $ref: "#/definitions/Error" "500": description: "Internal Server Error" schema: $ref: "#/definitions/Error" "503": description: "Service Unavailable" schema: $ref: "#/definitions/Error" security: - xs2a_auth_aspsp: - "ais-accounts" - xs2a_auth_decoupled: - "ais-accounts" /v2_0_5.1/accounts/v2_0_5.1/getAccount: x-swagger-router-controller: ais post: summary: "Get detailed information about user payment account" description: "User identification based on access token" operationId: getAccount parameters: - $ref: "#/parameters/authorizationParam" - $ref: "#/parameters/acceptEncodingParam" - $ref: "#/parameters/acceptLanguageParam" - $ref: "#/parameters/acceptCharsetParam" - $ref: "#/parameters/xjwsSignatureParam" - name: getAccountRequest in: body description: "Data for Account Request" required: true schema: $ref: "#/definitions/AccountInfoRequest" tags: - AIS responses: "200": description: Success schema: $ref: "#/definitions/AccountResponse" headers: Content-Encoding: type: string description: "Gzip, deflate" X-JWS-SIGNATURE: type: string description: "Detached JWS signature of the body of the response" "400": description: "Bad request" schema: $ref: "#/definitions/Error" "401": description: "Unauthorized" schema: $ref: "#/definitions/Error" "403": description: "Forbidden" schema: $ref: "#/definitions/Error" "405": description: "Method Not Allowed" schema: $ref: "#/definitions/Error" "406": description: "Not Acceptable" schema: $ref: "#/definitions/Error" "415": description: "Unsupported Media Type" schema: $ref: "#/definitions/Error" "422": description: "Unprocessable entity" schema: $ref: "#/definitions/Error" "429": description: "Request limit for the requested service exceeded" schema: $ref: "#/definitions/Error" "500": description: "Internal Server Error" schema: $ref: "#/definitions/Error" "503": description: "Service Unavailable" schema: $ref: "#/definitions/Error" security: - xs2a_auth_aspsp: - "ais" - xs2a_auth_decoupled: - "ais" /v2_0_5.1/accounts/v2_0_5.1/getTransactionsDone: x-swagger-router-controller: ais post: summary: "Get list of user done transactions" description: "" operationId: getTransactionsDone parameters: - $ref: "#/parameters/authorizationParam" - $ref: "#/parameters/acceptEncodingParam" - $ref: "#/parameters/acceptLanguageParam" - $ref: "#/parameters/acceptCharsetParam" - $ref: "#/parameters/xjwsSignatureParam" - name: getTransactionsDoneRequest in: body description: "Data for Transactions Done Request" required: true schema: $ref: "#/definitions/TransactionInfoRequest" tags: - AIS responses: "200": description: Success schema: $ref: "#/definitions/TransactionsDoneInfoResponse" headers: Content-Encoding: type: string description: "Gzip, deflate" X-JWS-SIGNATURE: type: string description: "Detached JWS signature of the body of the response" "400": description: "Bad request" schema: $ref: "#/definitions/Error" "401": description: "Unauthorized" schema: $ref: "#/definitions/Error" "403": description: "Forbidden" schema: $ref: "#/definitions/Error" "405": description: "Method Not Allowed" schema: $ref: "#/definitions/Error" "406": description: "Not Acceptable" schema: $ref: "#/definitions/Error" "415": description: "Unsupported Media Type" schema: $ref: "#/definitions/Error" "422": description: "Unprocessable entity" schema: $ref: "#/definitions/Error" "429": description: "Request limit for the requested service exceeded" schema: $ref: "#/definitions/Error" "500": description: "Internal Server Error" schema: $ref: "#/definitions/Error" "503": description: "Service Unavailable" schema: $ref: "#/definitions/Error" security: - xs2a_auth_aspsp: - "ais" - xs2a_auth_decoupled: - "ais" /v2_0_5.1/accounts/v2_0_5.1/getTransactionsPending: x-swagger-router-controller: ais post: summary: "Get list of user's pending transactions" description: "" operationId: getTransactionsPending parameters: - $ref: "#/parameters/authorizationParam" - $ref: "#/parameters/acceptEncodingParam" - $ref: "#/parameters/acceptLanguageParam" - $ref: "#/parameters/acceptCharsetParam" - $ref: "#/parameters/xjwsSignatureParam" - name: getTransactionsPendingRequest in: body description: "Data for Transactions Pending Request" required: true schema: $ref: "#/definitions/TransactionInfoRequest" tags: - AIS responses: "200": description: Success schema: $ref: "#/definitions/TransactionPendingInfoResponse" headers: Content-Encoding: type: string description: "Gzip, deflate" X-JWS-SIGNATURE: type: string description: "Detached JWS signature of the body of the response" "400": description: "Bad request" schema: $ref: "#/definitions/Error" "401": description: "Unauthorized" schema: $ref: "#/definitions/Error" "403": description: "Forbidden" schema: $ref: "#/definitions/Error" "405": description: "Method Not Allowed" schema: $ref: "#/definitions/Error" "406": description: "Not Acceptable" schema: $ref: "#/definitions/Error" "415": description: "Unsupported Media Type" schema: $ref: "#/definitions/Error" "422": description: "Unprocessable entity" schema: $ref: "#/definitions/Error" "429": description: "Request limit for the requested service exceeded" schema: $ref: "#/definitions/Error" "500": description: "Internal Server Error" schema: $ref: "#/definitions/Error" "503": description: "Service Unavailable" schema: $ref: "#/definitions/Error" security: - xs2a_auth_aspsp: - "ais" - xs2a_auth_decoupled: - "ais" /v2_0_5.1/accounts/v2_0_5.1/getTransactionsRejected: x-swagger-router-controller: ais post: summary: "Get list of user's rejected transactions" description: "" operationId: getTransactionsRejected parameters: - $ref: "#/parameters/authorizationParam" - $ref: "#/parameters/acceptEncodingParam" - $ref: "#/parameters/acceptLanguageParam" - $ref: "#/parameters/acceptCharsetParam" - $ref: "#/parameters/xjwsSignatureParam" - name: getTransactionsRejectedRequest in: body description: "Data for Transactions Rejected Request" required: true schema: $ref: "#/definitions/TransactionInfoRequest" tags: - AIS responses: "200": description: Success schema: $ref: "#/definitions/TransactionRejectedInfoResponse" headers: Content-Encoding: type: string description: "Gzip, deflate" X-JWS-SIGNATURE: type: string description: "Detached JWS signature of the body of the response" "400": description: "Bad request" schema: $ref: "#/definitions/Error" "401": description: "Unauthorized" schema: $ref: "#/definitions/Error" "403": description: "Forbidden" schema: $ref: "#/definitions/Error" "405": description: "Method Not Allowed" schema: $ref: "#/definitions/Error" "406": description: "Not Acceptable" schema: $ref: "#/definitions/Error" "415": description: "Unsupported Media Type" schema: $ref: "#/definitions/Error" "422": description: "Unprocessable entity" schema: $ref: "#/definitions/Error" "429": description: "Request limit for the requested service exceeded" schema: $ref: "#/definitions/Error" "500": description: "Internal Server Error" schema: $ref: "#/definitions/Error" "503": description: "Service Unavailable" schema: $ref: "#/definitions/Error" security: - xs2a_auth_aspsp: - "ais" - xs2a_auth_decoupled: - "ais" /v2_0_5.1/accounts/v2_0_5.1/getTransactionsCancelled: x-swagger-router-controller: ais post: summary: "Get list of user cancelled transactions" description: "" operationId: getTransactionsCancelled parameters: - $ref: "#/parameters/authorizationParam" - $ref: "#/parameters/acceptEncodingParam" - $ref: "#/parameters/acceptLanguageParam" - $ref: "#/parameters/acceptCharsetParam" - $ref: "#/parameters/xjwsSignatureParam" - name: getTransactionsCancelledRequest in: body description: "Data for Transactions Cancelled Request" required: true schema: $ref: "#/definitions/TransactionInfoRequest" tags: - AIS responses: "200": description: Success schema: $ref: "#/definitions/TransactionsCancelledInfoResponse" headers: Content-Encoding: type: string description: "Gzip, deflate" X-JWS-SIGNATURE: type: string description: "Detached JWS signature of the body of the response" "400": description: "Bad request" schema: $ref: "#/definitions/Error" "401": description: "Unauthorized" schema: $ref: "#/definitions/Error" "403": description: "Forbidden" schema: $ref: "#/definitions/Error" "405": description: "Method Not Allowed" schema: $ref: "#/definitions/Error" "406": description: "Not Acceptable" schema: $ref: "#/definitions/Error" "415": description: "Unsupported Media Type" schema: $ref: "#/definitions/Error" "422": description: "Unprocessable entity" schema: $ref: "#/definitions/Error" "429": description: "Request limit for the requested service exceeded" schema: $ref: "#/definitions/Error" "500": description: "Internal Server Error" schema: $ref: "#/definitions/Error" "503": description: "Service Unavailable" schema: $ref: "#/definitions/Error" security: - xs2a_auth_aspsp: - "ais" - xs2a_auth_decoupled: - "ais" /v2_0_5.1/accounts/v2_0_5.1/getTransactionsScheduled: x-swagger-router-controller: ais post: summary: "Get list of user scheduled transactions" description: "" operationId: getTransactionsScheduled parameters: - $ref: "#/parameters/authorizationParam" - $ref: "#/parameters/acceptEncodingParam" - $ref: "#/parameters/acceptLanguageParam" - $ref: "#/parameters/acceptCharsetParam" - $ref: "#/parameters/xjwsSignatureParam" - name: getTransactionsCancelledRequest in: body description: "Data for Transactions Scheduled Request" required: true schema: $ref: "#/definitions/TransactionInfoRequest" tags: - AIS responses: "200": description: Success schema: $ref: "#/definitions/TransactionsScheduledInfoResponse" headers: Content-Encoding: type: string description: "Gzip, deflate" X-JWS-SIGNATURE: type: string description: "Detached JWS signature of the body of the response" "400": description: "Bad request" schema: $ref: "#/definitions/Error" "401": description: "Unauthorized" schema: $ref: "#/definitions/Error" "403": description: "Forbidden" schema: $ref: "#/definitions/Error" "405": description: "Method Not Allowed" schema: $ref: "#/definitions/Error" "406": description: "Not Acceptable" schema: $ref: "#/definitions/Error" "415": description: "Unsupported Media Type" schema: $ref: "#/definitions/Error" "422": description: "Unprocessable entity" schema: $ref: "#/definitions/Error" "429": description: "Request limit for the requested service exceeded" schema: $ref: "#/definitions/Error" "500": description: "Internal Server Error" schema: $ref: "#/definitions/Error" "503": description: "Service Unavailable" schema: $ref: "#/definitions/Error" security: - xs2a_auth_aspsp: - "ais" - xs2a_auth_decoupled: - "ais" /v2_0_5.1/accounts/v2_0_5.1/getHolds: x-swagger-router-controller: ais post: summary: Get list of user's holded operations description: "" operationId: getHolds parameters: - $ref: "#/parameters/authorizationParam" - $ref: "#/parameters/acceptEncodingParam" - $ref: "#/parameters/acceptLanguageParam" - $ref: "#/parameters/acceptCharsetParam" - $ref: "#/parameters/xjwsSignatureParam" - name: getHoldsRequest in: body description: "Data for hold Request" required: true schema: $ref: "#/definitions/TransactionHoldRequest" tags: - AIS responses: "200": description: Success schema: $ref: "#/definitions/TransactionHoldInfoResponse" headers: Content-Encoding: type: string description: "Gzip, deflate" X-JWS-SIGNATURE: type: string description: "Detached JWS signature of the body of the response" "400": description: "Bad request" schema: $ref: "#/definitions/Error" "401": description: "Unauthorized" schema: $ref: "#/definitions/Error" "403": description: "Forbidden" schema: $ref: "#/definitions/Error" "405": description: "Method Not Allowed" schema: $ref: "#/definitions/Error" "406": description: "Not Acceptable" schema: $ref: "#/definitions/Error" "415": description: "Unsupported Media Type" schema: $ref: "#/definitions/Error" "422": description: "Unprocessable entity" schema: $ref: "#/definitions/Error" "429": description: "Request limit for the requested service exceeded" schema: $ref: "#/definitions/Error" "500": description: "Internal Server Error" schema: $ref: "#/definitions/Error" "503": description: "Service Unavailable" schema: $ref: "#/definitions/Error" security: - xs2a_auth_aspsp: - "ais" - xs2a_auth_decoupled: - "ais" /v2_0_5.1/accounts/v2_0_5.1/getTransactionDetail: x-swagger-router-controller: ais post: summary: "Get detailed information about user's single transaction" description: "" operationId: getTransactionDetail parameters: - $ref: "#/parameters/authorizationParam" - $ref: "#/parameters/acceptEncodingParam" - $ref: "#/parameters/acceptLanguageParam" - $ref: "#/parameters/acceptCharsetParam" - $ref: "#/parameters/xjwsSignatureParam" - name: getTransationDetailRequest in: body description: "Data for transation detail Request" required: true schema: $ref: "#/definitions/TransactionDetailRequest" tags: - AIS responses: "200": description: Success schema: $ref: "#/definitions/TransactionDetailResponse" headers: Content-Encoding: type: string description: "Gzip, deflate" X-JWS-SIGNATURE: type: string description: "Detached JWS signature of the body of the response" "400": description: "Bad request" schema: $ref: "#/definitions/Error" "401": description: "Unauthorized" schema: $ref: "#/definitions/Error" "403": description: "Forbidden" schema: $ref: "#/definitions/Error" "405": description: "Method Not Allowed" schema: $ref: "#/definitions/Error" "406": description: "Not Acceptable" schema: $ref: "#/definitions/Error" "415": description: "Unsupported Media Type" schema: $ref: "#/definitions/Error" "422": description: "Unprocessable entity" schema: $ref: "#/definitions/Error" "429": description: "Request limit for the requested service exceeded" schema: $ref: "#/definitions/Error" "500": description: "Internal Server Error" schema: $ref: "#/definitions/Error" "503": description: "Service Unavailable" schema: $ref: "#/definitions/Error" security: - xs2a_auth_aspsp: - "ais" - xs2a_auth_decoupled: - "ais" /v2_0_5.1/payments/v2_0_5.1/domestic: x-swagger-router-controller: pis post: summary: "Initiate domestic transfer" description: "" operationId: domestic parameters: - $ref: "#/parameters/authorizationParam" - $ref: "#/parameters/acceptEncodingParam" - $ref: "#/parameters/acceptLanguageParam" - $ref: "#/parameters/acceptCharsetParam" - $ref: "#/parameters/xjwsSignatureParam" - name: domesticRequest in: body description: "Data for domestic transfer" required: true schema: $ref: "#/definitions/PaymentDomesticRequest" tags: - PIS responses: "200": description: Success schema: $ref: "#/definitions/AddPaymentResponse" headers: Content-Encoding: type: string description: "Gzip, deflate" X-JWS-SIGNATURE: type: string description: "Detached JWS signature of the body of the response" "400": description: "Bad request" schema: $ref: "#/definitions/Error" "401": description: "Unauthorized" schema: $ref: "#/definitions/Error" "403": description: "Forbidden" schema: $ref: "#/definitions/Error" "405": description: "Method Not Allowed" schema: $ref: "#/definitions/Error" "406": description: "Not Acceptable" schema: $ref: "#/definitions/Error" "415": description: "Unsupported Media Type" schema: $ref: "#/definitions/Error" "422": description: "Unprocessable entity" schema: $ref: "#/definitions/Error" "500": description: "Internal Server Error" schema: $ref: "#/definitions/Error" "503": description: "Service Unavailable" schema: $ref: "#/definitions/Error" security: - xs2a_auth_aspsp: - "pis" - xs2a_auth_decoupled: - "pis" /v2_0_5.1/payments/v2_0_5.1/EEA: x-swagger-router-controller: pis post: summary: "Initiate SEPA foreign transfers" description: "" operationId: EEA parameters: - $ref: "#/parameters/authorizationParam" - $ref: "#/parameters/acceptEncodingParam" - $ref: "#/parameters/acceptLanguageParam" - $ref: "#/parameters/acceptCharsetParam" - $ref: "#/parameters/xjwsSignatureParam" - name: EEARequest in: body description: "Data for SEPA foreign transfer" required: true schema: $ref: "#/definitions/PaymentEEARequest" tags: - PIS responses: "200": description: Success schema: $ref: "#/definitions/AddPaymentResponse" headers: Content-Encoding: type: string description: "Gzip, deflate" X-JWS-SIGNATURE: type: string description: "Detached JWS signature of the body of the response" "400": description: "Bad request" schema: $ref: "#/definitions/Error" "401": description: "Unauthorized" schema: $ref: "#/definitions/Error" "403": description: "Forbidden" schema: $ref: "#/definitions/Error" "405": description: "Method Not Allowed" schema: $ref: "#/definitions/Error" "406": description: "Not Acceptable" schema: $ref: "#/definitions/Error" "415": description: "Unsupported Media Type" schema: $ref: "#/definitions/Error" "422": description: "Unprocessable entity" schema: $ref: "#/definitions/Error" "500": description: "Internal Server Error" schema: $ref: "#/definitions/Error" "503": description: "Service Unavailable" schema: $ref: "#/definitions/Error" security: - xs2a_auth_aspsp: - "pis" - xs2a_auth_decoupled: - "pis" /v2_0_5.1/payments/v2_0_5.1/nonEEA: x-swagger-router-controller: pis post: summary: "Initiate non SEPA foreign transfers" operationId: nonEEA parameters: - $ref: "#/parameters/authorizationParam" - $ref: "#/parameters/acceptEncodingParam" - $ref: "#/parameters/acceptLanguageParam" - $ref: "#/parameters/acceptCharsetParam" - $ref: "#/parameters/xjwsSignatureParam" - name: nonEEARequest in: body description: "Data for non SEPA foreign transfer" required: true schema: $ref: "#/definitions/PaymentNonEEARequest" tags: - PIS responses: "200": description: Success schema: $ref: "#/definitions/AddPaymentResponse" headers: Content-Encoding: type: string description: "Gzip, deflate" X-JWS-SIGNATURE: type: string description: "Detached JWS signature of the body of the response" "400": description: "Bad request" schema: $ref: "#/definitions/Error" "401": description: "Unauthorized" schema: $ref: "#/definitions/Error" "403": description: "Forbidden" schema: $ref: "#/definitions/Error" "405": description: "Method Not Allowed" schema: $ref: "#/definitions/Error" "406": description: "Not Acceptable" schema: $ref: "#/definitions/Error" "415": description: "Unsupported Media Type" schema: $ref: "#/definitions/Error" "422": description: "Unprocessable entity" schema: $ref: "#/definitions/Error" "500": description: "Internal Server Error" schema: $ref: "#/definitions/Error" "503": description: "Service Unavailable" schema: $ref: "#/definitions/Error" security: - xs2a_auth_aspsp: - "pis" - xs2a_auth_decoupled: - "pis" /v2_0_5.1/payments/v2_0_5.1/tax: x-swagger-router-controller: pis post: summary: "Initiate tax transfer" description: "" operationId: tax parameters: - $ref: "#/parameters/authorizationParam" - $ref: "#/parameters/acceptEncodingParam" - $ref: "#/parameters/acceptLanguageParam" - $ref: "#/parameters/acceptCharsetParam" - $ref: "#/parameters/xjwsSignatureParam" - name: taxRequest in: body description: "Data for tax transfer" required: true schema: $ref: "#/definitions/PaymentTaxRequest" tags: - PIS responses: "200": description: Success schema: $ref: "#/definitions/AddPaymentResponse" headers: Content-Encoding: type: string description: "Gzip, deflate" X-JWS-SIGNATURE: type: string description: "Detached JWS signature of the body of the response" "400": description: "Bad request" schema: $ref: "#/definitions/Error" "401": description: "Unauthorized" schema: $ref: "#/definitions/Error" "403": description: "Forbidden" schema: $ref: "#/definitions/Error" "405": description: "Method Not Allowed" schema: $ref: "#/definitions/Error" "406": description: "Not Acceptable" schema: $ref: "#/definitions/Error" "415": description: "Unsupported Media Type" schema: $ref: "#/definitions/Error" "422": description: "Unprocessable entity" schema: $ref: "#/definitions/Error" "500": description: "Internal Server Error" schema: $ref: "#/definitions/Error" "503": description: "Service Unavailable" schema: $ref: "#/definitions/Error" security: - xs2a_auth_aspsp: - "pis" - xs2a_auth_decoupled: - "pis" /v2_0_5.1/payments/v2_0_5.1/bundle: x-swagger-router-controller: pis post: summary: "Initiate many transfers as bundle" description: "" operationId: bundle parameters: - $ref: "#/parameters/authorizationParam" - $ref: "#/parameters/acceptEncodingParam" - $ref: "#/parameters/acceptLanguageParam" - $ref: "#/parameters/acceptCharsetParam" - $ref: "#/parameters/xjwsSignatureParam" - name: bundleRequest in: body description: "Data for bundle of transfers" required: true schema: $ref: "#/definitions/PaymentsBundleRequest" tags: - PIS responses: "200": description: Success schema: $ref: "#/definitions/PaymentsBundleResponse" headers: Content-Encoding: type: string description: "Gzip, deflate" X-JWS-SIGNATURE: type: string description: "Detached JWS signature of the body of the response" "400": description: "Bad request" schema: $ref: "#/definitions/Error" "401": description: "Unauthorized" schema: $ref: "#/definitions/Error" "403": description: "Forbidden" schema: $ref: "#/definitions/Error" "405": description: "Method Not Allowed" schema: $ref: "#/definitions/Error" "406": description: "Not Acceptable" schema: $ref: "#/definitions/Error" "415": description: "Unsupported Media Type" schema: $ref: "#/definitions/Error" "422": description: "Unprocessable entity" schema: $ref: "#/definitions/Error" "500": description: "Internal Server Error" schema: $ref: "#/definitions/Error" "503": description: "Service Unavailable" schema: $ref: "#/definitions/Error" security: - xs2a_auth_aspsp: - "pis" - xs2a_auth_decoupled: - "pis" /v2_0_5.1/payments/v2_0_5.1/getPayment: x-swagger-router-controller: pis post: summary: "Get the status of payment" operationId: getPayment parameters: - $ref: "#/parameters/authorizationParam" - $ref: "#/parameters/acceptEncodingParam" - $ref: "#/parameters/acceptLanguageParam" - $ref: "#/parameters/acceptCharsetParam" - $ref: "#/parameters/xjwsSignatureParam" - name: payment in: body description: "Payment ID" required: true schema: $ref: "#/definitions/PaymentRequest" tags: - PIS responses: "200": description: Success schema: $ref: "#/definitions/GetPaymentResponse" headers: Content-Encoding: type: string description: "Gzip, deflate" X-JWS-SIGNATURE: type: string description: "Detached JWS signature of the body of the response" "400": description: "Bad request" schema: $ref: "#/definitions/Error" "401": description: "Unauthorized" schema: $ref: "#/definitions/Error" "403": description: "Forbidden" schema: $ref: "#/definitions/Error" "405": description: "Method Not Allowed" schema: $ref: "#/definitions/Error" "406": description: "Not Acceptable" schema: $ref: "#/definitions/Error" "415": description: "Unsupported Media Type" schema: $ref: "#/definitions/Error" "422": description: "Unprocessable entity" schema: $ref: "#/definitions/Error" "429": description: "Request limit for the requested service exceeded" schema: $ref: "#/definitions/Error" "500": description: "Internal Server Error" schema: $ref: "#/definitions/Error" "503": description: "Service Unavailable" schema: $ref: "#/definitions/Error" security: - xs2a_auth_aspsp: - "pis" - xs2a_auth_decoupled: - "pis" /v2_0_5.1/payments/v2_0_5.1/getBundle: x-swagger-router-controller: pis post: summary: "Get the status of bundle of payments" operationId: getBundle parameters: - $ref: "#/parameters/authorizationParam" - $ref: "#/parameters/acceptEncodingParam" - $ref: "#/parameters/acceptLanguageParam" - $ref: "#/parameters/acceptCharsetParam" - $ref: "#/parameters/xjwsSignatureParam" - name: bundle in: body description: "Bundle ID" required: true schema: $ref: "#/definitions/BundleRequest" tags: - PIS responses: "200": description: Success schema: $ref: "#/definitions/BundleResponse" headers: Content-Encoding: type: string description: "Gzip, deflate" X-JWS-SIGNATURE: type: string description: "Detached JWS signature of the body of the response" "400": description: "Bad request" schema: $ref: "#/definitions/Error" "401": description: "Unauthorized" schema: $ref: "#/definitions/Error" "403": description: "Forbidden" schema: $ref: "#/definitions/Error" "405": description: "Method Not Allowed" schema: $ref: "#/definitions/Error" "406": description: "Not Acceptable" schema: $ref: "#/definitions/Error" "415": description: "Unsupported Media Type" schema: $ref: "#/definitions/Error" "422": description: "Unprocessable entity" schema: $ref: "#/definitions/Error" "429": description: "Request limit for the requested service exceeded" schema: $ref: "#/definitions/Error" "500": description: "Internal Server Error" schema: $ref: "#/definitions/Error" "503": description: "Service Unavailable" schema: $ref: "#/definitions/Error" security: - xs2a_auth_aspsp: - "pis" - xs2a_auth_decoupled: - "pis" /v2_0_5.1/payments/v2_0_5.1/getMultiplePayments: x-swagger-router-controller: pis post: summary: "Get the status of multiple payments" description: "" operationId: getMultiplePayments parameters: - $ref: "#/parameters/acceptEncodingParam" - $ref: "#/parameters/acceptLanguageParam" - $ref: "#/parameters/acceptCharsetParam" - $ref: "#/parameters/xjwsSignatureParam" - name: payments in: body description: "Payments ID list" required: true schema: $ref: "#/definitions/PaymentsRequest" tags: - PIS responses: "200": description: "Success" schema: $ref: "#/definitions/PaymentsResponse" headers: Content-Encoding: type: string description: "Gzip, deflate" X-JWS-SIGNATURE: type: string description: "Detached JWS signature of the body of the response" "400": description: "Bad request" schema: $ref: "#/definitions/Error" "403": description: "Forbidden" schema: $ref: "#/definitions/Error" "405": description: "Method Not Allowed" schema: $ref: "#/definitions/Error" "406": description: "Not Acceptable" schema: $ref: "#/definitions/Error" "415": description: "Unsupported Media Type" schema: $ref: "#/definitions/Error" "422": description: "Unprocessable entity" schema: $ref: "#/definitions/Error" "429": description: "Request limit for the requested service exceeded" schema: $ref: "#/definitions/Error" "500": description: "Internal Server Error" schema: $ref: "#/definitions/Error" "503": description: "Service Unavailable" schema: $ref: "#/definitions/Error" /v2_0_5.1/payments/v2_0_5.1/cancelPayments: x-swagger-router-controller: pis post: summary: "Cancelation of future dated or recurring payment" operationId: cancelPayments parameters: - $ref: "#/parameters/authorizationParam" - $ref: "#/parameters/acceptEncodingParam" - $ref: "#/parameters/acceptLanguageParam" - $ref: "#/parameters/acceptCharsetParam" - $ref: "#/parameters/xjwsSignatureParam" - name: payment data in: body description: "Payments to be canceled - identification data" required: true schema: $ref: "#/definitions/CancelPaymentsRequest" tags: - PIS responses: "200": description: Success. Operation pefrormed but some of transactions could not be canceled. schema: $ref: "#/definitions/CancelPaymentsResponse" headers: Content-Encoding: type: string description: "Gzip, deflate" X-JWS-SIGNATURE: type: string description: "Detached JWS signature of the body of the response" "204": description: Success. Operation pefrormed with no exceptions. headers: Content-Encoding: type: string description: "Gzip, deflate" "400": description: "Bad request" schema: $ref: "#/definitions/Error" "401": description: "Unauthorized" schema: $ref: "#/definitions/Error" "403": description: "Forbidden" schema: $ref: "#/definitions/Error" "405": description: "Method Not Allowed" schema: $ref: "#/definitions/Error" "406": description: "Not Acceptable" schema: $ref: "#/definitions/Error" "415": description: "Unsupported Media Type" schema: $ref: "#/definitions/Error" "422": description: "Unprocessable entity" schema: $ref: "#/definitions/Error" "500": description: "Internal Server Error" schema: $ref: "#/definitions/Error" "503": description: "Service Unavailable" schema: $ref: "#/definitions/Error" security: - xs2a_auth_aspsp: - "pis" - xs2a_auth_decoupled: - "pis" /v2_0_5.1/confirmation/v2_0_5.1/getConfirmationOfFunds: x-swagger-router-controller: caf post: summary: "Confirmation of the availability of funds" description: "Confirming the availability on the payers account of the amount necessary to execute the payment transaction, as defined in Art. 65 PSD2." operationId: getConfirmationOfFunds parameters: - $ref: "#/parameters/acceptEncodingParam" - $ref: "#/parameters/acceptLanguageParam" - $ref: "#/parameters/acceptCharsetParam" - $ref: "#/parameters/xjwsSignatureParam" - name: confirmationOfFundsRequest in: body description: "Object with amount to check" required: true schema: $ref: "#/definitions/ConfirmationOfFundsRequest" tags: - CAF responses: "200": description: Success schema: $ref: "#/definitions/ConfirmationOfFundsResponse" headers: Content-Encoding: type: string description: "Gzip, deflate" X-JWS-SIGNATURE: type: string description: "Detached JWS signature of the body of the response" "400": description: "Bad request" schema: $ref: "#/definitions/Error" "403": description: "Forbidden" schema: $ref: "#/definitions/Error" "405": description: "Method Not Allowed" schema: $ref: "#/definitions/Error" "406": description: "Not Acceptable" schema: $ref: "#/definitions/Error" "415": description: "Unsupported Media Type" schema: $ref: "#/definitions/Error" "422": description: "Unprocessable entity" schema: $ref: "#/definitions/Error" "429": description: "Request limit for the requested service exceeded" schema: $ref: "#/definitions/Error" "500": description: "Internal Server Error" schema: $ref: "#/definitions/Error" "503": description: "Service Unavailable" schema: $ref: "#/definitions/Error" securityDefinitions: xs2a_auth_aspsp: type: "oauth2" flow: "accessCode" authorizationUrl: "https://apiHost/v2_0_5.1/auth/v2_0_5.1/authorize" tokenUrl: "https://apiHost/v2_0_5.1/auth/v2_0_5.1/token" scopes: "ais-accounts": "Permission to retrieve the list of accounts through Account Information Service" "ais": "Permission to execute methods of Account Information Service in context of particular account" "pis": "Permission to initiate payments and check their statuses through Payment Initiation Service" xs2a_auth_decoupled: type: "oauth2" flow: "accessCode" authorizationUrl: "https://apiHost/auth/authorizeExt" tokenUrl: "https://apiHost/v2_0_5.1/auth/v2_0_5.1/token" scopes: "ais-accounts": "Permission to retrieve the list of accounts through Account Information Service" "ais": "Permission to execute methods of Account Information Service in context of particular account" "pis": "Permission to initiate payments and check their statuses through Payment Initiation Service" definitions: AuthorizeRequest: description: "Klasa zapytania o uzyskanie kodu autoryzacyjnego zgodnego z OAuth2" type: object required: - requestHeader, response_type, client_id, redirect_uri, scope_details, state, ipAddress properties: requestHeader: $ref: "#/definitions/RequestHeaderWithoutTokenAS" response_type: type: string description: "Typ odpowiedzi. Wartość stała: code" client_id: type: string description: "Identyfikator TPP" redirect_uri: type: string description: "Adres usługi TPP, na które zostanie wykonane przekierowanie po uwierzytelnieniu klienta ASPSP" scope: type: string description: "Typy zgód o które prosi TPP. Lista identyfikatorów zgodna ze specyfikacją standardu Polish API." scope_details: $ref: "#/definitions/ScopeDetailsInput" state: type: string description: "Losowa, unikalna w ramach TPP wartość – zabezpieczenie przed atakiem Cross-Site Request Forgery" xml: name: AuthorizeRequest EatCodeRequest: description: "Klasa zapytania o uzyskanie kodu autoryzacyjnego zgodnego z OAuth2 na podstawie przekazanego kodu jednorazowego, wygenerowanego w EAT" type: object required: - requestHeader, requestId, response_type, eatCode, client_id, callbackURL, apiKey, scope_details properties: requestHeader: $ref: "#/definitions/RequestHeaderWithoutTokenCallbackAS" response_type: type: string description: "Typ odpowiedzi. Wartość stała: code" eatCode: type: string description: "Jednorazowy kod autoryzacyjny wygenerowany przez EAT" eatType: $ref: "#/definitions/DictionaryItem" #description: "Typ narzędzia EAT, w którym został wygenerowany kod jednorazowy / Type of EAT that One-Time Code origins from" client_id: type: string description: "Identyfikator TPP" scope: type: string description: "Typy zgód o które prosi TPP. Lista identyfikatorów zgodna ze specyfikacją standardu Polish API." scope_details: $ref: "#/definitions/ScopeDetailsInput" state: type: string description: "Losowa, unikalna w ramach TPP wartość – zabezpieczenie przed atakiem Cross-Site Request Forgery" xml: name: EatCodeRequest TokenRequest: description: "Klasa zapytania o uzyskanie tokena dostępowego zgodnego z OAuth2" type: object required: - grant_type properties: requestHeader: $ref: "#/definitions/RequestHeaderWithoutTokenAS" grant_type: type: string description: "Typ zastosowanej autoryzacji. Jedna z wartości: authorization_code, refresh_token, exchange_token (rozszerzenie standardu OAuth2)" Code: type: string description: "Kod autoryzacji uzyskany podczas żądania do usługi /authorize OAuth2. Wymagany dla grant_type=authorization_code." redirect_uri: type: string description: "Adres usługi TPP, na które zostanie wykonane przekierowanie po wygenerowaniu tokena dostępowego przez ASPSP. Wymagany dla grant_type=authorization_code." client_id: type: string description: "Identyfikator TPP. Wymagany dla grant_type=authorization_code." refresh_token: type: string description: "Wartość tokena, który służy do uzyskania nowego tokena dostępowego dla tego samego zakresu zgód (scope, scope_details) w przypadku gdy pierwotny token utraci swoją ważność. Wymagany dla grant_type=refresh_token." exchange_token: type: string description: "Wartość tokena, który służy do uzyskania nowego tokena dostępowego dla innego zakresu zgód (scope, scope_details). Wartością tego parametru powinien być token dostępowy ważnej sesji komuikacyjnej z interfejsem XS2A. Wymagany dla grant_type=exchange_token." scope: type: string description: "Typy zgód o które prosi TPP. Lista identyfikatorów zgodna ze specyfikacją standardu Polish API." scope_details: $ref: "#/definitions/ScopeDetailsInput" is_user_session: type: boolean description: "Określa czy dana sesja jest związana z interakcją z PSU – wartości true/false. Rozszerzenie standardu OAuth2." user_ip: type: string description: "IP przeglądarki użytkownika (informacja na potrzeby fraud detection). Rozszerzenie standardu OAuth2. Wymagany dla is_user_session = true." user_agent: type: string description: "Informacja dotycząca wersji przeglądarki użytkownika (informacja na potrzeby fraud detection). Rozszerzenie standardu OAuth2. Wymagany dla is_user_session = true." xml: name: TokenRequest TokenResponse: description: "Klasa odpowiedzi na zapytanie TPP o wygenerowanie tokena dostępowego" required: - responseHeader, access_token, token_type, expires_in, scope_details properties: responseHeader: $ref: "#/definitions/ResponseHeader" access_token: type: string description: "Wartość wygenerowanego tokena dostępowego" token_type: type: string description: "Typ tokena dostępowego. Dozwolona wartość to Bearer." expires_in: type: string description: "Czas ważności tokena dostępowego, po którym zostanie on unieważniony. Wartość wyrażona w sekundach, od momentu wygenerowania odpowiedzi." refresh_token: type: string description: "Wartość wygenerowanego tokena służącego do uzyskania nowego tokena dostępowego bez konieczności ponownej autoryzacji" scope: type: string description: "Typy zgód które uzyskał TPP. Lista identyfikatorów zgodna ze specyfikacją standardu Polish API." scope_details: $ref: "#/definitions/ScopeDetailsOutput" DeleteConsentRequest: description: "Klasa zapytania o usunięcie zgody na dostęp do AIS" type: object required: - consentId properties: consentId: type: string description: "Identyfikator zgody / Consent ID" xml: name: DeleteConsentRequest AccountsRequest: description: "Klasa zapytania o rachunki / Accounts Request Class" type: object required: - requestHeader properties: requestHeader: $ref: "#/definitions/RequestHeaderAISCallback" pageId: type: string description: "Używane w celu stronicowania danych: numer porządkowy rachunku, na liście rachunków, rozpoczynający zwróconą w odpowiedzi stronę / Ordinal number of account beginning the page (paging info)" perPage: type: integer format: int32 minimum: 1 description: "Używane w celu stronicowania danych: wielkość strony danych / Page size (paging info)" xml: name: AccountsRequest AccountResponse: description: "Klasa odpowiedzi na zapytania o konto PSU / PSU's Account Response Class" required: - responseHeader properties: responseHeader: $ref: "#/definitions/ResponseHeader" account: $ref: "#/definitions/AccountInfo" AccountsResponse: description: "Klasa odpowiedzi na zapytania o wiele kont PSU / PSU's Multiple Accounts Response Class" required: - responseHeader properties: responseHeader: $ref: "#/definitions/ResponseHeader" accounts: type: array items: $ref: "#/definitions/AccountBaseInfo" pageInfo: $ref: "#/definitions/PageInfo" AccountBaseInfo: description: "Klasa informacji o koncie / Account Information Class" type: object required: - accountNumber - accountTypeName - accountType properties: accountNumber: type: string description: "Numer rachunku (częściowo zamaskowany) / Account number (partly masked)" accountTypeName: type: string maxLength: 32 description: "Nazwa typu rachunku (definiowana przez ASPSP) / Account's type name (defined by ASPSP)" accountType: $ref: "#/definitions/DictionaryItem" #description: "Typ rachunku / Account’s type" xml: name: AccountBaseInfo AccountInfo: description: "Klasa informacji o koncie / Account Information Class" type: object required: - accountNumber - nameAddress - availableBalance - bookingBalance - currency - accountType - accountHolderType properties: accountNumber: type: string description: "Numer rachunku / Account number" nameAddress: $ref: "#/definitions/NameAddress" #description: "Obiekt klasy NameAddress - Imię Nazwisko lub Nazwa PSU / NameAddress class object - Given name nad surname or name of the company" accountType: $ref: "#/definitions/DictionaryItem" #description: "Typ rachunku / Account’s type" accountTypeName: type: string maxLength: 32 description: "Nazwa typu rachunku (definiowana przez ASPSP) / Account's type name (defined by ASPSP)" accountHolderType: type: string enum: - individual - corporation description: "Rodzaj posiadacza rachunku: osoba fizyczna lub osoba prawna / Account holder type: individual person or corporation" accountNameClient: type: string maxLength: 32 description: "Nazwa konta ustawiona przez klienta / Account name set by the client" currency: type: string maxLength: 3 description: "Waluta rachunku / Currency" availableBalance: type: string pattern: '^\d*\.\d{2}$' description: "Dostępne środki - po wykonaniu transakcji / Available funds" bookingBalance: type: string pattern: '^\d*\.\d{2}$' description: "Saldo księgowe rachunku - po wykonaniu transakcji / Book balance of the account" bank: $ref: "#/definitions/BankAccountInfo" auxData: $ref: "#/definitions/Map" #description: "Dodatkowe dane w postaci mapy klucz wartość/ Additional data as key-value map" xml: name: AccountInfo AccountInfoRequest: description: "Klasa zapytania o pojedynczy rachunek / Account Information Request Class" type: object required: - requestHeader - accountNumber properties: requestHeader: $ref: "#/definitions/RequestHeaderAIS" accountNumber: type: string description: "Numer rachunku / Account number" xml: name: AccountInfoRequest TransactionInfoRequestBase: description: "Bazowa klasa dla zapytań o transakcje / Transaction Information Request Base Class" type: object properties: requestHeader: $ref: "#/definitions/RequestHeaderAISCallback" accountNumber: type: string description: "Numer rachunku / Account number" transactionIdFrom: type: string maxLength: 64 description: "Element filtru: transakcje od podanego identyfikatora transakcji / Filter element" transactionDateFrom: type: string format: date maxLength: 10 description: "Element filtru: data transakcji od, YYYY-MM-DD / Filter element" transactionDateTo: type: string format: date maxLength: 10 description: "Element filtru: data transakcji do, YYYY-MM-DD / Filter element" bookingDateFrom: type: string format: date maxLength: 10 description: "Element filtru: data księgowania od, YYYY-MM-DD. Ignorowane w przypadku pobierania listy blokad. / Filter element. Ignored during list of holds retrieval." bookingDateTo: type: string format: date maxLength: 10 description: "Element filtru: data księgowania do, YYYY-MM-DD. Ignorowane w przypadku pobierania listy blokad. / Filter element. Ignored during list of holds retrieval." minAmount: type: string pattern: '^\d*\.\d{2}$' description: "Element filtru: kwota od / Filter element" maxAmount: type: string pattern: '^\d*\.\d{2}$' description: "Element filtru: kwota do / Filter element" pageId: type: string description: "Używane w celu stronicowania danych: numer porządkowy transakcji, na liście transakcji, rozpoczynający zwróconą w odpowiedzi stronę / Ordinal number of transaction beginning the page (paging info)" perPage: type: integer format: int32 minimum: 1 description: "Używane w celu stronicowania danych: wielkość strony danych / Page size (paging info)" xml: name: TransactionInfoRequestBase TransactionInfoRequest: description: "Klasa zapytania o transakcje / Transaction Information Request Class" allOf: - "$ref": "#/definitions/TransactionInfoRequestBase" - type: object required: - requestHeader - accountNumber properties: type: type: string enum: - CREDIT - DEBIT description: "Element filtru: transakcji / Filter element" xml: name: TransactionInfoRequest TransactionHoldRequest: description: "Klasa zapytania o transakcje / Transaction Information Request Class" allOf: - "$ref": "#/definitions/TransactionInfoRequestBase" - type: object required: - requestHeader - accountNumber properties: type: type: string enum: - DEBIT description: "Element filtru: transakcji / Filter element" xml: name: TransactionHoldRequest TransactionInfoBase: description: "Klasa bazowa informacji o transakcji / Transaction Information Base Class" type: object required: - transactionId - amount properties: transactionId: type: string maxLength: 64 description: "ID transakcji nadany przez ASPSP / Transaction ID (ASPSP)" amount: type: string pattern: '^\d*\.\d{2}$' description: "Kwota transakcji / Amount of the transaction" currency: type: string maxLength: 3 description: "Kod ISO waluty transakcji / Currency (ISO)" description: type: string maxLength: 140 description: "Tytuł transakcji / Description of the transaction" transactionType: type: string maxLength: 100 description: "Typ transakcji / Transaction type" tradeDate: type: string format: date-time description: "Data operacji, YYYY-MM-DDThh:mm:ss[.mmm] / Date of the operation" mcc: type: string description: "Kod dla każdej transakcji/operacji wykonanej przy użyciu karty / A code of each transaction performed by card" auxData: $ref: "#/definitions/Map" TransactionHoldInfo: description: "Klasa opisująca oczekującą transakcję płatniczą" allOf: - "$ref": "#/definitions/TransactionInfoBase" - type: object required: - transactionId - amount properties: transactionCategory: type: string enum: - DEBIT description: "Kategoria transakcji uznanie/obciążenie / Transaction category (credit/debit)" holdExpirationDate: type: string format: date-time description: "Data ważności blokady, YYYY-MM-DDThh:mm:ss[.mmm]" initiator: $ref: "#/definitions/NameAddress" sender: $ref: "#/definitions/SenderRecipient" recipient: $ref: "#/definitions/SenderRecipient" xml: name: TransactionHoldInfo TransactionPendingInfo: description: "Klasa opisująca oczekującą transakcję płatniczą. Jest to transakcja niezaksięgowana, niemodyfikowalna, wpływającej na dostępne środki (saldo dostępne)." allOf: - "$ref": "#/definitions/TransactionInfoBase" - type: object required: - transactionId - amount - transactionCategory properties: transactionCategory: type: string enum: - CREDIT - DEBIT description: "Kategoria transakcji uznanie/obciążenie / Transaction category (credit/debit)" initiator: $ref: "#/definitions/NameAddress" sender: $ref: "#/definitions/SenderRecipient" recipient: $ref: "#/definitions/SenderRecipient" xml: name: TransactionPendingInfo TransactionRejectedInfo: description: "Klasa opisująca odrzuconą transakcję płatniczą" allOf: - "$ref": "#/definitions/TransactionInfoBase" - type: object required: - transactionId - amount - transactionCategory properties: transactionCategory: type: string enum: - CREDIT - DEBIT description: "Kategoria transakcji uznanie/obciążenie / Transaction category (credit/debit)" initiator: $ref: "#/definitions/NameAddress" sender: $ref: "#/definitions/SenderRecipient" recipient: $ref: "#/definitions/SenderRecipient" rejectionReason: type: string maxLength: 140 description: Powod odrzucenia rejectionDate: type: string format: date-time description: "Data odrzucenia, YYYY-MM-DDThh:mm:ss[.mmm]" xml: name: TransactionRejectedInfo TransactionInfo: description: "Klasa opisująca zaksięgowaną transakcję płatniczą" allOf: - "$ref": "#/definitions/TransactionInfoBase" - type: object required: - transactionId - amount - transactionCategory properties: transactionCategory: type: string enum: - CREDIT - DEBIT description: "Kategoria transakcji uznanie/obciążenie / Transaction category (credit/debit)" transactionStatus: $ref: "#/definitions/DictionaryItem" #description: "Status transakcji / Transaction status" initiator: $ref: "#/definitions/NameAddress" sender: $ref: "#/definitions/SenderRecipient" recipient: $ref: "#/definitions/SenderRecipient" bookingDate: type: string format: date-time description: "Data księgowania, YYYY-MM-DDThh:mm:ss[.mmm]" postTransactionBalance: type: string pattern: '^\d*\.\d{2}$' description: "Saldo rachunku po transakcji" xml: name: TransactionInfo TransactionCancelledInfo: description: "Klasa opisująca odwołaną transakcję płatniczą" allOf: - "$ref": "#/definitions/TransactionInfoBase" - type: object required: - transactionId - amount - transactionCategory properties: transactionCategory: type: string enum: - CREDIT - DEBIT description: "Kategoria transakcji uznanie/obciążenie / Transaction category (credit/debit)" transactionStatus: $ref: "#/definitions/DictionaryItem" #description: "Status transakcji / Transaction status" initiator: $ref: "#/definitions/NameAddress" sender: $ref: "#/definitions/SenderRecipient" recipient: $ref: "#/definitions/SenderRecipient" xml: name: TransactionCancelledInfo TransactionScheduledInfo: description: "Klasa opisująca zaplanowaną transakcję płatniczą" allOf: - "$ref": "#/definitions/TransactionInfoBase" - type: object required: - transactionId - amount - transactionCategory properties: transactionCategory: type: string enum: - CREDIT - DEBIT description: "Kategoria transakcji uznanie/obciążenie / Transaction category (credit/debit)" transactionStatus: $ref: "#/definitions/DictionaryItem" #description: "Status transakcji / Transaction status" initiator: $ref: "#/definitions/NameAddress" sender: $ref: "#/definitions/SenderRecipient" recipient: $ref: "#/definitions/SenderRecipient" xml: name: TransactionScheduledInfo TransactionsDoneInfoResponse: description: "Klasa odpowiedzi zawierająca listę transakcji done / Done Transaction Information Response Class" required: - responseHeader - bookingDate - postTransactionBalance properties: responseHeader: $ref: "#/definitions/ResponseHeader" transactions: type: array items: $ref: "#/definitions/TransactionInfo" pageInfo: $ref: "#/definitions/PageInfo" xml: name: TransactionsDoneInfoResponse TransactionsCancelledInfoResponse: description: "Klasa odpowiedzi zawierająca listę transakcji cancelled / Cancelled Transaction Information Response Class" required: - responseHeader properties: responseHeader: $ref: "#/definitions/ResponseHeader" transactions: type: array items: $ref: "#/definitions/TransactionCancelledInfo" pageInfo: $ref: "#/definitions/PageInfo" xml: name: TransactionsCancelledInfoResponse TransactionsScheduledInfoResponse: description: "Klasa odpowiedzi zawierająca listę transakcji scheduled / Scheduled Transaction Information Response Class" required: - responseHeader properties: responseHeader: $ref: "#/definitions/ResponseHeader" transactions: type: array items: $ref: "#/definitions/TransactionScheduledInfo" pageInfo: $ref: "#/definitions/PageInfo" xml: name: TransactionsScheduledInfoResponse TransactionPendingInfoResponse: description: "Klasa odpowiedzi zawierająca listę transakcji pending / Pending Transaction Information Response Class" required: - responseHeader properties: responseHeader: $ref: "#/definitions/ResponseHeader" transactions: type: array items: $ref: "#/definitions/TransactionPendingInfo" pageInfo: $ref: "#/definitions/PageInfo" xml: name: TransactionPendingInfoResponse TransactionRejectedInfoResponse: description: "Klasa odpowiedzi zawierająca listę transakcji rejected / Rejected Transaction Information Response Class" required: - responseHeader properties: responseHeader: $ref: "#/definitions/ResponseHeader" transactions: type: array items: $ref: "#/definitions/TransactionRejectedInfo" pageInfo: $ref: "#/definitions/PageInfo" xml: name: TransactionRejectedInfoResponse TransactionHoldInfoResponse: description: "Klasa odpowiedzi zawierająca listę transakcji zawieszonych / Hold Transaction Information Response Class" required: - responseHeader properties: responseHeader: $ref: "#/definitions/ResponseHeader" transactions: type: array items: $ref: "#/definitions/TransactionHoldInfo" pageInfo: $ref: "#/definitions/PageInfo" xml: name: TransactionHoldInfoResponse TransactionDetailRequest: description: "Klasa zapytania o pojedynczą transakcję / Transaction Detail Request Class" type: object required: - requestHeader - transactionId properties: requestHeader: $ref: "#/definitions/RequestHeaderAIS" transactionId: type: string maxLength: 64 description: "ID transakcji / Transaction ID" accountNumber: type: string maxLength: 34 description: "Numer konta nadawcy / Sender account number" bookingDate: type: string format: date-time description: "Data zaksięgowania operacji, YYYY-MM-DDThh:mm:ss[.mmm] / Transaction booking date" xml: name: TransactionDetailRequest Payor: description: "Klasa informacji o płatniku do US / Tax Payor Information Class" type: object required: - payorId - payorIdType properties: payorId: type: string maxLength: 20 description: "Identyfikator płatnika / Payor ID" payorIdType: type: string maxLength: 20 description: "Typ identyfikatora płatnika / Payor ID type" enum: - N - P - R - 1 - 2 - 3 x-ms-enum: name: payorIdType values: - value: N description: NIP - value: P description: Pesel - value: R description: Regon - value: 1 description: Dowód osobisty - value: 2 description: Paszport - value: 3 description: Inny xml: name: Payor SocialSecurityPayor: description: "Klasa informacji o płatniku do ZUS / Polish Social Security Institution (ZUS) Payor Information Class" type: object properties: nip: type: string maxLength: 10 description: "Numer Identyfikacji Podatkowej / Payor's Tax Identification Number" additionalPayorId: type: string maxLength: 20 description: "Dodatkowy numer identyfikacyjny płatnika / Payor's additional identification number" additionalPayorIdType: type: string maxLength: 20 description: "Typ dodatkowego identyfikatora płatnika / Payor's additional identifier type" enum: - P - R - 1 - 2 x-ms-enum: name: additionalPayorIdType values: - value: P description: Pesel - value: R description: Regon - value: 1 description: Dowód osobisty - value: 2 description: Paszport xml: name: SocialSecurityPayor TransactionInfoZUS: description: "Klasa informacji danych dla przelewu do ZUS / ZUS Transfer Information Class" type: object properties: payerInfo: $ref: "#/definitions/SocialSecurityPayor" contributionType: type: string maxLength: 1 description: "Typ wpłaty / Contribution type" contributionId: type: string maxLength: 2 description: "Numer deklaracji / Contribution identifier" contributionPeriod: type: string maxLength: 6 description: "Okres deklaracji / Contribution period, Format: MMYYYY" paymentTypeId: type: string maxLength: 1 description: "Identyfikator typu płatności / Payment type ID" obligationId: type: string maxLength: 1 description: "Numer tytułu wykonawczego / Obligation identifier or number" xml: name: TransactionInfoZUS TransactionInfoTax: description: "Klasa informacji danych dla przelewu podatkowego do Urzędu Skarbowego lub Izby Celnej / Tax Transfer" type: object required: - payerInfo - formCode - periodId - periodType - year properties: payerInfo: $ref: "#/definitions/Payor" formCode: type: string maxLength: 7 description: "Symbol formularza Urzędu Skarbowego lub Izby Celnej / Tax authority form symbol" periodId: type: string maxLength: 7 description: "Numer okresu / Period number" periodType: type: string maxLength: 7 description: "Typ okresu / Period type" year: type: integer format: int32 maximum: 9999 description: "Rok okresu / Period year" obligationId: type: string maxLength: 40 description: "Identyfikator zobowiązania, z którego wynika należność podatku np. decyzja, tytuł wykonawczy, postanowienie / Obligation ID" xml: name: TransactionInfoTax TransactionInfoCard: type: object description: "Klasa reprezentująca informacje o karcie w ramach transakcji / Transaction Card Information Class" properties: cardHolder: type: string description: "Właściciel karty / Card holder" cardNumber: type: string description: "Numer karty / Card number" TransactionDetailResponse: description: "Klasa odpowiedzi na zapytanie o transakcję / Transaction Detail Response Class" type: object required: - responseHeader - baseInfo properties: responseHeader: $ref: "#/definitions/ResponseHeader" #description: "Obiekt klasy ResponseHeader / ResponseHeader Class object baseInfo: $ref: "#/definitions/TransactionInfo" #description: "Obiekt klasy TransactionInfo / TransactionInfo Class object zusInfo: $ref: "#/definitions/TransactionInfoZUS" #description: "Obiekt klasy TransactionInfoZUS / TransactionInfoZUS Class object usInfo: $ref: "#/definitions/TransactionInfoTax" #description: "Obiekt klasy TransactionInfoTax / TransactionInfoTax Class object cardInfo: $ref: "#/definitions/TransactionInfoCard" #description: "Obiekt klasy TransactionInfoCard / TransactionInfoCard Class object currencyDate: type: string format: date-time description: "Data kursu waluty, YYYY-MM-DDThh:mm:ss[.mmm] / Date of the currency exchange rate" transactionRate: type: array items: $ref: "#/definitions/CurrencyRate" #description: "Kursy transakcji / Currency exchange rates" baseCurrency: type: string maxLength: 3 description: "Waluta oryginalna transakcji, kod ISO / Currency of the transaction, ISO code" amountBaseCurrency: type: string pattern: '^\d*\.\d{2}$' description: "Kwota w oryginalnej walucie / Amount of the transaction" usedPaymentInstrumentId: type: string maxLength: 32 description: "Unikalny identyfikator instrumentu płatniczego, za którego pomocą wykonano transakcję / Payment Instrument ID" tppTransactionId: type: string maxLength: 64 description: "Unikalny identyfikator transakcji po stronie TPP / Transaction ID (TPP)" tppName: type: string maxLength: 32 description: "Nazwa TPP / TPP name" rejectionReason: type: string maxLength: 140 description: "Przyczyna odrzucenia / Reason for rejection" holdExpirationDate: type: string format: date-time description: "Data ważności blokady, YYYY-MM-DDThh:mm:ss[.mmm] / Hold expiration date" xml: name: TransactionDetailResponse PaymentDomesticRequest: description: "Klasa zlecenia przelewu krajowego / Domestic Transfer Request Class" type: object required: - requestHeader - recipient - sender - transferData - tppTransactionId - deliveryMode properties: requestHeader: $ref: "#/definitions/RequestHeaderCallback" #description: "Obiekt klasy RequestHeaderCallback / RequestHeaderCallback Class object recipient: $ref: "#/definitions/RecipientPIS" #description: "Obiekt klasy RecipientPIS / RecipientPIS Class object" sender: $ref: "#/definitions/SenderPISDomestic" #description: "Obiekt klasy SenderPISDomestic / SenderPISDomestic Class object" transferData: $ref: "#/definitions/TransferData" #description: "Obiekt klasy TransferData / TransferData Class object" tppTransactionId: type: string maxLength: 64 description: "ID transakcji nadany przez TPP / Transaction ID (TPP)" deliveryMode: description: "Tryb pilności / Urgency mode" type: string enum: - ExpressD0 - StandardD1 system: description: "Droga jaką przelew ma być rozliczony / The way the transfer should be settled" type: string enum: - Elixir - ExpressElixir - Sorbnet - BlueCash - Internal hold: description: "Czy założyć blokadę (w przypadku np. zlecenia przelewu w dniu wolnym) / Indicates if payment should be holded" type: boolean executionMode: description: "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." type: string enum: - Immediate #description: "The payment is to be executed immediately" - FutureDated #description: "The payment is to be executed according to specific date in the future required to pass by TPP" - Recurring #description: "The payment is to be executed recurringly according to additional parameters required to pass by TPP" xml: name: PaymentDomesticRequest PaymentDomesticRequestBundled: description: "Klasa zlecenia przelewu krajowego w ramach paczki / Domestic Transfer inside bundle Request Class" type: object required: - recipient - sender - transferData - tppTransactionId - deliveryMode properties: recipient: $ref: "#/definitions/RecipientPIS" #description: "Obiekt klasy RecipientPIS / RecipientPIS Class object" sender: $ref: "#/definitions/SenderPISDomestic" #description: "Obiekt klasy SenderPISDomestic / SenderPISDomestic Class object" transferData: $ref: "#/definitions/TransferData" #description: "Obiekt klasy TransferData / TransferData Class object" tppTransactionId: type: string maxLength: 64 description: "ID transakcji nadany przez TPP / Transaction ID (TPP)" deliveryMode: description: "Tryb pilności / Urgency mode" type: string enum: - ExpressD0 - StandardD1 system: description: "Droga jaką przelew ma być rozliczony / The way the transfer should be settled" type: string enum: - Elixir - ExpressElixir - Sorbnet - BlueCash - Internal hold: description: "Czy założyć blokadę (w przypadku np. zlecenia przelewu w dniu wolnym) / Indicates if payment should be holded" type: boolean executionMode: description: "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." type: string enum: - Immediate #description: "The payment is to be executed immediately" - FutureDated #description: "The payment is to be executed according to specific date in the future required to pass by TPP" - Recurring #description: "The payment is to be executed recurringly according to additional parameters required to pass by TPP" xml: name: PaymentDomesticRequestBundled PaymentEEARequest: description: "Klasa zlecenia przelewu zagranicznego SEPA / EEA Transfer Request Class" type: object required: - requestHeader - recipient - sender - transferData - tppTransactionId - deliveryMode properties: requestHeader: $ref: "#/definitions/RequestHeaderCallback" #description: "Obiekt klasy RequestHeaderCallback / RequestHeaderCallback Class object" recipient: $ref: "#/definitions/RecipientPISForeign" #description: "Obiekt klasy RecipientPISForeign / RecipientPISForeign Class object" sender: $ref: "#/definitions/SenderPISForeign" #description: "Obiekt klasy SenderPISForeign / SenderPISForeign Class object" transferData: $ref: "#/definitions/TransferDataCurrencyRequired" #description: "Obiekt klasy TransferDataCurrencyRequired / TransferDataCurrencyRequired Class object" tppTransactionId: type: string maxLength: 64 description: "ID transakcji nadany przez TPP / Transaction ID (TPP)" deliveryMode: description: "Tryb pilności / Urgency mode" type: string enum: - ExpressD0 - StandardD1 system: description: "Droga jaką przelew ma być rozliczony / The way the transfer should be settled" type: string enum: - SEPA - InstantSEPA - Target hold: description: "Czy założyć blokadę (w przypadku np. zlecenia przelewu w dniu wolnym) / Indicates if payment should be holded" type: boolean executionMode: description: "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." type: string enum: - Immediate #description: "The payment is to be executed immediately" - FutureDated #description: "The payment is to be executed according to specific date in the future required to pass by TPP" - Recurring #description: "The payment is to be executed recurringly according to additional parameters required to pass by TPP" xml: name: PaymentEEARequest PaymentEEARequestBundled: description: "Klasa zlecenia przelewu zagranicznego SEPA w ramach paczki / EEA Transfer inside bundle Request Class" type: object required: - recipient - sender - transferData - tppTransactionId - deliveryMode properties: recipient: $ref: "#/definitions/RecipientPISForeign" #description: "Obiekt klasy RecipientPISForeign / RecipientPISForeign Class object" sender: $ref: "#/definitions/SenderPISForeign" #description: "Obiekt klasy SenderPISForeign / SenderPISForeign Class object" transferData: $ref: "#/definitions/TransferDataCurrencyRequired" #description: "Obiekt klasy TransferDataCurrencyRequired / TransferDataCurrencyRequired Class object" tppTransactionId: type: string maxLength: 64 description: "ID transakcji nadany przez TPP / Transaction ID (TPP)" deliveryMode: description: "Tryb pilności / Urgency mode" type: string enum: - ExpressD0 - StandardD1 system: description: "Droga jaką przelew ma być rozliczony / The way the transfer should be settled" type: string enum: - SEPA - InstantSEPA - Target hold: description: "Czy założyć blokadę (w przypadku np. zlecenia przelewu w dniu wolnym) / Indicates if payment should be holded" type: boolean executionMode: description: "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." type: string enum: - Immediate #description: "The payment is to be executed immediately" - FutureDated #description: "The payment is to be executed according to specific date in the future required to pass by TPP" - Recurring #description: "The payment is to be executed recurringly according to additional parameters required to pass by TPP" xml: name: PaymentEEARequestBundled PaymentNonEEARequest: description: "Klasa zlecenia przelewu zagranicznego innego niż SEPA / NonEEA Transfer Request Class" type: object required: - requestHeader - recipient - recipientBank - sender - transferData - tppTransactionId - deliveryMode properties: requestHeader: $ref: "#/definitions/RequestHeaderCallback" #description: "Obiekt klasy RequestHeaderCallback / RequestHeaderCallback Class object" recipient: $ref: "#/definitions/RecipientPISForeign" #description: "Obiekt klasy RecipientPISForeign / RecipientPISForeign Class object" recipientBank: $ref: "#/definitions/Bank" #description: "Obiekt klasy Bank / Bank Class object" sender: $ref: "#/definitions/SenderPISForeign" #description: "Obiekt klasy SenderPISForeign / SenderPISForeign Class object" transferData: $ref: "#/definitions/TransferDataCurrencyRequired" #description: "Obiekt klasy TransferData / TransferData Class object" transferCharges: type: string maxLength: 3 description: "Klauzula kosztowa / The cost clause" tppTransactionId: type: string maxLength: 64 description: "ID transakcji nadany przez TPP / Transaction ID (TPP)" deliveryMode: description: "Tryb pilności / Urgency mode" type: string enum: - ExpressD0 - UrgentD1 - StandardD2 system: description: "Droga jaką przelew ma być rozliczony / The way the transfer should be settled" type: string enum: - Swift hold: description: "Czy założyć blokadę (w przypadku np. zlecenia przelewu w dniu wolnym) / Indicates if payment should be holded" type: boolean executionMode: description: "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." type: string enum: - Immediate #description: "The payment is to be executed immediately" - FutureDated #description: "The payment is to be executed according to specific date in the future required to pass by TPP" - Recurring #description: "The payment is to be executed recurringly according to additional parameters required to pass by TPP" xml: name: PaymentNonEEARequest PaymentNonEEARequestBundled: description: "Klasa zlecenia przelewu zagranicznego innego niż SEPA w ramach paczki / NonEEA Transfer inside bundle Request Class" type: object required: - recipient - recipientBank - sender - transferData - tppTransactionId - deliveryMode properties: recipient: $ref: "#/definitions/RecipientPISForeign" #description: "Obiekt klasy RecipientPISForeign / RecipientPISForeign Class object" recipientBank: $ref: "#/definitions/Bank" #description: "Obiekt klasy Bank / Bank Class object" sender: $ref: "#/definitions/SenderPISForeign" #description: "Obiekt klasy SenderPISForeign / SenderPISForeign Class object" transferData: $ref: "#/definitions/TransferDataCurrencyRequired" #description: "Obiekt klasy TransferData / TransferData Class object" transferCharges: type: string maxLength: 3 description: "Klauzula kosztowa / The cost clause" tppTransactionId: type: string maxLength: 64 description: "ID transakcji nadany przez TPP / Transaction ID (TPP)" deliveryMode: description: "Tryb pilności / Urgency mode" type: string enum: - ExpressD0 - UrgentD1 - StandardD2 system: description: "Droga jaką przelew ma być rozliczony / The way the transfer should be settled" type: string enum: - Swift hold: description: "Czy założyć blokadę (w przypadku np. zlecenia przelewu w dniu wolnym) / Indicates if payment should be holded" type: boolean executionMode: description: "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." type: string enum: - Immediate #description: "The payment is to be executed immediately" - FutureDated #description: "The payment is to be executed according to specific date in the future required to pass by TPP" - Recurring #description: "The payment is to be executed recurringly according to additional parameters required to pass by TPP" xml: name: PaymentNonEEARequestBundled PaymentTaxRequest: description: "Klasa zlecenia przelewu podatkowego / Tax Transfer Request Class" type: object required: - requestHeader - recipient - sender - transferData - tppTransactionId - deliveryMode properties: requestHeader: $ref: "#/definitions/RequestHeaderCallback" #description: "Obiekt klasy RequestHeaderCallback / RequestHeaderCallback Class object" recipient: $ref: "#/definitions/RecipientPISTax" #description: "Obiekt klasy RecipientPISTax / RecipientPISTax Class object" sender: $ref: "#/definitions/SenderPISDomestic" #description: "Obiekt klasy SenderPISDomestic / SenderPISDomestic Class object" transferData: $ref: "#/definitions/TransferDataCurrencyRequiredTax" #description: "Obiekt klasy TransferDataCurrencyRequiredTax / TransferDataCurrencyRequiredTax Class object" usInfo: $ref: "#/definitions/TransactionInfoTax" #description: "Obiekt klasy TransactionInfoTax / TransactionInfoTax Class object" tppTransactionId: type: string maxLength: 64 description: "ID transakcji nadany przez TPP / Transaction ID (TPP)" deliveryMode: description: "Tryb pilności / Urgency mode" type: string enum: - ExpressD0 - StandardD1 system: description: "Droga jaką przelew ma być rozliczony / The way the transfer should be settled" type: string enum: - Elixir - ExpressElixir hold: description: "Czy założyć blokadę (w przypadku np. zlecenia przelewu w dniu wolnym) / Indicates if payment should be holded" type: boolean executionMode: description: "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." type: string enum: - Immediate #description: "The payment is to be executed immediately" - FutureDated #description: "The payment is to be executed according to specific date in the future required to pass by TPP" - Recurring #description: "The payment is to be executed recurringly according to additional parameters required to pass by TPP" xml: name: PaymentTaxRequest PaymentTaxRequestBundled: description: "Klasa zlecenia przelewu podatkowego w ramach paczki / Tax Transfer inside bundle Request Class" type: object required: - recipient - sender - transferData - tppTransactionId - deliveryMode properties: recipient: $ref: "#/definitions/RecipientPISTax" #description: "Obiekt klasy RecipientPISTax / RecipientPISTax Class object" sender: $ref: "#/definitions/SenderPISDomestic" #description: "Obiekt klasy SenderPISDomestic / SenderPISDomestic Class object" transferData: $ref: "#/definitions/TransferDataCurrencyRequiredTax" #description: "Obiekt klasy TransferDataCurrencyRequiredTax / TransferDataCurrencyRequiredTax Class object" usInfo: $ref: "#/definitions/TransactionInfoTax" #description: "Obiekt klasy TransactionInfoTax / TransactionInfoTax Class object" tppTransactionId: type: string maxLength: 64 description: "ID transakcji nadany przez TPP / Transaction ID (TPP)" deliveryMode: description: "Tryb pilności / Urgency mode" type: string enum: - ExpressD0 - StandardD1 system: description: "Droga jaką przelew ma być rozliczony / The way the transfer should be settled" type: string enum: - Elixir - ExpressElixir hold: description: "Czy założyć blokadę (w przypadku np. zlecenia przelewu w dniu wolnym) / Indicates if payment should be holded" type: boolean executionMode: description: "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." type: string enum: - Immediate #description: "The payment is to be executed immediately" - FutureDated #description: "The payment is to be executed according to specific date in the future required to pass by TPP" - Recurring #description: "The payment is to be executed recurringly according to additional parameters required to pass by TPP" xml: name: PaymentTaxRequestBundled PaymentRequest: description: "Klasa zapytania o status płatności / Payment Request Class" required: - requestHeader - transactionId properties: requestHeader: $ref: "#/definitions/RequestHeader" #description: "Obiekt klasy RequestHeader / RequestHeader Class object" transactionId: type: string maxLength: 64 description: "Identyfikator płatności / Transaction ID" xml: name: PaymentRequest BundleRequest: description: "Klasa zapytania o status paczki płatności / Bundle Request Class" required: - requestHeader - bundleId - transactionsIncluded properties: requestHeader: $ref: "#/definitions/RequestHeader" #description: "Obiekt klasy RequestHeader / RequestHeader Class object" bundleId: description: "Identyfikator paczki przelewów. Wymagany w przypadku zapytania o paczkę przelewów. / Bundle of payments identifier. Required in case of bundle of payments request." type: string maxLength: 64 transactionsIncluded: type: boolean description: "(true / false) Znacznik oznaczający czy w odpowiedzi mają być uwzględnione statusy transakcji wchodzące w skład paczki / Indicates if statuses of payments from the bundle should be incuded" xml: name: BundleRequest PaymentsBundleRequest: description: "Klasa zlecenia paczki przelewów / Bundle of payments Request Class" type: object required: - requestHeader - tppBundleId - transfersTotalAmount - typeOfTransfers properties: requestHeader: $ref: "#/definitions/RequestHeaderCallback" tppBundleId: description: "Identyfikator paczki przelewów nadany przez TPP / Bundle of payments identifier set by TPP" type: string maxLength: 64 transfersTotalAmount: description: "Łączna kwota wszystkich przelewów z paczki / The total amount of all transfers from bundle" type: string pattern: '^\d*\.\d{2}$' typeOfTransfers: description: "Typ przelewów, które zostaną zlecone w ramach paczki / The type of transfers that will be initiated through the bundle" type: string enum: - domestic - EEA - nonEEA - tax domesticTransfers: description: "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." type: array items: $ref: "#/definitions/PaymentDomesticRequestBundled" EEATransfers: description: "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." type: array items: $ref: "#/definitions/PaymentEEARequestBundled" nonEEATransfers: description: "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." type: array items: $ref: "#/definitions/PaymentNonEEARequestBundled" taxTransfers: description: "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." type: array items: $ref: "#/definitions/PaymentTaxRequestBundled" xml: name: PaymentsBundleRequest PaymentsBundleResponse: description: "Klasa odpowiedzi na żądanie inicjacji paczki przelewów. Zawiera dane o statusach poszczególnych przelewów oraz status paczki. / Class describing statuses of each payment inside the bundle and the bundle itself." properties: bundleId: description: "Identyfikator paczki przelewów / Bundle of payments identifier" type: string maxLength: 64 bundleStatus: description: "Status paczki przelewów / Bundle of payments status" type: string enum: - inProgress #description: "Paczka przelewów jest w trakcie realizacji / Bundle of payments is being executed" - canceled #description: "Paczka przelewów zostałą odowłana / Bundle of payments has been cancelled" - done #description: "Paczka przelewów została zrealizowana / Bundle of payments has been executed" - partiallyDone #description: "Paczka przelewów została zrealizowana częściowo / Bundle of payments has been executed partially" payments: type: array items: $ref: "#/definitions/PaymentInfo" xml: name: PaymentsBundleResponse CancelPaymentsRequest: description: "Klasa zapytania o odwołanie przelewu lub paczki przelewów. Wymagany warunkowo jeden z atrybutów - transactionId lub bundleId / Payment or bundle of payments cancelation request class. One of the following attributes is required: transactionId or bundleId" required: - requestHeader properties: requestHeader: $ref: "#/definitions/RequestHeader" #description: "Obiekt klasy RequestHeader / RequestHeader Class object" transactionId: type: string maxLength: 64 description: "Identyfikator płatności / Transaction ID" bundleId: type: string description: "Identyfikator paczki przelewów / Bundle of payments ID" xml: name: CancelPaymentsRequest CancelPaymentsResponse: description: "Klasa odpowiedzi na żądanie odwołania przelewów. Zawiera dane przelewów, które nie mogły być odwołane. / Class describing payments that could not have been canceled." properties: payments: type: array items: $ref: "#/definitions/PaymentInfo" xml: name: CancelPaymentsResponse PaymentsRequest: description: "Klasa zapytania o statusy wielu płatności / Payments Request Class" required: - requestHeader - paymentsId properties: requestHeader: $ref: "#/definitions/RequestHeaderWithoutToken" #description: "Obiekt klasy RequestHeaderWithoutToken / RequestHeaderWithoutToken Class object" paymentsId: type: array items: type: string #description: "Lista identyfikatorów płatności / List of payment ids"" xml: name: PaymentsRequest AddPaymentResponse: description: "Klasa odpowiedzi zlecenia płatności / Payment Add Response Class" required: - responseHeader - transactionId - generalStatus - detailedStatus properties: responseHeader: $ref: "#/definitions/ResponseHeader" #description: "Obiekt klasy ResponseHeader / ResponseHeader Class object" transactionId: type: string description: "Identyfiaktor płatności / Transaction ID" generalStatus: $ref: "#/definitions/PaymentStatus" #description: "Obiekt klasy PaymentStatus / PaymentStatus class object" detailedStatus: type: string description: "Status płatności / Detailed payment status" PaymentInfo: description: "Klasa informacji o płatności / Payment Information Class" required: - transactionId - generalStatus - detailedStatus - executionMode properties: transactionId: type: string description: "Identyfiaktor płatności / Transaction ID" generalStatus: $ref: "#/definitions/PaymentStatus" #description: "Obiekt klasy PaymentStatus / PaymentStatus class object" detailedStatus: type: string description: "Szczegółowy status płatności / Detailed payment status" executionMode: description: "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." type: string enum: - Immediate #description: "The payment is to be executed immediately" - FutureDated #description: "The payment is to be executed according to specific date in the future required to pass by TPP" - Recurring #description: "The payment is to be executed recurringly according to additional parameters required to pass by TPP" GetPaymentResponse: description: "Klasa odpowiedzi na pytanie o płatność / Payment Get Response Class" allOf: - "$ref": "#/definitions/PaymentInfo" - type: object required: - responseHeader - transactionId - generalStatus - detailedStatus properties: responseHeader: $ref: "#/definitions/ResponseHeader" #description: "Obiekt klasy ResponseHeader / ResponseHeader Class object" BundleResponse: description: "Klasa odpowiedzi na pytanie o status paczki płatności / Response data with status of bundle of payments" required: - responseHeader properties: responseHeader: $ref: "#/definitions/ResponseHeader" #description: "Obiekt klasy ResponseHeader / ResponseHeader Class object" bundleId: description: "Identyfikator paczki przelewów / Bundle of payments identifier" type: string maxLength: 64 bundleStatus: description: "Status paczki przelewów / Bundle of payments status" type: string enum: - inProgress #description: "Paczka przelewów jest w trakcie realizacji / Bundle of payments is being executed" - canceled #description: "Paczka przelewów zostałą odowłana / Bundle of payments has been cancelled" - done #description: "Paczka przelewów została zrealizowana / Bundle of payments has been executed" - partiallyDone #description: "Paczka przelewów została zrealizowana częściowo / Bundle of payments has been executed partially" payments: type: array items: $ref: "#/definitions/PaymentInfo" PaymentsResponse: description: "Klasa odpowiedzi na pytanie o wiele płatności" required: - responseHeader properties: responseHeader: $ref: "#/definitions/ResponseHeader" #description: "Obiekt klasy ResponseHeader / ResponseHeader Class object" payments: type: array items: $ref: "#/definitions/PaymentInfo" #description: "Lista elementów typu: PaymentInfo / PaymentInfo type elements list" ConfirmationOfFundsRequest: description: "Klasa zapytania o dostępne środki płatnicze na rachunku / Confirmation of Funds Request Class" type: object required: - requestHeader - accountNumber - amount - currency properties: requestHeader: $ref: "#/definitions/RequestHeaderWithoutToken" #description: "Obiekt klasy RequestHeaderWithoutToken / RequestHeaderWithoutToken Class object" accountNumber: type: string maxLength: 34 description: "Numer konta / Account number" amount: type: string pattern: '^\d*\.\d{2}$' description: "Wielkość środków której dotyczy zaptanie / Amount of the transaction" currency: type: string maxLength: 3 description: "Kod ISO Waluty (waluta transakcji) / Currency of transaction (ISO)" xml: name: ConfirmationOfFundsRequest ConfirmationOfFundsResponse: description: "Klasa odpowiedzi na zapytanie o dostępne środki płatnicze na rachunku / Confirmation of Funds Response Class" required: - responseHeader - fundsAvailable properties: responseHeader: $ref: "#/definitions/ResponseHeader" #description: "Obiekt klasy ResponseHeader / ResponseHeader Class object" fundsAvailable: description: "Status - Czy środki są dostępne / Status - are funds available" type: boolean enum: - true - false Error: description: "Klasa zawierająca informacje o zwracanym błędzie / Error class" properties: responseHeader: $ref: "#/definitions/ResponseHeader" #description: "Obiekt klasy ResponseHeader / ResponseHeader Class object" code: type: string description: "Kod błędu / Error code" message: type: string description: "Opis błędu / Error message" AccountNumber: description: "Numer konta" type: string maxLength: 34 AccountForeign: description: "Numer konta, format dla przelewów zagranicznych" type: string maxLength: 34 RequestHeaderWithoutToken: description: "Klasa zawierająca informacje o PSU / PSU Information Class" type: object required: - requestId properties: requestId: type: string description: "Identyfikator żądania / Request ID" userAgent: type: string description: "Browser agent dla PSU / PSU browser agent" ipAddress: type: string description: "Adres IP końcowego urządzenia PSU. Wymagany dla isDirectPsu=true. / IP address of PSU's terminal device. Required when isDirectPsu=true." sendDate: type: string format: date-time description: "Oryginalna data wysłania, format: YYYY-MM-DDThh:mm:ss[.mmm] / Send date" tppId: type: string description: "Identyfikator TPP / TPP ID" RequestHeaderWithoutTokenAS: description: "Klasa zawierająca informacje o PSU na potrzeby usług autoryzacji / PSU Information Class dedicated for authorization services" allOf: - "$ref": "#/definitions/RequestHeaderWithoutToken" - type: object properties: isCompanyContext: type: boolean description: "(true / false) Znacznik oznaczający czy żądanie jest wysyłane w kontekście PSU korporacyjnego" psuCompanyIdentifierType: description: "Typ korporacyjnego identyfikatora PSU / Type of corporate identifier of the PSU" type: string enum: - N - P - R - 1 - 2 - 3 x-ms-enum: name: psuCompanyIdentifierType values: - value: N description: Numer NIP PSU / PSU's NIP number - value: P description: Numer PESEL PSU / PSU's PESEL number - value: R description: Numer REGON PSU / PSU's REGON number - value: 1 description: Numer dowodu osobistego PSU / PSU's ID Document number - value: 2 description: Numer paszportu PSU / PSU's PASSPORT number - value: 3 description: Inny identyfikator PSU. Format identyfikatora definiowany przez każdy podmiot ASPSP. Może służyć do przekazania dodatkowych informacji o PSU, takich jak kontekst lub rola PSU w korporacji. / Other type of identifier having format defined by each ASPSP. It may be used to pass additional information about PSU e.g. context or role. psuCompanyIdentifierValue: type: string description: "Wartość identyfikatora klienta / The value of the PSU's identifier" RequestHeaderWithoutTokenCallbackAS: description: "Klasa zawierająca informacje o PSU and callback URL / PSU and callback URL Information Class" allOf: - "$ref": "#/definitions/RequestHeaderWithoutTokenAS" - type: object required: - callbackURL, apiKey properties: callbackURL: type: string description: "adres funkcji zwrotnej / callback URL" apiKey: type: string description: "API key dla wywołania funkcji zwrotnej / callback API key" RequestHeaderCallback: description: "Klasa zawierająca informacje o PSU and callback URL / PSU and callback URL Information Class" allOf: - "$ref": "#/definitions/RequestHeaderWithoutToken" - type: object required: - token properties: token: type: string description: "Token autoryzacyjny / Authorization token" callbackURL: type: string description: "adres funkcji zwrotnej / callback URL" apiKey: type: string description: "API key dla wywołania funkcji zwrotnej / callback API key" RequestHeader: description: "Klasa zawierająca informacje o PSU / PSU Information Class" allOf: - "$ref": "#/definitions/RequestHeaderWithoutToken" - type: object required: - token properties: token: type: string description: "Token autoryzacyjny / Authorization token" RequestHeaderAIS: description: "Klasa zawierająca informacje o PSU / PSU Information Class" allOf: - "$ref": "#/definitions/RequestHeaderWithoutToken" - type: object required: - token properties: token: type: string description: "Token autoryzacyjny / Authorization token" isDirectPsu: type: boolean description: "(true/false) Znacznik informujący czy request jest przesłany bezpośrednio przez PSU. Domyślna wartość to false. / Is request sent by PSU directly. false is default value." RequestHeaderAISCallback: description: "Klasa zawierająca informacje o PSU and callback URL / PSU and callback URL Information Class" allOf: - "$ref": "#/definitions/RequestHeaderWithoutToken" - type: object required: - token properties: token: type: string description: "Token autoryzacyjny / Authorization token" isDirectPsu: type: boolean description: "(true/false) Znacznik informujący czy request jest przesłany bezpośrednio przez PSU. Domyślna wartość to false. / Is request sent by PSU directly. false is default value." callbackURL: type: string description: "adres funkcji zwrotnej / callback URL" apiKey: type: string description: "API key dla wywołania funkcji zwrotnej / callback API key" ResponseHeader: description: "Klasa zawierająca zwrotne metadane / Metadata Class" properties: requestId: type: string format: uuid description: "Identyfikator żądania w formacie UUID (Wariant 1, Wersja 1) zgodnym ze standardem RFC 4122 / Request ID using UUID format (Variant 1, Version 1) described in RFC 4122 standard" sendDate: type: string format: date-time description: "Data odpowiedzi, format: YYYY-MM-DDThh:mm:ss[.mmm] / Send date" isCallback: type: boolean description: "Znacznik określający czy odpowiedz zostanie przekazana w formie wywołania zwrotnego. true - gdy odpowiedz w formie wywołania zwrotnego. Inna dopuszczalna wartość to false." SenderPISForeign: description: "Klasa zawierająca dane nadawcy przelewu zagranicznego używana w żądaniach PIS / Foreign PIS services Sender Data Class" properties: accountNumber: $ref: "#/definitions/AccountNumber" #description: "Obiekt klasy AccountNumber / AccountNumber class object" name: type: string maxLength: 140 description: "Nazwa nadawcy / Sender name" SenderPISDomestic: description: "Klasa zawierająca dane nadawcy przelewu krajowego używana w żądaniach PIS / Domestic PIS services Sender Data Class" properties: accountNumber: $ref: "#/definitions/AccountNumber" #description: "Obiekt klasy AccountNumber / AccountNumber class object" nameAddress: $ref: "#/definitions/NameAddress" #description: "Nazwa i adres nadawcy - Obiekt klasy NameAddress / Sender's name and address - NameAddress class object" Bank: description: "Klasa zawierająca dane banku używana w żądaniach AIS / AIS Bank Data Class" properties: bicOrSwift: type: string maxLength: 11 description: "Numer BIC/SWIFT Banku / BIC/SWIFT number" name: type: string maxLength: 70 description: "Nazwa Banku / Bank's name" code: type: string maxLength: 10 description: "Kod Banku, dla przelewów zagranicznych / Bank's code" countryCode: type: string maxLength: 3 description: "Kod kraju 3166-1 / Country code" address: $ref: "#/definitions/Address" #description: "Obiekt klasy Address / Address class object" BankAccountInfo: description: "Klasa zawierająca dane banku / Bank Data Class" properties: bicOrSwift: type: string maxLength: 8 description: "Numer BIC/SWIFT Banku / BIC/SWIFT number" name: type: string maxLength: 70 description: "Nazwa Banku / Bank's name" address: $ref: "#/definitions/Address" #description: "Obiekt klasy Address / Address class object" RecurringTransferParameters: description: "Klasa definiująca parametry płatności cyklicznej / A class defining recurring payment parameters" type: object required: - startDate - frequency - endDate - dayOffOffsetType properties: startDate: type: string format: date maxLength: 10 description: "Data wykonania pierwszej płatności w definiowanym cyklu. Format: YYYY-MM-DD / First payment execution date (of the defined cycle)." frequency: $ref: "#/definitions/RecurringTransferFrequency" endDate: type: string format: date maxLength: 10 description: "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: type: string description: "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 #description: "Przelew powinien zostać wykonany w ostatnim możliwym dniu niebędącym dniem wolnym od pracy ale przed wyznaczoną datą / The transfer should be made on the last possible day that is not a day off from work, but before the designated date" - after #description: "Przelew powinien zostać wykonany w pierwszym możliwym dniu niebędącym dniem wolnym od pracy ale po wyznaczonej dacie / The transfer should be made on the first possible day that is not a day off from work, but after the designated date" RecurringTransferFrequency: description: "Klasa opisująca parametry częśtotliwości wykonywania płatności cyklicznej / A class defining parameters of the frequency of recurring paymenets" type: object required: - periodType - periodValue properties: periodType: type: string description: "Typ jednostki okresu czasu / The type of unit of time period" enum: - day - week - month periodValue: type: integer description: "Wartość jednostki okresu czasu / The value of unit of time period" minimum: 1 TransferDataBase: description: "Bazowa klasa dla TransferData / TransferData Base Class" type: object properties: description: type: string maxLength: 140 description: "Pole opisujące przelew / Description" amount: type: string pattern: '^\d*\.\d{2}$' description: "Kwota przelewu / Amount" executionDate: type: string format: date maxLength: 10 description: "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: $ref: "#/definitions/RecurringTransferParameters" #description: "Dane określające parametry płatności cyklicznych. Wymagany dla atrybutu executionMode o wartości Recurring / Data defining parameters of recurring payments. Required when executionMode attribute has Recurring value." TransferDataBaseTax: description: "Bazowa klasa dla TransferData / TransferData Base Class" type: object properties: amount: type: string pattern: '^\d*\.\d{2}$' description: "Kwota przelewu / Amount" executionDate: type: string format: date maxLength: 10 description: "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: $ref: "#/definitions/RecurringTransferParameters" #description: "Dane określające parametry płatności cyklicznych. Wymagany dla atrybutu executionMode o wartości Recurring / Data defining parameters of recurring payments. Required when executionMode attribute has Recurring value." TransferData: description: "Klasa zawierająca dane przelewu / Transfer Data Class" allOf: - "$ref": "#/definitions/TransferDataBase" - type: object required: - description - amount properties: currency: type: string maxLength: 3 description: "Waluta / Currency" TransferDataCurrencyRequired: description: "Klasa zawierająca dane przelewu / Transfer Data Class" allOf: - "$ref": "#/definitions/TransferDataBase" - type: object required: - description - amount - currency properties: currency: type: string maxLength: 3 description: "Waluta, domyślnie EUR przelewów zagranicznych / Currency" TransferDataCurrencyRequiredTax: description: "Klasa zawierająca dane przelewu / Transfer Data Class" allOf: - "$ref": "#/definitions/TransferDataBaseTax" - type: object required: - amount - currency properties: currency: type: string maxLength: 3 description: "Waluta, domyślnie EUR przelewów zagranicznych / Currency" SenderRecipient: description: "Klasa zawierająca dane nadawcy/odbiorcy używana w żądaniach AIS / AIS Sender Recipient Data Class" properties: accountNumber: type: string description: "Numer konta odbiorcy / Account number" accountMassPayment: type: string description: "Numer wirtualny rachunku odbiorcy w formacie / Virtual account name" bank: $ref: "#/definitions/Bank" #description: "Obiekt klasy Bank / Bank class object" nameAddress: $ref: "#/definitions/NameAddress" #description: "Obiekt klasy NameAddress / NameAddress class object" RecipientPIS: description: "Klasa zawierająca dane odbiorcy używana w żądaniach PIS / PIS Recipient Data Class" required: - nameAddress - accountNumber properties: accountNumber: $ref: "#/definitions/AccountNumber" #description: "Obiekt klasy AccountNumber / AccountNumber class object" nameAddress: $ref: "#/definitions/NameAddress" #description: "Nazwa i adres odbiorcy - Obiekt klasy NameAddress / Recipient's name and address - NameAddress class object" RecipientPISTax: description: "Klasa zawierająca dane odbiorcy używana w żądaniach PIS dla operacji podatkowych / PIS Tax Recipient Data Class" required: - nameAddress - accountNumber properties: accountNumber: $ref: "#/definitions/AccountNumber" #description: "Obiekt klasy AccountNumber / AccountNumber class object" nameAddress: $ref: "#/definitions/NameAddress" #description: "Nazwa i adres odbiorcy - Obiekt klasy NameAddress / Recipient's name and address - NameAddress class object" RecipientPISForeign: description: "Klasa zawierająca dane odbiorcy używana w żądaniach PIS dla operacji zagranicznych / PIS foreign Recipient Data Class" required: - name - accountNumber properties: accountNumber: $ref: "#/definitions/AccountForeign" #description: "Obiekt klasy AccountForeign / AccountForeign class object" name: type: string maxLength: 140 description: "Recipient's name / Name" address: $ref: "#/definitions/Address" #description: "Obiekt klasy Address / Address class object" Address: description: "Klasa zawierająca dane adresu pocztowego / Postal address Class" type: array minItems: 1 maxItems: 4 items: type: string maxLength: 35 NameAddress: description: "Klasa zawierająca dane nazwy i adresu w postaci czterech linii danych / Simple name and postal address Class" properties: value: type: array minItems: 1 maxItems: 4 items: type: string maxLength: 35 PageInfo: description: "Klasa zawierająca dane pozwalajace na korzystanie z mechanizmu stronicowania / Paging Information Class" properties: previousPage: type: string description: "Użyte w celu stronicowania danych: poprzednia strona (np: kolejny numer porządkowy konta lub transakcji rozpoczynający poprzednią stronę) / Previous page" nextPage: type: string description: "Użyte w celu stronicowania danych: następna strona (np: kolejny numer porządkowy konta lub transakcji rozpoczynający następną stronę) / Next page" CurrencyRate: description: "Klasa zawierająca kursy przewalutowań / Currency rate" properties: rate: type: number format: double pattern: '^(0|([1-9][0-9]{0,3}))(\.[0-9]{1,7})?$' description: "Kursy przewalutowania / Currency exchange rate" fromCurrency: type: string maxLength: 3 description: "Waluta rachunku, kod ISO / from Currency, ISO code" toCurrency: type: string maxLength: 3 description: "Waluta rachunku, kod ISO / to Currency, ISO code" PaymentStatus: description: "Słownik statusów płatności" type: string enum: - submitted - cancelled - pending - done - rejected - scheduled Map: description: "Klasa mapy / Map (Dictionary) class" type : object additionalProperties: type: string DictionaryItem: description: "Klasa zawierająca dane elementu/pozycji słownika / Dictionary Item Class" properties: code: type: string description: "Kod pozycji słownika / Code" description: type: string description: "Opis pozycji słownika / Description" ScopeDetailsInput: description: Zakres, limity, parametry i czas ważności zgód, o które prosi TPP. / Scope, limits, parameters and expiration time of consents requested by TPP type: object required: - consentId - privilegeList - scopeGroupType - scopeTimeDuration - scopeTimeLimit - throttlingPolicy properties: privilegeList: "$ref": "#/definitions/ScopeDetailsInputPrivilegeList" scopeGroupType: type: string description: Type of consent enum: - ais-accounts - ais - pis consentId: type: string description: Id of consent resource: "$ref": "#/definitions/ScopeDetailsInputResource" scopeTimeDuration: type: integer description: Validity in minutes scopeTimeLimit: type: string format: date-time description: Data ważności zgody / consent valid until, YYYY-MM-DDThh:mm:ss[.mmm] throttlingPolicy: type: string description: Throttling policy enum: - psd2Regulatory ScopeDetailsOutput: description: Zakres, limity, parametry i czas ważności zgód, które potwierdza ASPSP / Scope, limits, parameters and expiration time of consents that are confimed by ASPSP type: object required: - consentId - privilegeList - scopeGroupType - scopeTimeDuration - scopeTimeLimit - throttlingPolicy properties: privilegeList: "$ref": "#/definitions/ScopeDetailsOutputPrivilegeList" scopeGroupType: type: string description: Type of consent enum: - ais-accounts - ais - pis consentId: type: string description: Id of consent resource: "$ref": "#/definitions/ScopeDetailsOutputResource" scopeTimeDuration: type: integer description: Validity in minutes scopeTimeLimit: type: string format: date-time description: Data ważności zgody / consent valid until, YYYY-MM-DDThh:mm:ss[.mmm] throttlingPolicy: type: string description: Throttling policy enum: - psd2Regulatory example: consentId: consentId resource: accounts: - accounts - accounts scopeTimeLimit: scopeTimeLimit scopeTimeDuration: 3 throttlingPolicy: psd2Regulatory scopeGroupType: ais privilegeList: ais:getTransactionsDone: notAfter: notAfter scopeUsageLimit: single maxAllowedHistoryLong: 880 notBefore: notBefore ais:getHolds: notAfter: notAfter scopeUsageLimit: single maxAllowedHistoryLong: 880 notBefore: notBefore ais:getTransactionsRejected: notAfter: notAfter scopeUsageLimit: single maxAllowedHistoryLong: 880 notBefore: notBefore ais:getTransactionsCancelled: notAfter: notAfter scopeUsageLimit: single maxAllowedHistoryLong: 880 notBefore: notBefore ais:getTransactionsScheduled: notAfter: notAfter scopeUsageLimit: single maxAllowedHistoryLong: 880 notBefore: notBefore ais-accounts:getAccounts: notAfter: notAfter scopeUsageLimit: single maxAllowedHistoryLong: 880 notBefore: notBefore pis:tax: scopeUsageLimit: single pis:getPayment: scopeUsageLimit: single pis:domestic: scopeUsageLimit: single ais:getTransactionDetail: notAfter: notAfter scopeUsageLimit: single maxAllowedHistoryLong: 880 notBefore: notBefore ais:getTransactionsPending: notAfter: notAfter scopeUsageLimit: single maxAllowedHistoryLong: 880 notBefore: notBefore pis:foreign: scopeUsageLimit: single pis:bundle: scopeUsageLimit: single PrivilegeAisAspspInSimple: description: Lista atrybutów uprawnienia usługi AIS będących przedmiotem zapytania o zgodę PSU / The list of attributes of the privilege of the AIS service that are the subject of the request for PSU's consent type: object properties: scopeUsageLimit: type: string enum: - single #description: "Udzielona zgoda pozwala na jendokrotne użycie w komunikacji z interfejsem XS2A / Consent has been accepted for single use of XS2A interface" - multiple #description: "Udzielona zgoda pozwala na wielokrotne użycie w komunikacji z interfejsem XS2A / Consent has been accepted for multiple use of XS2A interface" description: Rodzaj limitu zgody / Type of limit of usages PrivilegeAisAspspIn: description: Lista atrybutów uprawnienia usługi AIS będących przedmiotem zapytania o zgodę PSU / The list of attributes of the privilege of the AIS service that are the subject of the request for PSU's consent type: object required: - maxAllowedHistoryLong properties: scopeUsageLimit: type: string enum: - single #description: "Udzielona zgoda pozwala na jendokrotne użycie w komunikacji z interfejsem XS2A / Consent has been accepted for single use of XS2A interface" - multiple #description: "Udzielona zgoda pozwala na wielokrotne użycie w komunikacji z interfejsem XS2A / Consent has been accepted for multiple use of XS2A interface" description: Rodzaj limitu zgody / Type of limit of usages maxAllowedHistoryLong: type: integer description: How much history is allowed in days minimum: 1 maximum: 1460 PrivilegeAisAspspOutSimple: description: Lista atrybutów uprawnienia usługi AIS dla których została wyrażona zgoda przez PSU / The list of attributes of the privilege of the AIS service that the PSU's consent has been confirmed type: object properties: scopeUsageLimit: type: string enum: - single #description: "Udzielona zgoda pozwala na jendokrotne użycie w komunikacji z interfejsem XS2A / Consent has been accepted for single use of XS2A interface" - multiple #description: "Udzielona zgoda pozwala na wielokrotne użycie w komunikacji z interfejsem XS2A / Consent has been accepted for multiple use of XS2A interface" description: Rodzaj limitu zgody / Type of limit of usages PrivilegeAisAspspOut: description: Lista atrybutów uprawnienia usługi AIS dla których została wyrażona zgoda przez PSU / The list of attributes of the privilege of the AIS service that the PSU's consent has been confirmed type: object required: - maxAllowedHistoryLong - notAfter - notBefore properties: scopeUsageLimit: type: string enum: - single #description: "Udzielona zgoda pozwala na jendokrotne użycie w komunikacji z interfejsem XS2A / Consent has been accepted for single use of XS2A interface" - multiple #description: "Udzielona zgoda pozwala na wielokrotne użycie w komunikacji z interfejsem XS2A / Consent has been accepted for multiple use of XS2A interface" description: Rodzaj limitu zgody / Type of limit of usages maxAllowedHistoryLong: type: integer description: How much history is allowed in days minimum: 1 maximum: 1460 notBefore: type: string format: date-time description: Pierwsza dopuszczalna data zwróconej tramsakcji / Minimum date for transaction that will be returned, YYYY-MM-DDThh:mm:ss[.mmm] notAfter: type: string format: date-time description: Ostatnia dopuszczalna data zwróconej transakcji / Maximum date for transaction that will be returned, YYYY-MM-DDThh:mm:ss[.mmm] example: notAfter: notAfter scopeUsageLimit: single maxAllowedHistoryLong: 880 notBefore: notBefore PrivilegePayment: description: Lista atrybutów uprawnienia do żądania statusu płatności / The list of attributes of the payment status request privilege type: object properties: scopeUsageLimit: type: string enum: - single #description: "Udzielona zgoda pozwala na jendokrotne użycie w komunikacji z interfejsem XS2A / Consent has been accepted for single use of XS2A interface" - multiple #description: "Udzielona zgoda pozwala na wielokrotne użycie w komunikacji z interfejsem XS2A / Consent has been accepted for multiple use of XS2A interface" description: Rodzaj limitu zgody / Type of limit of usages transactionId: type: string description: Identyfikator płatności / Transaction ID PrivilegeBundle: description: Lista atrybutów uprawnienia do żądania statusu paczki płatności / The list of attributes of the bundle of payments status request privilege type: object properties: scopeUsageLimit: type: string enum: - single #description: "Udzielona zgoda pozwala na jendokrotne użycie w komunikacji z interfejsem XS2A / Consent has been accepted for single use of XS2A interface" - multiple #description: "Udzielona zgoda pozwala na wielokrotne użycie w komunikacji z interfejsem XS2A / Consent has been accepted for multiple use of XS2A interface" description: Rodzaj limitu zgody / Type of limit of usages bundleId: type: string description: Identyfikator paczki płatności / Bundle of payments ID PrivilegeDomesticTransfer: description: Lista atrybutów uprawnienia do inicjacji przelewu zwykłego / The list of attributes of the domestic transfer request initiation privilege type: object properties: scopeUsageLimit: type: string enum: - single #description: "Udzielona zgoda pozwala na jendokrotne użycie w komunikacji z interfejsem XS2A / Consent has been accepted for single use of XS2A interface" - multiple #description: "Udzielona zgoda pozwala na wielokrotne użycie w komunikacji z interfejsem XS2A / Consent has been accepted for multiple use of XS2A interface" description: Rodzaj limitu zgody / Type of limit of usages recipient: "$ref": "#/definitions/RecipientPIS" sender: "$ref": "#/definitions/SenderPISDomestic" transferData: "$ref": "#/definitions/TransferData" deliveryMode: description: "Tryb pilności / Urgency mode" type: string enum: - ExpressD0 - StandardD1 system: description: "Droga jaką przelew ma być rozliczony / The way the transfer should be settled" type: string enum: - Elixir - ExpressElixir - Sorbnet - BlueCash - Internal executionMode: description: "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." type: string enum: - Immediate #description: "The payment is to be executed immediately" - FutureDated #description: "The payment is to be executed according to specific date in the future required to pass by TPP" - Recurring #description: "The payment is to be executed recurringly according to additional parameters required to pass by TPP" PrivilegeForeignTransferEEA: description: Lista atrybutów uprawnienia do inicjacji przelewu zagranicznego EEA / The list of attributes of the EEA foreign transfer request initiation privilege type: object properties: scopeUsageLimit: type: string enum: - single #description: "Udzielona zgoda pozwala na jendokrotne użycie w komunikacji z interfejsem XS2A / Consent has been accepted for single use of XS2A interface" - multiple #description: "Udzielona zgoda pozwala na wielokrotne użycie w komunikacji z interfejsem XS2A / Consent has been accepted for multiple use of XS2A interface" description: Rodzaj limitu zgody / Type of limit of usages recipient: "$ref": "#/definitions/RecipientPISForeign" sender: "$ref": "#/definitions/SenderPISForeign" transferData: "$ref": "#/definitions/TransferDataCurrencyRequired" deliveryMode: description: "Tryb pilności / Urgency mode" type: string enum: - ExpressD0 - StandardD1 system: description: "Droga jaką przelew ma być rozliczony / The way the transfer should be settled" type: string enum: - SEPA - InstantSEPA - Target executionMode: description: "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." type: string enum: - Immediate #description: "The payment is to be executed immediately" - FutureDated #description: "The payment is to be executed according to specific date in the future required to pass by TPP" - Recurring #description: "The payment is to be executed recurringly according to additional parameters required to pass by TPP" PrivilegeForeignTransferNonEEA: description: Lista atrybutów uprawnienia do inicjacji przelewu zagranicznego bez EEA / The list of attributes of the non-EEA foreign transfer request initiation privilege type: object properties: scopeUsageLimit: type: string enum: - single #description: "Udzielona zgoda pozwala na jendokrotne użycie w komunikacji z interfejsem XS2A / Consent has been accepted for single use of XS2A interface" - multiple #description: "Udzielona zgoda pozwala na wielokrotne użycie w komunikacji z interfejsem XS2A / Consent has been accepted for multiple use of XS2A interface" description: Rodzaj limitu zgody / Type of limit of usages recipient: "$ref": "#/definitions/RecipientPISForeign" recipientBank: "$ref": "#/definitions/Bank" sender: "$ref": "#/definitions/SenderPISForeign" transferData: "$ref": "#/definitions/TransferDataCurrencyRequired" transferCharges: type: string maxLength: 3 description: "Klauzula kosztowa / The cost clause" deliveryMode: description: "Tryb pilności / Urgency mode" type: string enum: - ExpressD0 - UrgentD1 - StandardD2 system: description: "Droga jaką przelew ma być rozliczony / The way the transfer should be settled" type: string enum: - Swift executionMode: description: "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." type: string enum: - Immediate #description: "The payment is to be executed immediately" - FutureDated #description: "The payment is to be executed according to specific date in the future required to pass by TPP" - Recurring #description: "The payment is to be executed recurringly according to additional parameters required to pass by TPP" PrivilegeTaxTransfer: description: Lista atrybutów uprawnienia do inicjacji przelewu urzędu podatkowego / The list of attributes of the tax transfer request initiation privilege type: object properties: scopeUsageLimit: type: string enum: - single #description: "Udzielona zgoda pozwala na jendokrotne użycie w komunikacji z interfejsem XS2A / Consent has been accepted for single use of XS2A interface" - multiple #description: "Udzielona zgoda pozwala na wielokrotne użycie w komunikacji z interfejsem XS2A / Consent has been accepted for multiple use of XS2A interface" description: Rodzaj limitu zgody / Type of limit of usages recipient: "$ref": "#/definitions/RecipientPISTax" sender: "$ref": "#/definitions/SenderPISDomestic" transferData: "$ref": "#/definitions/TransferDataCurrencyRequiredTax" usInfo: "$ref": "#/definitions/TransactionInfoTax" deliveryMode: description: "Tryb pilności / Urgency mode" type: string enum: - ExpressD0 - StandardD1 system: description: "Droga jaką przelew ma być rozliczony / The way the transfer should be settled" type: string enum: - Elixir - ExpressElixir executionMode: description: "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." type: string enum: - Immediate #description: "The payment is to be executed immediately" - FutureDated #description: "The payment is to be executed according to specific date in the future required to pass by TPP" - Recurring #description: "The payment is to be executed recurringly according to additional parameters required to pass by TPP" PrivilegeCancelPayment: description: Lista atrybutów uprawnienia do odwołania zainicjowanego przelewu / The list of attributes of the cancel initiated payment request privilege type: object properties: scopeUsageLimit: type: string enum: - single #description: "Udzielona zgoda pozwala na jendokrotne użycie w komunikacji z interfejsem XS2A / Consent has been accepted for single use of XS2A interface" - multiple #description: "Udzielona zgoda pozwala na wielokrotne użycie w komunikacji z interfejsem XS2A / Consent has been accepted for multiple use of XS2A interface" description: Rodzaj limitu zgody / Type of limit of usages transactionId: type: string maxLength: 64 description: "Identyfikator płatności / Transaction ID" bundleId: type: string description: "Identyfikator paczki przelewów / Bundle of payments ID" PrivilegeBundleTransfers: description: Lista atrybutów uprawnienia do zainicjowania paczki przelewu / The list of attributes of the initiate bundle of payments request privilege type: object properties: scopeUsageLimit: type: string enum: - single #description: "Udzielona zgoda pozwala na jendokrotne użycie w komunikacji z interfejsem XS2A / Consent has been accepted for single use of XS2A interface" - multiple #description: "Udzielona zgoda pozwala na wielokrotne użycie w komunikacji z interfejsem XS2A / Consent has been accepted for multiple use of XS2A interface" description: Rodzaj limitu zgody / Type of limit of usages transfersTotalAmount: description: "Łączna kwota wszystkich przelewów z paczki / The total amount of all transfers from bundle" type: string pattern: '^\d*\.\d{2}$' typeOfTransfers: description: "Typ przelewów, które zostaną zlecone w ramach paczki / The type of transfers that will be initiated through the bundle" type: string enum: - domestic - EEA - nonEEA - tax domesticTransfers: description: "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." type: array items: $ref: "#/definitions/PaymentDomesticRequestBundled" EEATransfers: description: "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." type: array items: $ref: "#/definitions/PaymentEEARequestBundled" nonEEATransfers: description: "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." type: array items: $ref: "#/definitions/PaymentNonEEARequestBundled" taxTransfers: description: "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." type: array items: $ref: "#/definitions/PaymentTaxRequestBundled" ScopeDetailsInputPrivilegeList: description: Pełna lista uprawnień będących przedmiotem zapytania o zgodę PSU / The list of all privileges that are the subject of the request for PSU's consent properties: ais-accounts:getAccounts: "$ref": "#/definitions/PrivilegeAisAspspInSimple" ais:getAccount: "$ref": "#/definitions/PrivilegeAisAspspInSimple" ais:getHolds: "$ref": "#/definitions/PrivilegeAisAspspIn" ais:getTransactionsDone: "$ref": "#/definitions/PrivilegeAisAspspIn" ais:getTransactionsPending: "$ref": "#/definitions/PrivilegeAisAspspIn" ais:getTransactionsRejected: "$ref": "#/definitions/PrivilegeAisAspspIn" ais:getTransactionsCancelled: "$ref": "#/definitions/PrivilegeAisAspspIn" ais:getTransactionsScheduled: "$ref": "#/definitions/PrivilegeAisAspspIn" ais:getTransactionDetail: "$ref": "#/definitions/PrivilegeAisAspspInSimple" pis:getPayment: "$ref": "#/definitions/PrivilegePayment" pis:getBundle: "$ref": "#/definitions/PrivilegeBundle" pis:domestic: "$ref": "#/definitions/PrivilegeDomesticTransfer" pis:EEA: "$ref": "#/definitions/PrivilegeForeignTransferEEA" pis:nonEEA: "$ref": "#/definitions/PrivilegeForeignTransferNonEEA" pis:tax: "$ref": "#/definitions/PrivilegeTaxTransfer" pis:cancelPayment: "$ref": "#/definitions/PrivilegeCancelPayment" pis:bundle: "$ref": "#/definitions/PrivilegeBundleTransfers" ScopeDetailsInputResource: description: Pełna lista zasobów - rachunków płatniczych - których dotyczy żądanie zgody PSU / The full list o resources (accounts) that the PSU's consent is connected with required: - accounts properties: accounts: type: array description: Account numbers in format items: type: string description: Account numbers List example: accounts: - accounts - accounts ScopeDetailsOutputResource: description: Pełna lista zasobów - rachunków płatniczych - których dotyczy uzyskana zgoda od PSU / The full list o resources (accounts) that the gained PSU's consent is connected with required: - accounts properties: accounts: type: array description: Account numbers in format items: type: string description: Account numbers List example: accounts: - accounts - accounts ScopeDetailsOutputPrivilegeList: description: Pełna lista uprawnień, dla których została wyrażona zgoda przez PSU / The list of all privileges that the PSU's consent has been confirmed properties: ais-accounts:getAccounts: "$ref": "#/definitions/PrivilegeAisAspspOutSimple" ais:getAccount: "$ref": "#/definitions/PrivilegeAisAspspOutSimple" ais:getHolds: "$ref": "#/definitions/PrivilegeAisAspspOut" ais:getTransactionsDone: "$ref": "#/definitions/PrivilegeAisAspspOut" ais:getTransactionsPending: "$ref": "#/definitions/PrivilegeAisAspspOut" ais:getTransactionsRejected: "$ref": "#/definitions/PrivilegeAisAspspOut" ais:getTransactionsCancelled: "$ref": "#/definitions/PrivilegeAisAspspOut" ais:getTransactionsScheduled: "$ref": "#/definitions/PrivilegeAisAspspOut" ais:getTransactionDetail: "$ref": "#/definitions/PrivilegeAisAspspOutSimple" pis:getPayment: "$ref": "#/definitions/PrivilegePayment" pis:getBundle: "$ref": "#/definitions/PrivilegeBundle" pis:domestic: "$ref": "#/definitions/PrivilegeDomesticTransfer" pis:EEA: "$ref": "#/definitions/PrivilegeForeignTransferEEA" pis:nonEEA: "$ref": "#/definitions/PrivilegeForeignTransferNonEEA" pis:tax: "$ref": "#/definitions/PrivilegeTaxTransfer" pis:cancelPayment: "$ref": "#/definitions/PrivilegeCancelPayment" pis:bundle: "$ref": "#/definitions/PrivilegeBundleTransfers" example: ais:getTransactionsDone: notAfter: notAfter scopeUsageLimit: single maxAllowedHistoryLong: 880 notBefore: notBefore ais:getHolds: notAfter: notAfter scopeUsageLimit: single maxAllowedHistoryLong: 880 notBefore: notBefore ais:getTransactionsRejected: notAfter: notAfter scopeUsageLimit: single maxAllowedHistoryLong: 880 notBefore: notBefore ais:getTransactionsCancelled: notAfter: notAfter scopeUsageLimit: single maxAllowedHistoryLong: 880 notBefore: notBefore ais:getTransactionsScheduled: notAfter: notAfter scopeUsageLimit: single maxAllowedHistoryLong: 880 notBefore: notBefore ais-accounts:getAccounts: notAfter: notAfter scopeUsageLimit: single maxAllowedHistoryLong: 880 notBefore: notBefore pis:tax: scopeUsageLimit: single pis:getPayment: scopeUsageLimit: single pis:domestic: scopeUsageLimit: single ais:getTransactionDetail: notAfter: notAfter scopeUsageLimit: single maxAllowedHistoryLong: 880 notBefore: notBefore ais:getTransactionsPending: notAfter: notAfter scopeUsageLimit: single maxAllowedHistoryLong: 880 notBefore: notBefore pis:foreign: scopeUsageLimit: single pis:cancelPayment: scopeUsageLimit: single transactionId: 12345 bundleId: 12345 pis:bundle: scopeUsageLimit: single