-
AIS
- Get detailed information about user payment account
- Get detailed information about user's single transaction
- Get information about all user's payment account
- Get list of user cancelled transactions
- Get list of user done transactions
- Get list of user scheduled transactions
- Get list of user's holded operations
- Get list of user's pending transactions
- Get list of user's rejected transactions
- Removes consent
-
Dynamic Resource Doc
-
In OBP we largely define our endpoints using an internal case class or model called ResourceDocMore...
- A test endpoint
-
-
PIS
- Cancelation of future dated payment
- Cancelation of recurring payment
- Defines new recurring payment
- Get the status of bundle of payments
- Get the status of multiple payments
- Get the status of payment
- Get the status of recurring payment
- Initiate SEPA foreign transfers
- Initiate domestic transfer
- Initiate many transfers as bundle
- Initiate non SEPA foreign transfers
- Initiate tax transfer
-
AIS
-
Get detailed information about user payment account
-
Get detailed information about user's single transaction
-
Get information about all user's payment account
-
Get list of user cancelled transactions
-
Get list of user done transactions
-
Get list of user scheduled transactions
-
Get list of user's holded operations
-
Get list of user's pending transactions
-
Get list of user's rejected transactions
-
Removes consent
-
Get detailed information about user payment account
-
AS
-
Requests OAuth2 access token value
-
Requests OAuth2 authorization code
-
Requests OAuth2 authorization code based on One-time authorization code issued by External Authorization Tool
-
Requests OAuth2 access token value
-
CAF
-
Dynamic Resource Doc
-
PIS
-
Cancelation of future dated payment
-
Cancelation of recurring payment
-
Defines new recurring payment
-
Get the status of bundle of payments
-
Get the status of multiple payments
-
Get the status of payment
-
Get the status of recurring payment
-
Initiate SEPA foreign transfers
-
Initiate domestic transfer
-
Initiate many transfers as bundle
-
Initiate non SEPA foreign transfers
-
Initiate tax transfer
-
Cancelation of future dated payment
-
_CovidAPIDays
-
Create new Covid APIDays
-
Delete Covid APIDays by id
-
Get Covid APIDays List
-
Get Covid APIDays by id
-
Update Covid APIDays
-
Create new Covid APIDays
-
_Customer Cars
-
Create new Customer Cars
-
Delete Customer Cars by id
-
Get Customer Cars List
-
Get Customer Cars by id
-
Update Customer Cars
-
Create new Customer Cars
-
_D Entity1
-
_FishPort
-
_FooBar
-
_InsurancePolicy
-
Create new Insurance Policy
-
Delete Insurance Policy by id
-
Get Insurance Policy List
-
Get Insurance Policy by id
-
Update Insurance Policy
-
Create new Insurance Policy
-
_InsurancePremium
-
Create new Insurance Premium
-
Delete Insurance Premium by id
-
Get Insurance Premium List
-
Get Insurance Premium by id
-
Update Insurance Premium
-
Create new Insurance Premium
-
_MarchHare
-
Create new March Hare
-
Delete March Hare by id
-
Get March Hare List
-
Get March Hare by id
-
Update March Hare
-
Create new March Hare
-
_ObpActivity
-
Create new Obp Activity
-
Delete Obp Activity by id
-
Get Obp Activity List
-
Get Obp Activity by id
-
Update Obp Activity
-
Create new Obp Activity
-
_Odometer
-
_SimonCovid
-
Create new Simon Covid
-
Delete Simon Covid by id
-
Get Simon Covid List
-
Get Simon Covid by id
-
Update Simon Covid
-
Create new Simon Covid
-
_Sustrans
-
_Test1
PAPIv2.1.1.1 (92 APIs)
Cancelation of future dated payment
NOTE: This endpoint currently only returns example data.
Authentication is Mandatory
JSON request body fields:
-
bundleId: bundleId
-
paymentId: paymentId
-
requestHeader: requestHeader
JSON response body fields:
-
detailedStatus: detailedStatus
-
executionMode: executionMode
-
generalStatus: generalStatus
-
paymentId: paymentId
-
payments: payments
-
tppTransactionId: tppTransactionId
{
"payments":[{
"generalStatus":{
},
"tppTransactionId":"tppTransactionId",
"detailedStatus":"detailedStatus",
"paymentId":"paymentId",
"executionMode":"Immediate"
},{
"generalStatus":{
},
"tppTransactionId":"tppTransactionId",
"detailedStatus":"detailedStatus",
"paymentId":"paymentId",
"executionMode":"Immediate"
}]
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Cancelation of recurring payment
NOTE: This endpoint currently only returns example data.
Authentication is Mandatory
JSON request body fields:
-
recurringPaymentId: recurringPaymentId
-
requestHeader: requestHeader
JSON response body fields:
-
isCallback: isCallback
-
recurringPaymentDetailedStatus: recurringPaymentDetailedStatus
-
recurringPaymentId: recurringPaymentId
-
recurringPaymentStatus: recurringPaymentStatus
-
requestId: requestId
-
responseHeader: responseHeader
-
sendDate: sendDate
-
tppRecurringPaymentId: tppRecurringPaymentId
{
"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"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Defines new recurring payment
NOTE: This endpoint currently only returns example data.
Authentication is Mandatory
JSON request body fields:
-
EEAPayment: EEAPayment
-
accountNumber: accountNumber
-
bicOrSwift: bicOrSwift
-
[code](/glossary#Transaction Requests.Transaction Request Refund Reason Code): 125
-
countryCode: countryCode
-
dayOffOffsetType: dayOffOffsetType
-
deliveryMode: deliveryMode
-
domesticPayment: domesticPayment
-
endDate: endDate
-
formCode: formCode
-
frequency: 5
-
hold: hold
-
name: ACCOUNT_MANAGEMENT_FEE
-
nameAddress: nameAddress
-
nonEEAPayment: nonEEAPayment
-
obligationId: obligationId
-
payerInfo: payerInfo
-
payorId: payorId
-
payorIdType: payorIdType
-
periodId: periodId
-
periodType: periodType
-
periodValue: periodValue
-
recipient: recipient
-
recipientBank: recipientBank
-
recurrence: recurrence
-
requestHeader: requestHeader
-
sender: sender
-
startDate: startDate
-
system: system
-
taxPayment: taxPayment
-
tppRecurringPaymentId: tppRecurringPaymentId
-
transferCharges: transferCharges
-
transferData: transferData
-
typeOfPayment: typeOfPayment
-
usInfo: usInfo
-
value: 5987953
-
year: year
JSON response body fields:
-
dayOffOffsetType: dayOffOffsetType
-
endDate: endDate
-
frequency: 5
-
periodType: periodType
-
periodValue: periodValue
-
recurrence: recurrence
-
recurringPaymentDetailedStatus: recurringPaymentDetailedStatus
-
recurringPaymentId: recurringPaymentId
-
recurringPaymentStatus: recurringPaymentStatus
-
startDate: startDate
{
"recurrence":{
"endDate":"2000-01-23",
"startDate":"2000-01-23",
"frequency":{
"periodType":"day",
"periodValue":1
},
"dayOffOffsetType":"before"
},
"recurringPaymentId":"recurringPaymentId",
"recurringPaymentStatus":"submitted",
"recurringPaymentDetailedStatus":"recurringPaymentDetailedStatus"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Get the status of bundle of payments
NOTE: This endpoint currently only returns example data.
Authentication is Mandatory
JSON request body fields:
-
bundleId: bundleId
-
requestHeader: requestHeader
-
tppBundleId: tppBundleId
-
transactionsIncluded: transactionsIncluded
JSON response body fields:
-
bundleDetailedStatus: bundleDetailedStatus
-
bundleId: bundleId
-
bundleStatus: bundleStatus
-
detailedStatus: detailedStatus
-
executionMode: executionMode
-
generalStatus: generalStatus
-
isCallback: isCallback
-
paymentId: paymentId
-
payments: payments
-
requestId: requestId
-
responseHeader: responseHeader
-
sendDate: sendDate
-
tppBundleId: tppBundleId
-
tppTransactionId: tppTransactionId
{
"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"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Get the status of multiple payments
NOTE: This endpoint currently only returns example data.
Authentication is Mandatory
JSON request body fields:
-
accessToken: accessToken
-
ipAddress: ipAddress
-
paymentId: paymentId
-
payments: payments
-
requestHeader: requestHeader
-
requestId: requestId
-
sendDate: sendDate
-
tppId: tppId
-
tppTransactionId: tppTransactionId
-
userAgent: userAgent
JSON response body fields:
-
detailedStatus: detailedStatus
-
executionMode: executionMode
-
generalStatus: generalStatus
-
isCallback: isCallback
-
paymentId: paymentId
-
payments: payments
-
requestId: requestId
-
responseHeader: responseHeader
-
sendDate: sendDate
-
tppTransactionId: tppTransactionId
{
"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
}
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Get the status of payment
NOTE: This endpoint currently only returns example data.
Authentication is Mandatory
JSON request body fields:
-
paymentId: paymentId
-
requestHeader: requestHeader
-
tppTransactionId: tppTransactionId
JSON response body fields:
{
"jvalueToCaseclass":""
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Get the status of recurring payment
NOTE: This endpoint currently only returns example data.
Authentication is Mandatory
JSON request body fields:
-
recurringPaymentId: recurringPaymentId
-
requestHeader: requestHeader
-
tppRecurringPaymentId: tppRecurringPaymentId
JSON response body fields:
-
isCallback: isCallback
-
recurringPaymentDetailedStatus: recurringPaymentDetailedStatus
-
recurringPaymentId: recurringPaymentId
-
recurringPaymentStatus: recurringPaymentStatus
-
requestId: requestId
-
responseHeader: responseHeader
-
sendDate: sendDate
-
tppRecurringPaymentId: tppRecurringPaymentId
{
"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"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Initiate SEPA foreign transfers
NOTE: This endpoint currently only returns example data.
Authentication is Mandatory
URL Parameters:
- EEA: EEA
JSON request body fields:
-
accountNumber: accountNumber
-
deliveryMode: deliveryMode
-
executionMode: executionMode
-
hold: hold
-
nameAddress: nameAddress
-
recipient: recipient
-
requestHeader: requestHeader
-
sender: sender
-
system: system
-
tppTransactionId: tppTransactionId
-
transferData: transferData
-
value: 5987953
JSON response body fields:
-
detailedStatus: detailedStatus
-
generalStatus: generalStatus
-
isCallback: isCallback
-
paymentId: paymentId
-
requestId: requestId
-
responseHeader: responseHeader
-
sendDate: sendDate
{
"generalStatus":{
},
"detailedStatus":"detailedStatus",
"paymentId":"paymentId",
"responseHeader":{
"sendDate":"2000-01-23T04:56:07.000+00:00",
"requestId":"046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"isCallback":true
}
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Initiate domestic transfer
NOTE: This endpoint currently only returns example data.
Authentication is Mandatory
JSON request body fields:
-
deliveryMode: deliveryMode
-
executionMode: executionMode
-
hold: hold
-
nameAddress: nameAddress
-
recipient: recipient
-
requestHeader: requestHeader
-
sender: sender
-
system: system
-
tppTransactionId: tppTransactionId
-
transferData: transferData
-
value: 5987953
JSON response body fields:
-
detailedStatus: detailedStatus
-
generalStatus: generalStatus
-
isCallback: isCallback
-
paymentId: paymentId
-
requestId: requestId
-
responseHeader: responseHeader
-
sendDate: sendDate
{
"generalStatus":{
},
"detailedStatus":"detailedStatus",
"paymentId":"paymentId",
"responseHeader":{
"sendDate":"2000-01-23T04:56:07.000+00:00",
"requestId":"046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"isCallback":true
}
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Initiate many transfers as bundle
NOTE: This endpoint currently only returns example data.
Authentication is Mandatory
JSON request body fields:
-
EEATransfers: EEATransfers
-
accountNumber: accountNumber
-
bicOrSwift: bicOrSwift
-
[code](/glossary#Transaction Requests.Transaction Request Refund Reason Code): 125
-
countryCode: countryCode
-
deliveryMode: deliveryMode
-
domesticTransfers: domesticTransfers
-
executionMode: executionMode
-
formCode: formCode
-
hold: hold
-
name: ACCOUNT_MANAGEMENT_FEE
-
nameAddress: nameAddress
-
nonEEATransfers: nonEEATransfers
-
obligationId: obligationId
-
payerInfo: payerInfo
-
payorId: payorId
-
payorIdType: payorIdType
-
periodId: periodId
-
periodType: periodType
-
recipient: recipient
-
recipientBank: recipientBank
-
requestHeader: requestHeader
-
sender: sender
-
system: system
-
taxTransfers: taxTransfers
-
tppBundleId: tppBundleId
-
tppTransactionId: tppTransactionId
-
transferCharges: transferCharges
-
transferData: transferData
-
transfersTotalAmount: transfersTotalAmount
-
typeOfTransfers: typeOfTransfers
-
usInfo: usInfo
-
value: 5987953
-
year: year
JSON response body fields:
-
bundleDetailedStatus: bundleDetailedStatus
-
bundleId: bundleId
-
bundleStatus: bundleStatus
-
detailedStatus: detailedStatus
-
executionMode: executionMode
-
generalStatus: generalStatus
-
paymentId: paymentId
-
payments: payments
-
tppTransactionId: tppTransactionId
{
"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"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Initiate non SEPA foreign transfers
NOTE: This endpoint currently only returns example data.
Authentication is Mandatory
JSON request body fields:
-
accountNumber: accountNumber
-
bicOrSwift: bicOrSwift
-
[code](/glossary#Transaction Requests.Transaction Request Refund Reason Code): 125
-
countryCode: countryCode
-
deliveryMode: deliveryMode
-
executionMode: executionMode
-
hold: hold
-
name: ACCOUNT_MANAGEMENT_FEE
-
nameAddress: nameAddress
-
recipient: recipient
-
recipientBank: recipientBank
-
requestHeader: requestHeader
-
sender: sender
-
system: system
-
tppTransactionId: tppTransactionId
-
transferCharges: transferCharges
-
transferData: transferData
-
value: 5987953
JSON response body fields:
-
detailedStatus: detailedStatus
-
generalStatus: generalStatus
-
isCallback: isCallback
-
paymentId: paymentId
-
requestId: requestId
-
responseHeader: responseHeader
-
sendDate: sendDate
{
"generalStatus":{
},
"detailedStatus":"detailedStatus",
"paymentId":"paymentId",
"responseHeader":{
"sendDate":"2000-01-23T04:56:07.000+00:00",
"requestId":"046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"isCallback":true
}
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Initiate tax transfer
NOTE: This endpoint currently only returns example data.
Authentication is Mandatory
JSON request body fields:
-
deliveryMode: deliveryMode
-
executionMode: executionMode
-
formCode: formCode
-
hold: hold
-
nameAddress: nameAddress
-
obligationId: obligationId
-
payerInfo: payerInfo
-
payorId: payorId
-
payorIdType: payorIdType
-
periodId: periodId
-
periodType: periodType
-
recipient: recipient
-
requestHeader: requestHeader
-
sender: sender
-
system: system
-
tppTransactionId: tppTransactionId
-
transferData: transferData
-
usInfo: usInfo
-
value: 5987953
-
year: year
JSON response body fields:
-
detailedStatus: detailedStatus
-
generalStatus: generalStatus
-
isCallback: isCallback
-
paymentId: paymentId
-
requestId: requestId
-
responseHeader: responseHeader
-
sendDate: sendDate
{
"generalStatus":{
},
"detailedStatus":"detailedStatus",
"paymentId":"paymentId",
"responseHeader":{
"sendDate":"2000-01-23T04:56:07.000+00:00",
"requestId":"046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"isCallback":true
}
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.