right logo image
right logo image
Log on
⯆

API Explorer

Log off

PAPIv2.1.1.1 (104 APIs)

API Host: https://apisandbox.openbankproject.com
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

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON request body fields:

JSON response body fields:

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"
  }
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: PAPIv2.1.1.1, function_name: by getAccount, operation_id: PAPIv2.1.1.1-getAccount Tags: AIS, Mocked-Data,

Get detailed information about user's single transaction

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON request body fields:

JSON response body fields:

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"
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: PAPIv2.1.1.1, function_name: by getTransactionDetail, operation_id: PAPIv2.1.1.1-getTransactionDetail Tags: AIS, Mocked-Data,

Get information about all user's payment account

NOTE: This endpoint currently only returns example data.

User identification based on access token

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON request body fields:

JSON response body fields:

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"
  }]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: PAPIv2.1.1.1, function_name: by getAccounts, operation_id: PAPIv2.1.1.1-getAccounts Tags: AIS, Mocked-Data,

Get list of user cancelled transactions

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON request body fields:

JSON response body fields:

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":["",""]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: PAPIv2.1.1.1, function_name: by getTransactionsCancelled, operation_id: PAPIv2.1.1.1-getTransactionsCancelled Tags: AIS, Mocked-Data,

Get list of user done transactions

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON request body fields:

JSON response body fields:

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":["",""]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: PAPIv2.1.1.1, function_name: by getTransactionsDone, operation_id: PAPIv2.1.1.1-getTransactionsDone Tags: AIS, Mocked-Data,

Get list of user scheduled transactions

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON request body fields:

JSON response body fields:

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":["",""]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: PAPIv2.1.1.1, function_name: by getTransactionsScheduled, operation_id: PAPIv2.1.1.1-getTransactionsScheduled Tags: AIS, Mocked-Data,

Get list of user's holded operations

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON request body fields:

JSON response body fields:

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":["",""]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: PAPIv2.1.1.1, function_name: by getHolds, operation_id: PAPIv2.1.1.1-getHolds Tags: AIS, Mocked-Data,

Get list of user's pending transactions

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON request body fields:

JSON response body fields:

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":["",""]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: PAPIv2.1.1.1, function_name: by getTransactionsPending, operation_id: PAPIv2.1.1.1-getTransactionsPending Tags: AIS, Mocked-Data,

Get list of user's rejected transactions

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON request body fields:

JSON response body fields:

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":["",""]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: PAPIv2.1.1.1, function_name: by getTransactionsRejected, operation_id: PAPIv2.1.1.1-getTransactionsRejected Tags: AIS, Mocked-Data,

Removes consent

NOTE: This endpoint currently only returns example data.

Removes consent

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON request body fields:

JSON response body fields:

Typical Successful Response:
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: PAPIv2.1.1.1, function_name: by deleteConsent, operation_id: PAPIv2.1.1.1-deleteConsent Tags: AIS, Mocked-Data,