API Explorer

Polish PAPIv2.1.1.1 (26 APIs)

Bank

Accounts

Views

Counterparties

Transactions

Get detailed information about user payment account

NOTE: This endpoint currently only returns example data.

User identification based on access token

Typical Successful Response:

								
									
{ "responseHeader":{ "sendDate":"2000-01-23T04:56:07.000+00:00", "requestId":"046b6c7f-0b8a-43b9-b35d-6489e6daee91", "isCallback":true }, "account":{ "auxData":{ }, "bank":{ "address":"", "bicOrSwift":"bicOrSwift", "name":"name" }, "bookingBalance":"bookingBalance", "accountType":{ "code":"code", "description":"description" }, "accountTypeName":"accountTypeName", "currency":"currency", "nameAddress":{ "value":["value","value","value","value"] }, "accountNumber":"accountNumber", "accountNameClient":"accountNameClient", "accountHolderType":"individual", "availableBalance":"availableBalance" } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in PAPIv2.1.1.1 by getAccount

Get detailed information about user's single transaction

NOTE: This endpoint currently only returns example data.

Typical Successful Response:

								
									
{ "baseInfo":"", "cardInfo":{ "cardHolder":"cardHolder", "cardNumber":"cardNumber" }, "responseHeader":{ "sendDate":"2000-01-23T04:56:07.000+00:00", "requestId":"046b6c7f-0b8a-43b9-b35d-6489e6daee91", "isCallback":true }, "baseCurrency":"baseCurrency", "usedPaymentInstrumentId":"usedPaymentInstrumentId", "holdExpirationDate":"2000-01-23T04:56:07.000+00:00", "zusInfo":{ "contributionType":"contributionType", "contributionId":"contributionId", "paymentTypeId":"paymentTypeId", "payerInfo":{ "nip":"nip", "additionalPayorId":"additionalPayorId", "additionalPayorIdType":"P" }, "contributionPeriod":"contributionPeriod", "obligationId":"obligationId" }, "usInfo":{ "periodId":"periodId", "periodType":"periodType", "payerInfo":{ "payorId":"payorId", "payorIdType":"N" }, "formCode":"formCode", "year":6026, "obligationId":"obligationId" }, "tppTransactionId":"tppTransactionId", "transactionRate":[{ "rate":0.8008281904610115, "toCurrency":"toCurrency", "fromCurrency":"fromCurrency" },{ "rate":0.8008281904610115, "toCurrency":"toCurrency", "fromCurrency":"fromCurrency" }], "currencyDate":"2000-01-23T04:56:07.000+00:00", "rejectionReason":"rejectionReason", "amountBaseCurrency":"amountBaseCurrency", "tppName":"tppName" }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in PAPIv2.1.1.1 by getTransactionDetail

Get information about all user's payment account

NOTE: This endpoint currently only returns example data.

User identification based on access token

Typical Successful Response:

								
									
{ "responseHeader":{ "sendDate":"2000-01-23T04:56:07.000+00:00", "requestId":"046b6c7f-0b8a-43b9-b35d-6489e6daee91", "isCallback":true }, "pageInfo":{ "previousPage":"previousPage", "nextPage":"nextPage" }, "accounts":[{ "accountType":{ "code":"code", "description":"description" }, "accountTypeName":"accountTypeName", "accountNumber":"accountNumber" },{ "accountType":{ "code":"code", "description":"description" }, "accountTypeName":"accountTypeName", "accountNumber":"accountNumber" }] }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in PAPIv2.1.1.1 by getAccounts

Get list of user cancelled transactions

NOTE: This endpoint currently only returns example data.

Typical Successful Response:

								
									
{ "responseHeader":{ "sendDate":"2000-01-23T04:56:07.000+00:00", "requestId":"046b6c7f-0b8a-43b9-b35d-6489e6daee91", "isCallback":true }, "pageInfo":{ "previousPage":"previousPage", "nextPage":"nextPage" }, "transactions":["",""] }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in PAPIv2.1.1.1 by getTransactionsCancelled

Get list of user done transactions

NOTE: This endpoint currently only returns example data.

Typical Successful Response:

								
									
{ "responseHeader":{ "sendDate":"2000-01-23T04:56:07.000+00:00", "requestId":"046b6c7f-0b8a-43b9-b35d-6489e6daee91", "isCallback":true }, "pageInfo":{ "previousPage":"previousPage", "nextPage":"nextPage" }, "transactions":["",""] }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in PAPIv2.1.1.1 by getTransactionsDone

Get list of user scheduled transactions

NOTE: This endpoint currently only returns example data.

Typical Successful Response:

								
									
{ "responseHeader":{ "sendDate":"2000-01-23T04:56:07.000+00:00", "requestId":"046b6c7f-0b8a-43b9-b35d-6489e6daee91", "isCallback":true }, "pageInfo":{ "previousPage":"previousPage", "nextPage":"nextPage" }, "transactions":["",""] }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in PAPIv2.1.1.1 by getTransactionsScheduled

Get list of user's holded operations

NOTE: This endpoint currently only returns example data.

Typical Successful Response:

								
									
{ "responseHeader":{ "sendDate":"2000-01-23T04:56:07.000+00:00", "requestId":"046b6c7f-0b8a-43b9-b35d-6489e6daee91", "isCallback":true }, "pageInfo":{ "previousPage":"previousPage", "nextPage":"nextPage" }, "holds":["",""] }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in PAPIv2.1.1.1 by getHolds

Get list of user's pending transactions

NOTE: This endpoint currently only returns example data.

Typical Successful Response:

								
									
{ "responseHeader":{ "sendDate":"2000-01-23T04:56:07.000+00:00", "requestId":"046b6c7f-0b8a-43b9-b35d-6489e6daee91", "isCallback":true }, "pageInfo":{ "previousPage":"previousPage", "nextPage":"nextPage" }, "transactions":["",""] }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in PAPIv2.1.1.1 by getTransactionsPending

Get list of user's rejected transactions

NOTE: This endpoint currently only returns example data.

Typical Successful Response:

								
									
{ "responseHeader":{ "sendDate":"2000-01-23T04:56:07.000+00:00", "requestId":"046b6c7f-0b8a-43b9-b35d-6489e6daee91", "isCallback":true }, "pageInfo":{ "previousPage":"previousPage", "nextPage":"nextPage" }, "transactions":["",""] }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in PAPIv2.1.1.1 by getTransactionsRejected

Removes consent

NOTE: This endpoint currently only returns example data.

Removes consent

Typical Successful Response:

								
									
{ }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in PAPIv2.1.1.1 by deleteConsent

Requests OAuth2 access token value

NOTE: This endpoint currently only returns example data.

Requests OAuth2 access token value

Typical Successful Response:

								
									
{ "access_token":"access_token", "refresh_token":"refresh_token", "scope_details":{ "consentId":"consentId", "resource":{ "accounts":["accounts","accounts"] }, "scopeTimeLimit":"scopeTimeLimit", "throttlingPolicy":"psd2Regulatory", "privilegeList":{ "ais:getTransactionsDone":{ "scopeUsageLimit":"single", "maxAllowedHistoryLong":880 }, "ais:getHolds":{ "scopeUsageLimit":"single", "maxAllowedHistoryLong":880 }, "ais:getTransactionsRejected":{ "scopeUsageLimit":"single", "maxAllowedHistoryLong":880 }, "ais:getTransactionsCancelled":{ "scopeUsageLimit":"single", "maxAllowedHistoryLong":880 }, "ais:getTransactionsScheduled":{ "scopeUsageLimit":"single", "maxAllowedHistoryLong":880 }, "ais-accounts:getAccounts":{ "scopeUsageLimit":"single", "maxAllowedHistoryLong":880 }, "pis:tax":{ "scopeUsageLimit":"single" }, "pis:getPayment":{ "scopeUsageLimit":"single" }, "pis:domestic":{ "scopeUsageLimit":"single" }, "ais:getTransactionDetail":{ "scopeUsageLimit":"single", "maxAllowedHistoryLong":880 }, "ais:getTransactionsPending":{ "scopeUsageLimit":"single", "maxAllowedHistoryLong":880 }, "pis:bundle":{ "scopeUsageLimit":"single" } } }, "scope":"scope", "responseHeader":{ "sendDate":"2000-01-23T04:56:07.000+00:00", "requestId":"046b6c7f-0b8a-43b9-b35d-6489e6daee91", "isCallback":true }, "token_type":"token_type", "expires_in":"expires_in" }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in PAPIv2.1.1.1 by token

Requests OAuth2 authorization code

NOTE: This endpoint currently only returns example data.

Requests OAuth2 authorization code

Typical Successful Response:

								
									
{ "responseHeader":{ "sendDate":"2000-01-23T04:56:07.000+00:00", "requestId":"046b6c7f-0b8a-43b9-b35d-6489e6daee91", "isCallback":true }, "aspspRedirectUri":"aspspRedirectUri" }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in PAPIv2.1.1.1 by authorize

Requests OAuth2 authorization code based on One-time authorization code issued by External Authorization Tool

NOTE: This endpoint currently only returns example data.

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.

Typical Successful Response:

								
									
{ }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in PAPIv2.1.1.1 by authorizeExt

Confirmation of the availability of funds

NOTE: This endpoint currently only returns example data.

Confirming the availability on the payers account of the amount necessary to execute the payment transaction, as defined in Art. 65 PSD2.

Typical Successful Response:

								
									
{ "fundsAvailable":true, "responseHeader":{ "sendDate":"2000-01-23T04:56:07.000+00:00", "requestId":"046b6c7f-0b8a-43b9-b35d-6489e6daee91", "isCallback":true } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in PAPIv2.1.1.1 by getConfirmationOfFunds

Cancelation of future dated payment

NOTE: This endpoint currently only returns example data.

Typical Successful Response:

								
									
{ "payments":[{ "generalStatus":{ }, "tppTransactionId":"tppTransactionId", "detailedStatus":"detailedStatus", "paymentId":"paymentId", "executionMode":"Immediate" },{ "generalStatus":{ }, "tppTransactionId":"tppTransactionId", "detailedStatus":"detailedStatus", "paymentId":"paymentId", "executionMode":"Immediate" }] }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in PAPIv2.1.1.1 by cancelPayments

Cancelation of recurring payment

NOTE: This endpoint currently only returns example data.

Typical Successful Response:

								
									
{ "tppRecurringPaymentId":"tppRecurringPaymentId", "recurringPaymentId":"recurringPaymentId", "responseHeader":{ "sendDate":"2000-01-23T04:56:07.000+00:00", "requestId":"046b6c7f-0b8a-43b9-b35d-6489e6daee91", "isCallback":true }, "recurringPaymentStatus":"submitted", "recurringPaymentDetailedStatus":"recurringPaymentDetailedStatus" }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in PAPIv2.1.1.1 by cancelRecurringPayment

Defines new recurring payment

NOTE: This endpoint currently only returns example data.

Typical Successful Response:

								
									
{ "recurrence":{ "endDate":"2000-01-23", "startDate":"2000-01-23", "frequency":{ "periodType":"day", "periodValue":1 }, "dayOffOffsetType":"before" }, "recurringPaymentId":"recurringPaymentId", "recurringPaymentStatus":"submitted", "recurringPaymentDetailedStatus":"recurringPaymentDetailedStatus" }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in PAPIv2.1.1.1 by recurring

Get the status of bundle of payments

NOTE: This endpoint currently only returns example data.

Typical Successful Response:

								
									
{ "tppBundleId":"tppBundleId", "payments":[{ "generalStatus":{ }, "tppTransactionId":"tppTransactionId", "detailedStatus":"detailedStatus", "paymentId":"paymentId", "executionMode":"Immediate" },{ "generalStatus":{ }, "tppTransactionId":"tppTransactionId", "detailedStatus":"detailedStatus", "paymentId":"paymentId", "executionMode":"Immediate" }], "responseHeader":{ "sendDate":"2000-01-23T04:56:07.000+00:00", "requestId":"046b6c7f-0b8a-43b9-b35d-6489e6daee91", "isCallback":true }, "bundleId":"bundleId", "bundleDetailedStatus":"bundleDetailedStatus", "bundleStatus":"inProgress" }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in PAPIv2.1.1.1 by getBundle

Get the status of multiple payments

NOTE: This endpoint currently only returns example data.

Typical Successful Response:

								
									
{ "payments":[{ "generalStatus":{ }, "tppTransactionId":"tppTransactionId", "detailedStatus":"detailedStatus", "paymentId":"paymentId", "executionMode":"Immediate" },{ "generalStatus":{ }, "tppTransactionId":"tppTransactionId", "detailedStatus":"detailedStatus", "paymentId":"paymentId", "executionMode":"Immediate" }], "responseHeader":{ "sendDate":"2000-01-23T04:56:07.000+00:00", "requestId":"046b6c7f-0b8a-43b9-b35d-6489e6daee91", "isCallback":true } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in PAPIv2.1.1.1 by getMultiplePayments

Get the status of payment

NOTE: This endpoint currently only returns example data.

Typical Successful Response:

								
									
{ "jvalueToCaseclass":"" }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in PAPIv2.1.1.1 by getPayment

Get the status of recurring payment

NOTE: This endpoint currently only returns example data.

Typical Successful Response:

								
									
{ "tppRecurringPaymentId":"tppRecurringPaymentId", "recurringPaymentId":"recurringPaymentId", "responseHeader":{ "sendDate":"2000-01-23T04:56:07.000+00:00", "requestId":"046b6c7f-0b8a-43b9-b35d-6489e6daee91", "isCallback":true }, "recurringPaymentStatus":"submitted", "recurringPaymentDetailedStatus":"recurringPaymentDetailedStatus" }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in PAPIv2.1.1.1 by getRecurringPayment

Initiate SEPA foreign transfers

NOTE: This endpoint currently only returns example data.

Typical Successful Response:

								
									
{ "generalStatus":{ }, "detailedStatus":"detailedStatus", "paymentId":"paymentId", "responseHeader":{ "sendDate":"2000-01-23T04:56:07.000+00:00", "requestId":"046b6c7f-0b8a-43b9-b35d-6489e6daee91", "isCallback":true } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in PAPIv2.1.1.1 by eEA

Initiate domestic transfer

NOTE: This endpoint currently only returns example data.

Typical Successful Response:

								
									
{ "generalStatus":{ }, "detailedStatus":"detailedStatus", "paymentId":"paymentId", "responseHeader":{ "sendDate":"2000-01-23T04:56:07.000+00:00", "requestId":"046b6c7f-0b8a-43b9-b35d-6489e6daee91", "isCallback":true } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in PAPIv2.1.1.1 by domestic

Initiate many transfers as bundle

NOTE: This endpoint currently only returns example data.

Typical Successful Response:

								
									
{ "payments":[{ "generalStatus":{ }, "tppTransactionId":"tppTransactionId", "detailedStatus":"detailedStatus", "paymentId":"paymentId", "executionMode":"Immediate" },{ "generalStatus":{ }, "tppTransactionId":"tppTransactionId", "detailedStatus":"detailedStatus", "paymentId":"paymentId", "executionMode":"Immediate" }], "bundleId":"bundleId", "bundleDetailedStatus":"bundleDetailedStatus", "bundleStatus":"inProgress" }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in PAPIv2.1.1.1 by bundle

Initiate non SEPA foreign transfers

NOTE: This endpoint currently only returns example data.

Typical Successful Response:

								
									
{ "generalStatus":{ }, "detailedStatus":"detailedStatus", "paymentId":"paymentId", "responseHeader":{ "sendDate":"2000-01-23T04:56:07.000+00:00", "requestId":"046b6c7f-0b8a-43b9-b35d-6489e6daee91", "isCallback":true } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in PAPIv2.1.1.1 by nonEEA

Initiate tax transfer

NOTE: This endpoint currently only returns example data.

Typical Successful Response:

								
									
{ "generalStatus":{ }, "detailedStatus":"detailedStatus", "paymentId":"paymentId", "responseHeader":{ "sendDate":"2000-01-23T04:56:07.000+00:00", "requestId":"046b6c7f-0b8a-43b9-b35d-6489e6daee91", "isCallback":true } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in PAPIv2.1.1.1 by tax