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

Authentication is Mandatory

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" } }
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.

Authentication is Mandatory

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" }
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

Authentication is Mandatory

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" }] }
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.

Authentication is Mandatory

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":["",""] }
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.

Authentication is Mandatory

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":["",""] }
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.

Authentication is Mandatory

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":["",""] }
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.

Authentication is Mandatory

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":["",""] }
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.

Authentication is Mandatory

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":["",""] }
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.

Authentication is Mandatory

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":["",""] }
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

Authentication is Mandatory

Typical Successful Response:

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