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

Cancelation of future dated payment

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: 

								
									
{
  "payments":[{
    "generalStatus":{
      
    },
    "tppTransactionId":"tppTransactionId",
    "detailedStatus":"detailedStatus",
    "paymentId":"paymentId",
    "executionMode":"Immediate"
  },{
    "generalStatus":{
      
    },
    "tppTransactionId":"tppTransactionId",
    "detailedStatus":"detailedStatus",
    "paymentId":"paymentId",
    "executionMode":"Immediate"
  }]
}
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 cancelPayments, operation_id: PAPIv2.1.1.1-cancelPayments Tags: PIS, Mocked-Data,

Cancelation of recurring payment

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: 

								
									
{
  "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"
}
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 cancelRecurringPayment, operation_id: PAPIv2.1.1.1-cancelRecurringPayment Tags: PIS, Mocked-Data,

Defines new recurring payment

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: 

								
									
{
  "recurrence":{
    "endDate":"2000-01-23",
    "startDate":"2000-01-23",
    "frequency":{
      "periodType":"day",
      "periodValue":1
    },
    "dayOffOffsetType":"before"
  },
  "recurringPaymentId":"recurringPaymentId",
  "recurringPaymentStatus":"submitted",
  "recurringPaymentDetailedStatus":"recurringPaymentDetailedStatus"
}
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 recurring, operation_id: PAPIv2.1.1.1-recurring Tags: PIS, Mocked-Data,

Get the status of bundle of payments

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: 

								
									
{
  "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"
}
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 getBundle, operation_id: PAPIv2.1.1.1-getBundle Tags: PIS, Mocked-Data,

Get the status of multiple payments

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: 

								
									
{
  "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
  }
}
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 getMultiplePayments, operation_id: PAPIv2.1.1.1-getMultiplePayments Tags: PIS, Mocked-Data,

Get the status of payment

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: 

								
									
{
  "jvalueToCaseclass":""
}
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 getPayment, operation_id: PAPIv2.1.1.1-getPayment Tags: PIS, Mocked-Data,

Get the status of recurring payment

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: 

								
									
{
  "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"
}
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 getRecurringPayment, operation_id: PAPIv2.1.1.1-getRecurringPayment Tags: PIS, Mocked-Data,

Initiate SEPA foreign transfers

NOTE: This endpoint currently only returns example data.

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

URL Parameters:

EEA: EEA

JSON request body fields:

JSON response body fields:

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
  }
}
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 eEA, operation_id: PAPIv2.1.1.1-eEA Tags: PIS, Mocked-Data,

Initiate domestic transfer

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: 

								
									
{
  "generalStatus":{
    
  },
  "detailedStatus":"detailedStatus",
  "paymentId":"paymentId",
  "responseHeader":{
    "sendDate":"2000-01-23T04:56:07.000+00:00",
    "requestId":"046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "isCallback":true
  }
}
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 domestic, operation_id: PAPIv2.1.1.1-domestic Tags: PIS, Mocked-Data,

Initiate many transfers as bundle

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: 

								
									
{
  "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"
}
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 bundle, operation_id: PAPIv2.1.1.1-bundle Tags: PIS, Mocked-Data,

Initiate non SEPA foreign transfers

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: 

								
									
{
  "generalStatus":{
    
  },
  "detailedStatus":"detailedStatus",
  "paymentId":"paymentId",
  "responseHeader":{
    "sendDate":"2000-01-23T04:56:07.000+00:00",
    "requestId":"046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "isCallback":true
  }
}
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 nonEEA, operation_id: PAPIv2.1.1.1-nonEEA Tags: PIS, Mocked-Data,

Initiate tax transfer

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: 

								
									
{
  "generalStatus":{
    
  },
  "detailedStatus":"detailedStatus",
  "paymentId":"paymentId",
  "responseHeader":{
    "sendDate":"2000-01-23T04:56:07.000+00:00",
    "requestId":"046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "isCallback":true
  }
}
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 tax, operation_id: PAPIv2.1.1.1-tax Tags: PIS, Mocked-Data,