-
Core
- obp.getAdapterInfo
- obp.validateAndCheckIbanNumber
- obp.getChallengeThreshold
- obp.getChargeLevel
- obp.getChargeLevelC2
- obp.createChallenge
- obp.createChallenges
- obp.createChallengesC2
- obp.createChallengesC3
- obp.validateChallengeAnswer
- obp.validateChallengeAnswerC2
- obp.validateChallengeAnswerC3
- obp.getChallengesByTransactionRequestId
- obp.getChallengesByConsentId
- obp.getChallenge
- obp.getBank
- obp.getBanks
- obp.getBankAccountsForUser
- obp.getUser
- obp.checkExternalUserCredentials
- obp.checkExternalUserExists
- obp.getBankAccountOld
- obp.getBankAccountByIban
- obp.getBankAccountByRouting
- obp.getBankAccounts
- obp.getBankAccountsBalances
- obp.getCoreBankAccounts
- obp.getBankAccountsHeld
- obp.checkBankAccountExists
- obp.getCounterpartyTrait
- obp.getCounterpartyByCounterpartyId
- obp.getCounterpartyByIban
- obp.getCounterpartyByIbanAndBankAccountId
- obp.getCounterparties
- obp.getTransactions
- obp.getTransactionsCore
- obp.getTransaction
- obp.getPhysicalCardsForUser
- obp.getPhysicalCardForBank
- obp.deletePhysicalCardForBank
- obp.getPhysicalCardsForBank
- obp.createPhysicalCard
- obp.updatePhysicalCard
- obp.makePaymentv210
- obp.createTransactionRequestv210
- obp.createTransactionRequestv400
- obp.getTransactionRequests210
- obp.getTransactionRequestImpl
- obp.createTransactionAfterChallengeV210
- obp.updateBankAccount
- obp.createBankAccount
- obp.accountExists
- obp.getProducts
- obp.getProduct
- obp.getBranch
- obp.getBranches
- obp.getAtm
- obp.getAtms
- obp.getCurrentFxRate
- obp.createTransactionAfterChallengev300
- obp.makePaymentv300
- obp.createTransactionRequestv300
- obp.makePaymentV400
- obp.cancelPaymentV400
- obp.createCounterparty
- obp.checkCustomerNumberAvailable
- obp.createCustomer
- obp.updateCustomerScaData
- obp.updateCustomerCreditData
- obp.updateCustomerGeneralData
- obp.getCustomersByUserId
- obp.getCustomerByCustomerId
- obp.getCustomerByCustomerNumber
- obp.getCustomerAddress
- obp.createCustomerAddress
- obp.updateCustomerAddress
- obp.deleteCustomerAddress
- obp.createTaxResidence
- obp.getTaxResidence
- obp.deleteTaxResidence
- obp.getCustomers
- obp.getCustomersByCustomerPhoneNumber
- obp.getCheckbookOrders
- obp.getStatusOfCreditCardOrder
- obp.createUserAuthContext
- obp.createUserAuthContextUpdate
- obp.deleteUserAuthContexts
- obp.deleteUserAuthContextById
- obp.getUserAuthContexts
- obp.createOrUpdateProductAttribute
- obp.getProductAttributeById
- obp.getProductAttributesByBankAndCode
- obp.deleteProductAttribute
- obp.getAccountAttributeById
- obp.getTransactionAttributeById
- obp.createOrUpdateAccountAttribute
- obp.createOrUpdateCustomerAttribute
- obp.createOrUpdateTransactionAttribute
- obp.createAccountAttributes
- obp.getAccountAttributesByAccount
- obp.getCustomerAttributes
- obp.getCustomerIdsByAttributeNameValues
- obp.getCustomerAttributesForCustomers
- obp.getTransactionIdsByAttributeNameValues
- obp.getTransactionAttributes
- obp.getCustomerAttributeById
- obp.createOrUpdateCardAttribute
- obp.getCardAttributeById
- obp.getCardAttributesFromProvider
- obp.createAccountApplication
- obp.getAllAccountApplication
- obp.getAccountApplicationById
- obp.updateAccountApplicationStatus
- obp.getOrCreateProductCollection
- obp.getProductCollection
- obp.getOrCreateProductCollectionItem
- obp.getProductCollectionItem
- obp.getProductCollectionItemsTree
- obp.createMeeting
- obp.getMeetings
- obp.getMeeting
- obp.createOrUpdateKycCheck
- obp.createOrUpdateKycDocument
- obp.createOrUpdateKycMedia
- obp.createOrUpdateKycStatus
- obp.getKycChecks
- obp.getKycDocuments
- obp.getKycMedias
- obp.getKycStatuses
- obp.createMessage
- obp.makeHistoricalPayment
- obp.createDirectDebit
- obp.deleteCustomerAttribute
- obp.dynamicEntityProcess
- API Explorer
- Glossary Message Docs for:
- Kafka
- Akka
- Rest
- Stored Procedure Introduction to:
- Kafka
- Akka
- Stored Procedure
Message Docs for Connector: rest_vMar2019
obp.getAdapterInfo
Get Adapter InfoKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } } }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "errorCode":"error code", "backendMessages":[{ "source":"", "status":"Status string", "errorCode":"errorCode string", "text":"text string", "duration":"5.123" }], "name":"NAME", "version":"version string", "git_commit":"git_commit", "date":"date String" } }Required
Fields{ }Dependent
Endpoints
obp.validateAndCheckIbanNumber
Validate And Check Iban NumberKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "iban":"DE91 1000 0000 0123 4567 89" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "isValid":true, "details":{ "bic":"BUKBGB22", "bank":"", "branch":"string", "address":"", "city":"", "zip":"string", "phone":"", "country":"Germany", "countryIso":"string", "sepaCreditTransfer":"yes", "sepaDirectDebit":"yes", "sepaSddCore":"yes", "sepaB2b":"yes", "sepaCardClearing":"no" } } }Required
Fields{ }Dependent
Endpoints
obp.getChallengeThreshold
Get Challenge ThresholdKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "bankId":"gh.29.uk", "accountId":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "viewId":"owner", "transactionRequestType":"SEPA", "currency":"EUR", "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "currency":"EUR", "amount":"10.12" } }Required
Fields{ }Dependent
Endpoints
obp.getChargeLevel
Get Charge LevelKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "bankId":{ "value":"gh.29.uk" }, "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "viewId":{ "value":"owner" }, "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "transactionRequestType":"SEPA", "currency":"EUR" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "currency":"EUR", "amount":"10.12" } }Required
Fields{ }Dependent
Endpoints
obp.getChargeLevelC2
Get Charge Level C2Kafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "bankId":{ "value":"gh.29.uk" }, "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "viewId":{ "value":"owner" }, "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "transactionRequestType":"SEPA", "currency":"EUR", "amount":"10.12", "toAccountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customAttributes":[{ "name":"ACCOUNT_MANAGEMENT_FEE", "attributeType":"STRING", "value":"5987953" }] }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "currency":"EUR", "amount":"10.12" } }Required
Fields{ }Dependent
Endpoints
obp.createChallenge
Create ChallengeKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "bankId":{ "value":"gh.29.uk" }, "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "transactionRequestType":{ "value":"SEPA" }, "transactionRequestId":"8138a7e4-6d02-40e3-a129-0b2bf89de9f1", "scaMethod":"SMS" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":"string" }Required
Fields{ }Dependent
Endpoints
obp.createChallenges
Create ChallengesKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "bankId":{ "value":"gh.29.uk" }, "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "userIds":[""], "transactionRequestType":{ "value":"SEPA" }, "transactionRequestId":"8138a7e4-6d02-40e3-a129-0b2bf89de9f1", "scaMethod":"SMS" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":[""] }Required
Fields{ }Dependent
Endpoints
obp.createChallengesC2
Create Challenges C2Kafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "userIds":[""], "challengeType":"OBP_TRANSACTION_REQUEST_CHALLENGE", "transactionRequestId":"8138a7e4-6d02-40e3-a129-0b2bf89de9f1", "scaMethod":"SMS", "scaStatus":"received", "consentId":"", "authenticationMethodId":"string" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":[{ "challengeId":"123chaneid13-6d02-40e3-a129-0b2bf89de9f0", "transactionRequestId":"8138a7e4-6d02-40e3-a129-0b2bf89de9f1", "expectedAnswer":"string", "expectedUserId":"string", "salt":"string", "successful":true, "challengeType":"", "consentId":"", "basketId":"", "scaMethod":"SMS", "scaStatus":"received", "authenticationMethodId":"string", "attemptCounter":123 }] }Required
Fields{ }Dependent
Endpoints
obp.createChallengesC3
Create Challenges C3Kafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "userIds":[""], "challengeType":"OBP_TRANSACTION_REQUEST_CHALLENGE", "transactionRequestId":"8138a7e4-6d02-40e3-a129-0b2bf89de9f1", "scaMethod":"SMS", "scaStatus":"received", "consentId":"", "basketId":"", "authenticationMethodId":"string" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":[{ "challengeId":"123chaneid13-6d02-40e3-a129-0b2bf89de9f0", "transactionRequestId":"8138a7e4-6d02-40e3-a129-0b2bf89de9f1", "expectedAnswer":"string", "expectedUserId":"string", "salt":"string", "successful":true, "challengeType":"", "consentId":"", "basketId":"", "scaMethod":"SMS", "scaStatus":"received", "authenticationMethodId":"string", "attemptCounter":123 }] }Required
Fields{ }Dependent
Endpoints
obp.validateChallengeAnswer
Validate Challenge AnswerKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "challengeId":"123chaneid13-6d02-40e3-a129-0b2bf89de9f0", "hashOfSuppliedAnswer":"a665a45920422f9d417e4867efdc4fb8a04a1f3fff1fa07e998e86f7f7a27ae3" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":true }Required
Fields{ }Dependent
Endpoints
obp.validateChallengeAnswerC2
Validate Challenge Answer C2Kafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "transactionRequestId":"8138a7e4-6d02-40e3-a129-0b2bf89de9f1", "consentId":"", "challengeId":"123chaneid13-6d02-40e3-a129-0b2bf89de9f0", "hashOfSuppliedAnswer":"a665a45920422f9d417e4867efdc4fb8a04a1f3fff1fa07e998e86f7f7a27ae3" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "challengeId":"123chaneid13-6d02-40e3-a129-0b2bf89de9f0", "transactionRequestId":"8138a7e4-6d02-40e3-a129-0b2bf89de9f1", "expectedAnswer":"string", "expectedUserId":"string", "salt":"string", "successful":true, "challengeType":"", "consentId":"", "basketId":"", "scaMethod":"SMS", "scaStatus":"received", "authenticationMethodId":"string", "attemptCounter":123 } }Required
Fields{ }Dependent
Endpoints
obp.validateChallengeAnswerC3
Validate Challenge Answer C3Kafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "transactionRequestId":"8138a7e4-6d02-40e3-a129-0b2bf89de9f1", "consentId":"", "basketId":"", "challengeId":"123chaneid13-6d02-40e3-a129-0b2bf89de9f0", "hashOfSuppliedAnswer":"a665a45920422f9d417e4867efdc4fb8a04a1f3fff1fa07e998e86f7f7a27ae3" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "challengeId":"123chaneid13-6d02-40e3-a129-0b2bf89de9f0", "transactionRequestId":"8138a7e4-6d02-40e3-a129-0b2bf89de9f1", "expectedAnswer":"string", "expectedUserId":"string", "salt":"string", "successful":true, "challengeType":"", "consentId":"", "basketId":"", "scaMethod":"SMS", "scaStatus":"received", "authenticationMethodId":"string", "attemptCounter":123 } }Required
Fields{ }Dependent
Endpoints
obp.getChallengesByTransactionRequestId
Get Challenges By Transaction Request IdKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "transactionRequestId":"8138a7e4-6d02-40e3-a129-0b2bf89de9f1" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":[{ "challengeId":"123chaneid13-6d02-40e3-a129-0b2bf89de9f0", "transactionRequestId":"8138a7e4-6d02-40e3-a129-0b2bf89de9f1", "expectedAnswer":"string", "expectedUserId":"string", "salt":"string", "successful":true, "challengeType":"", "consentId":"", "basketId":"", "scaMethod":"SMS", "scaStatus":"received", "authenticationMethodId":"string", "attemptCounter":123 }] }Required
Fields{ }Dependent
Endpoints
obp.getChallengesByConsentId
Get Challenges By Consent IdKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "consentId":"" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":[{ "challengeId":"123chaneid13-6d02-40e3-a129-0b2bf89de9f0", "transactionRequestId":"8138a7e4-6d02-40e3-a129-0b2bf89de9f1", "expectedAnswer":"string", "expectedUserId":"string", "salt":"string", "successful":true, "challengeType":"", "consentId":"", "basketId":"", "scaMethod":"SMS", "scaStatus":"received", "authenticationMethodId":"string", "attemptCounter":123 }] }Required
Fields{ }Dependent
Endpoints
obp.getChallenge
Get ChallengeKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "challengeId":"123chaneid13-6d02-40e3-a129-0b2bf89de9f0" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "challengeId":"123chaneid13-6d02-40e3-a129-0b2bf89de9f0", "transactionRequestId":"8138a7e4-6d02-40e3-a129-0b2bf89de9f1", "expectedAnswer":"string", "expectedUserId":"string", "salt":"string", "successful":true, "challengeType":"", "consentId":"", "basketId":"", "scaMethod":"SMS", "scaStatus":"received", "authenticationMethodId":"string", "attemptCounter":123 } }Required
Fields{ }Dependent
Endpoints
obp.getBank
Get BankKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "bankId":{ "value":"gh.29.uk" } }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "bankId":{ "value":"gh.29.uk" }, "shortName":"bank shortName string", "fullName":"bank fullName string", "logoUrl":"bank logoUrl string", "websiteUrl":"bank websiteUrl string", "bankRoutingScheme":"BIC", "bankRoutingAddress":"GENODEM1GLS" } }Required
Fields{ "data.bankId":["allVersion"] }Dependent
Endpoints
obp.getBanks
Get BanksKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } } }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":[{ "bankId":{ "value":"gh.29.uk" }, "shortName":"bank shortName string", "fullName":"bank fullName string", "logoUrl":"bank logoUrl string", "websiteUrl":"bank websiteUrl string", "bankRoutingScheme":"BIC", "bankRoutingAddress":"GENODEM1GLS" }] }Required
Fields{ "data.bankId":["allVersion"] }Dependent
Endpoints
obp.getBankAccountsForUser
Get Bank Accounts For UserKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "provider":"ETHEREUM", "username":"felixsmith" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":[{ "bankId":"gh.29.uk", "accountId":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "viewsToGenerate":["Owner","Accountant","Auditor"] }] }Required
Fields{ }Dependent
Endpoints
obp.getUser
Get UserKafka/AkkaOutboundInboundTopicMessage{ "name":"felixsmith", "password":"password" }{ "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "email":"felixsmith@example.com", "password":"password", "displayName":"" } }Required
Fields{ }Dependent
Endpoints
obp.checkExternalUserCredentials
Check External User CredentialsKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "username":"felixsmith", "password":"password" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "aud":"String", "exp":"String", "iat":"String", "iss":"String", "sub":"felixsmith", "azp":"string", "email":"felixsmith@example.com", "emailVerified":"String", "name":"felixsmith", "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }] } }Required
Fields{ }Dependent
Endpoints
obp.checkExternalUserExists
Check External User ExistsKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "username":"felixsmith" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "aud":"String", "exp":"String", "iat":"String", "iss":"String", "sub":"felixsmith", "azp":"string", "email":"felixsmith@example.com", "emailVerified":"String", "name":"felixsmith", "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }] } }Required
Fields{ }Dependent
Endpoints
obp.getBankAccountOld
Get Bank Account OldKafka/AkkaOutboundInboundTopicMessage{ "bankId":{ "value":"gh.29.uk" }, "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" } }{ "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "accountType":"AC", "balance":"10", "currency":"EUR", "name":"bankAccount name string", "number":"bankAccount number string", "bankId":{ "value":"gh.29.uk" }, "lastUpdate":"2018-03-09T00:00:00Z", "branchId":"DERBY6", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "attributes":[{ "name":"STATUS", "type":"STRING", "value":"closed" }] } }Required
Fields{ }Dependent
Endpoints
obp.getBankAccountByIban
Get Bank Account By IbanKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "iban":"DE91 1000 0000 0123 4567 89" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "accountType":"AC", "balance":"10", "currency":"EUR", "name":"bankAccount name string", "number":"bankAccount number string", "bankId":{ "value":"gh.29.uk" }, "lastUpdate":"2018-03-09T00:00:00Z", "branchId":"DERBY6", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "attributes":[{ "name":"STATUS", "type":"STRING", "value":"closed" }] } }Required
Fields{ }Dependent
Endpoints
obp.getBankAccountByRouting
Get Bank Account By RoutingKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "bankId":{ "value":"gh.29.uk" }, "scheme":"scheme value", "address":"" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "accountType":"AC", "balance":"10", "currency":"EUR", "name":"bankAccount name string", "number":"bankAccount number string", "bankId":{ "value":"gh.29.uk" }, "lastUpdate":"2018-03-09T00:00:00Z", "branchId":"DERBY6", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "attributes":[{ "name":"STATUS", "type":"STRING", "value":"closed" }] } }Required
Fields{ }Dependent
Endpoints
obp.getBankAccounts
Get Bank AccountsKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "bankIdAccountIds":[{ "bankId":{ "value":"gh.29.uk" }, "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" } }] }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":[{ "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "accountType":"AC", "balance":"10", "currency":"EUR", "name":"bankAccount name string", "number":"bankAccount number string", "bankId":{ "value":"gh.29.uk" }, "lastUpdate":"2018-03-09T00:00:00Z", "branchId":"DERBY6", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "attributes":[{ "name":"STATUS", "type":"STRING", "value":"closed" }] }] }Required
Fields{ }Dependent
Endpoints
obp.getBankAccountsBalances
Get Bank Accounts BalancesKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "bankIdAccountIds":[{ "bankId":{ "value":"gh.29.uk" }, "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" } }] }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "accounts":[{ "id":"d8839721-ad8f-45dd-9f78-2080414b93f9", "label":"My Account", "bankId":"gh.29.uk", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "balance":{ "currency":"EUR", "amount":"50.89" } }], "overallBalance":{ "currency":"EUR", "amount":"10.12" }, "overallBalanceDate":"2020-01-27T00:00:00Z" } }Required
Fields{ }Dependent
Endpoints
obp.getCoreBankAccounts
Get Core Bank AccountsKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "bankIdAccountIds":[{ "bankId":{ "value":"gh.29.uk" }, "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" } }] }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":[{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "label":"My Account", "bankId":"gh.29.uk", "accountType":"AC", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }] }] }Required
Fields{ }Dependent
Endpoints
obp.getBankAccountsHeld
Get Bank Accounts HeldKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "bankIdAccountIds":[{ "bankId":{ "value":"gh.29.uk" }, "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" } }] }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":[{ "id":"d8839721-ad8f-45dd-9f78-2080414b93f9", "label":"My Account", "bankId":"gh.29.uk", "number":"", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }] }] }Required
Fields{ }Dependent
Endpoints
obp.checkBankAccountExists
Check Bank Account ExistsKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "bankId":{ "value":"gh.29.uk" }, "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" } }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "accountType":"AC", "balance":"10", "currency":"EUR", "name":"bankAccount name string", "number":"bankAccount number string", "bankId":{ "value":"gh.29.uk" }, "lastUpdate":"2018-03-09T00:00:00Z", "branchId":"DERBY6", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "attributes":[{ "name":"STATUS", "type":"STRING", "value":"closed" }] } }Required
Fields{ }Dependent
Endpoints
obp.getCounterpartyTrait
Get Counterparty TraitKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "bankId":{ "value":"gh.29.uk" }, "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "couterpartyId":"string" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "createdByUserId":"", "name":"ACCOUNT_MANAGEMENT_FEE", "description":"This an optional field. Maximum length is 2000. It can be any characters here.", "currency":"EUR", "thisBankId":"", "thisAccountId":"", "thisViewId":"", "counterpartyId":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh", "otherAccountRoutingScheme":"", "otherAccountRoutingAddress":"", "otherAccountSecondaryRoutingScheme":"", "otherAccountSecondaryRoutingAddress":"", "otherBankRoutingScheme":"", "otherBankRoutingAddress":"", "otherBranchRoutingScheme":"", "otherBranchRoutingAddress":"", "isBeneficiary":false, "bespoke":[{ "key":"CustomerNumber", "value":"5987953" }] } }Required
Fields{ }Dependent
Endpoints
obp.getCounterpartyByCounterpartyId
Get Counterparty By Counterparty IdKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "counterpartyId":{ "value":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh" } }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "createdByUserId":"", "name":"ACCOUNT_MANAGEMENT_FEE", "description":"This an optional field. Maximum length is 2000. It can be any characters here.", "currency":"EUR", "thisBankId":"", "thisAccountId":"", "thisViewId":"", "counterpartyId":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh", "otherAccountRoutingScheme":"", "otherAccountRoutingAddress":"", "otherAccountSecondaryRoutingScheme":"", "otherAccountSecondaryRoutingAddress":"", "otherBankRoutingScheme":"", "otherBankRoutingAddress":"", "otherBranchRoutingScheme":"", "otherBranchRoutingAddress":"", "isBeneficiary":false, "bespoke":[{ "key":"CustomerNumber", "value":"5987953" }] } }Required
Fields{ }Dependent
Endpoints
obp.getCounterpartyByIban
Get Counterparty By IbanKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "iban":"DE91 1000 0000 0123 4567 89" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "createdByUserId":"", "name":"ACCOUNT_MANAGEMENT_FEE", "description":"This an optional field. Maximum length is 2000. It can be any characters here.", "currency":"EUR", "thisBankId":"", "thisAccountId":"", "thisViewId":"", "counterpartyId":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh", "otherAccountRoutingScheme":"", "otherAccountRoutingAddress":"", "otherAccountSecondaryRoutingScheme":"", "otherAccountSecondaryRoutingAddress":"", "otherBankRoutingScheme":"", "otherBankRoutingAddress":"", "otherBranchRoutingScheme":"", "otherBranchRoutingAddress":"", "isBeneficiary":false, "bespoke":[{ "key":"CustomerNumber", "value":"5987953" }] } }Required
Fields{ }Dependent
Endpoints
obp.getCounterpartyByIbanAndBankAccountId
Get Counterparty By Iban And Bank Account IdKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "iban":"DE91 1000 0000 0123 4567 89", "bankId":{ "value":"gh.29.uk" }, "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" } }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "createdByUserId":"", "name":"ACCOUNT_MANAGEMENT_FEE", "description":"This an optional field. Maximum length is 2000. It can be any characters here.", "currency":"EUR", "thisBankId":"", "thisAccountId":"", "thisViewId":"", "counterpartyId":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh", "otherAccountRoutingScheme":"", "otherAccountRoutingAddress":"", "otherAccountSecondaryRoutingScheme":"", "otherAccountSecondaryRoutingAddress":"", "otherBankRoutingScheme":"", "otherBankRoutingAddress":"", "otherBranchRoutingScheme":"", "otherBranchRoutingAddress":"", "isBeneficiary":false, "bespoke":[{ "key":"CustomerNumber", "value":"5987953" }] } }Required
Fields{ }Dependent
Endpoints
obp.getCounterparties
Get CounterpartiesKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "thisBankId":{ "value":"" }, "thisAccountId":{ "value":"" }, "viewId":{ "value":"owner" } }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":[{ "createdByUserId":"", "name":"ACCOUNT_MANAGEMENT_FEE", "description":"This an optional field. Maximum length is 2000. It can be any characters here.", "currency":"EUR", "thisBankId":"", "thisAccountId":"", "thisViewId":"", "counterpartyId":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh", "otherAccountRoutingScheme":"", "otherAccountRoutingAddress":"", "otherAccountSecondaryRoutingScheme":"", "otherAccountSecondaryRoutingAddress":"", "otherBankRoutingScheme":"", "otherBankRoutingAddress":"", "otherBranchRoutingScheme":"", "otherBranchRoutingAddress":"", "isBeneficiary":false, "bespoke":[{ "key":"CustomerNumber", "value":"5987953" }] }] }Required
Fields{ }Dependent
Endpoints
obp.getTransactions
Get TransactionsKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "bankId":{ "value":"gh.29.uk" }, "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "limit":100, "offset":100, "fromDate":"2018-03-09", "toDate":"2018-03-09" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":[{ "id":{ "value":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub" }, "thisAccount":{ "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "accountType":"AC", "balance":"10", "currency":"EUR", "name":"bankAccount name string", "label":"My Account", "number":"bankAccount number string", "bankId":{ "value":"gh.29.uk" }, "lastUpdate":"2018-03-09T00:00:00Z", "branchId":"DERBY6", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "accountRules":[{ "scheme":"AccountRule scheme string", "value":"AccountRule value string" }], "accountHolder":"bankAccount accountHolder string", "attributes":[{ "name":"STATUS", "type":"STRING", "value":"closed" }] }, "otherAccount":{ "kind":"Counterparty kind string", "counterpartyId":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh", "counterpartyName":"John Smith Ltd.", "thisBankId":{ "value":"" }, "thisAccountId":{ "value":"" }, "isBeneficiary":false }, "transactionType":"DEBIT", "amount":"19.64", "currency":"EUR", "description":"The piano lession-Invoice No:68", "startDate":"2019-09-07T00:00:00Z", "finishDate":"2019-09-08T00:00:00Z", "balance":"10" }] }Required
Fields{ }Dependent
Endpoints
obp.getTransactionsCore
Get Transactions CoreKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "bankId":{ "value":"gh.29.uk" }, "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "limit":100, "offset":100, "fromDate":"", "toDate":"" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":[{ "id":{ "value":"d8839721-ad8f-45dd-9f78-2080414b93f9" }, "thisAccount":{ "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "accountType":"AC", "balance":"10", "currency":"EUR", "name":"bankAccount name string", "label":"My Account", "number":"bankAccount number string", "bankId":{ "value":"gh.29.uk" }, "lastUpdate":"2018-03-09T00:00:00Z", "branchId":"DERBY6", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "accountRules":[{ "scheme":"AccountRule scheme string", "value":"AccountRule value string" }], "accountHolder":"bankAccount accountHolder string", "attributes":[{ "name":"STATUS", "type":"STRING", "value":"closed" }] }, "otherAccount":{ "kind":"", "counterpartyId":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh", "counterpartyName":"John Smith Ltd.", "thisBankId":{ "value":"" }, "thisAccountId":{ "value":"" }, "otherBankRoutingScheme":"", "otherBankRoutingAddress":"", "otherAccountRoutingScheme":"", "otherAccountRoutingAddress":"", "otherAccountProvider":"", "isBeneficiary":false }, "transactionType":"DEBIT", "amount":"10.12", "currency":"EUR", "description":"This an optional field. Maximum length is 2000. It can be any characters here.", "startDate":"2020-01-27T00:00:00Z", "finishDate":"2020-01-27T00:00:00Z", "balance":"10" }] }Required
Fields{ }Dependent
Endpoints
obp.getTransaction
Get TransactionKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "bankId":{ "value":"gh.29.uk" }, "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "transactionId":{ "value":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub" } }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "id":{ "value":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub" }, "thisAccount":{ "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "accountType":"AC", "balance":"10", "currency":"EUR", "name":"bankAccount name string", "label":"My Account", "number":"bankAccount number string", "bankId":{ "value":"gh.29.uk" }, "lastUpdate":"2018-03-09T00:00:00Z", "branchId":"DERBY6", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "accountRules":[{ "scheme":"AccountRule scheme string", "value":"AccountRule value string" }], "accountHolder":"bankAccount accountHolder string", "attributes":[{ "name":"STATUS", "type":"STRING", "value":"closed" }] }, "otherAccount":{ "kind":"Counterparty kind string", "counterpartyId":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh", "counterpartyName":"John Smith Ltd.", "thisBankId":{ "value":"" }, "thisAccountId":{ "value":"" }, "isBeneficiary":false }, "transactionType":"DEBIT", "amount":"19.64", "currency":"EUR", "description":"The piano lession-Invoice No:68", "startDate":"2019-09-07T00:00:00Z", "finishDate":"2019-09-08T00:00:00Z", "balance":"10" } }Required
Fields{ }Dependent
Endpoints
obp.getPhysicalCardsForUser
Get Physical Cards For UserKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "user":{ "userPrimaryKey":{ "value":123 }, "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "idGivenByProvider":"string", "provider":"ETHEREUM", "emailAddress":"", "name":"felixsmith", "createdByConsentId":"string", "createdByUserInvitationId":"string", "isDeleted":true, "lastMarketingAgreementSignedDate":"2020-01-27T00:00:00Z" } }{ "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":[{ "cardId":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ", "bankId":"gh.29.uk", "bankCardNumber":"364435172576215", "cardType":"Credit", "nameOnCard":"SusanSmith", "issueNumber":"1", "serialNumber":"1324234", "validFrom":"2020-01-27T00:00:00Z", "expires":"2021-01-27T00:00:00Z", "enabled":false, "cancelled":false, "onHotList":false, "technology":"technology1", "networks":[""], "allows":["DEBIT"], "account":{ "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "accountType":"AC", "balance":"10", "currency":"EUR", "name":"bankAccount name string", "label":"My Account", "number":"546387432", "bankId":{ "value":"gh.29.uk" }, "lastUpdate":"2018-03-09T00:00:00Z", "branchId":"DERBY6", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "accountRules":[{ "scheme":"AccountRule scheme string", "value":"AccountRule value string" }], "accountHolder":"bankAccount accountHolder string", "attributes":[{ "name":"STATUS", "type":"STRING", "value":"closed" }] }, "replacement":{ "requestedDate":"2020-01-27T00:00:00Z", "reasonRequested":"FIRST" }, "pinResets":[{ "requestedDate":"2020-01-27T00:00:00Z", "reasonRequested":"FORGOT" }], "collected":{ "date":"2020-01-27T00:00:00Z" }, "posted":{ "date":"2020-01-27T00:00:00Z" }, "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "cvv":"123", "brand":"Visa" }] }Required
Fields{ }Dependent
Endpoints
obp.getPhysicalCardForBank
Get Physical Card For BankKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "bankId":{ "value":"gh.29.uk" }, "cardId":"36f8a9e6-c2b1-407a-8bd0-421b7119307e " }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "cardId":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ", "bankId":"gh.29.uk", "bankCardNumber":"364435172576215", "cardType":"Credit", "nameOnCard":"SusanSmith", "issueNumber":"1", "serialNumber":"1324234", "validFrom":"2020-01-27T00:00:00Z", "expires":"2021-01-27T00:00:00Z", "enabled":false, "cancelled":false, "onHotList":false, "technology":"technology1", "networks":[""], "allows":["DEBIT"], "account":{ "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "accountType":"AC", "balance":"10", "currency":"EUR", "name":"bankAccount name string", "label":"My Account", "number":"546387432", "bankId":{ "value":"gh.29.uk" }, "lastUpdate":"2018-03-09T00:00:00Z", "branchId":"DERBY6", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "accountRules":[{ "scheme":"AccountRule scheme string", "value":"AccountRule value string" }], "accountHolder":"bankAccount accountHolder string", "attributes":[{ "name":"STATUS", "type":"STRING", "value":"closed" }] }, "replacement":{ "requestedDate":"2020-01-27T00:00:00Z", "reasonRequested":"FIRST" }, "pinResets":[{ "requestedDate":"2020-01-27T00:00:00Z", "reasonRequested":"FORGOT" }], "collected":{ "date":"2020-01-27T00:00:00Z" }, "posted":{ "date":"2020-01-27T00:00:00Z" }, "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "cvv":"123", "brand":"Visa" } }Required
Fields{ }Dependent
Endpoints
obp.deletePhysicalCardForBank
Delete Physical Card For BankKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "bankId":{ "value":"gh.29.uk" }, "cardId":"36f8a9e6-c2b1-407a-8bd0-421b7119307e " }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":true }Required
Fields{ }Dependent
Endpoints
obp.getPhysicalCardsForBank
Get Physical Cards For BankKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "bank":{ "bankId":{ "value":"gh.29.uk" }, "shortName":"bank shortName string", "fullName":"bank fullName string", "logoUrl":"bank logoUrl string", "websiteUrl":"bank websiteUrl string", "bankRoutingScheme":"BIC", "bankRoutingAddress":"GENODEM1GLS", "swiftBic":"bank swiftBic string", "nationalIdentifier":"bank nationalIdentifier string" }, "user":{ "userPrimaryKey":{ "value":123 }, "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "idGivenByProvider":"string", "provider":"ETHEREUM", "emailAddress":"", "name":"felixsmith", "createdByConsentId":"string", "createdByUserInvitationId":"string", "isDeleted":true, "lastMarketingAgreementSignedDate":"2020-01-27T00:00:00Z" }, "limit":100, "offset":100, "fromDate":"", "toDate":"" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":[{ "cardId":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ", "bankId":"gh.29.uk", "bankCardNumber":"364435172576215", "cardType":"Credit", "nameOnCard":"SusanSmith", "issueNumber":"1", "serialNumber":"1324234", "validFrom":"2020-01-27T00:00:00Z", "expires":"2021-01-27T00:00:00Z", "enabled":false, "cancelled":false, "onHotList":false, "technology":"technology1", "networks":[""], "allows":["DEBIT"], "account":{ "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "accountType":"AC", "balance":"10", "currency":"EUR", "name":"bankAccount name string", "label":"My Account", "number":"546387432", "bankId":{ "value":"gh.29.uk" }, "lastUpdate":"2018-03-09T00:00:00Z", "branchId":"DERBY6", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "accountRules":[{ "scheme":"AccountRule scheme string", "value":"AccountRule value string" }], "accountHolder":"bankAccount accountHolder string", "attributes":[{ "name":"STATUS", "type":"STRING", "value":"closed" }] }, "replacement":{ "requestedDate":"2020-01-27T00:00:00Z", "reasonRequested":"FIRST" }, "pinResets":[{ "requestedDate":"2020-01-27T00:00:00Z", "reasonRequested":"FORGOT" }], "collected":{ "date":"2020-01-27T00:00:00Z" }, "posted":{ "date":"2020-01-27T00:00:00Z" }, "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "cvv":"123", "brand":"Visa" }] }Required
Fields{ }Dependent
Endpoints
obp.createPhysicalCard
Create Physical CardKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "bankCardNumber":"364435172576215", "nameOnCard":"SusanSmith", "cardType":"Credit", "issueNumber":"1", "serialNumber":"1324234", "validFrom":"2020-01-27T00:00:00Z", "expires":"2021-01-27T00:00:00Z", "enabled":false, "cancelled":false, "onHotList":false, "technology":"technology1", "networks":[""], "allows":["[credit","debit","cash_withdrawal]"], "accountId":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "bankId":"gh.29.uk", "replacement":{ "requestedDate":"2020-01-27T00:00:00Z", "reasonRequested":"FIRST" }, "pinResets":[{ "requestedDate":"2020-01-27T00:00:00Z", "reasonRequested":"FORGOT" }], "collected":{ "date":"2020-01-27T00:00:00Z" }, "posted":{ "date":"2020-01-27T00:00:00Z" }, "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "cvv":"123", "brand":"Visa" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "cardId":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ", "bankId":"gh.29.uk", "bankCardNumber":"364435172576215", "cardType":"Credit", "nameOnCard":"SusanSmith", "issueNumber":"1", "serialNumber":"1324234", "validFrom":"2020-01-27T00:00:00Z", "expires":"2021-01-27T00:00:00Z", "enabled":false, "cancelled":false, "onHotList":false, "technology":"technology1", "networks":[""], "allows":["DEBIT"], "account":{ "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "accountType":"AC", "balance":"10", "currency":"EUR", "name":"bankAccount name string", "label":"My Account", "number":"546387432", "bankId":{ "value":"gh.29.uk" }, "lastUpdate":"2018-03-09T00:00:00Z", "branchId":"DERBY6", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "accountRules":[{ "scheme":"AccountRule scheme string", "value":"AccountRule value string" }], "accountHolder":"bankAccount accountHolder string", "attributes":[{ "name":"STATUS", "type":"STRING", "value":"closed" }] }, "replacement":{ "requestedDate":"2020-01-27T00:00:00Z", "reasonRequested":"FIRST" }, "pinResets":[{ "requestedDate":"2020-01-27T00:00:00Z", "reasonRequested":"FORGOT" }], "collected":{ "date":"2020-01-27T00:00:00Z" }, "posted":{ "date":"2020-01-27T00:00:00Z" }, "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "cvv":"123", "brand":"Visa" } }Required
Fields{ }Dependent
Endpoints
obp.updatePhysicalCard
Update Physical CardKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "cardId":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ", "bankCardNumber":"364435172576215", "nameOnCard":"SusanSmith", "cardType":"Credit", "issueNumber":"1", "serialNumber":"1324234", "validFrom":"2020-01-27T00:00:00Z", "expires":"2021-01-27T00:00:00Z", "enabled":false, "cancelled":false, "onHotList":false, "technology":"technology1", "networks":[""], "allows":["[credit","debit","cash_withdrawal]"], "accountId":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "bankId":"gh.29.uk", "replacement":{ "requestedDate":"2020-01-27T00:00:00Z", "reasonRequested":"FIRST" }, "pinResets":[{ "requestedDate":"2020-01-27T00:00:00Z", "reasonRequested":"FORGOT" }], "collected":{ "date":"2020-01-27T00:00:00Z" }, "posted":{ "date":"2020-01-27T00:00:00Z" }, "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "cardId":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ", "bankId":"gh.29.uk", "bankCardNumber":"364435172576215", "cardType":"Credit", "nameOnCard":"SusanSmith", "issueNumber":"1", "serialNumber":"1324234", "validFrom":"2020-01-27T00:00:00Z", "expires":"2021-01-27T00:00:00Z", "enabled":false, "cancelled":false, "onHotList":false, "technology":"technology1", "networks":[""], "allows":["DEBIT"], "account":{ "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "accountType":"AC", "balance":"10", "currency":"EUR", "name":"bankAccount name string", "label":"My Account", "number":"546387432", "bankId":{ "value":"gh.29.uk" }, "lastUpdate":"2018-03-09T00:00:00Z", "branchId":"DERBY6", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "accountRules":[{ "scheme":"AccountRule scheme string", "value":"AccountRule value string" }], "accountHolder":"bankAccount accountHolder string", "attributes":[{ "name":"STATUS", "type":"STRING", "value":"closed" }] }, "replacement":{ "requestedDate":"2020-01-27T00:00:00Z", "reasonRequested":"FIRST" }, "pinResets":[{ "requestedDate":"2020-01-27T00:00:00Z", "reasonRequested":"FORGOT" }], "collected":{ "date":"2020-01-27T00:00:00Z" }, "posted":{ "date":"2020-01-27T00:00:00Z" }, "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "cvv":"123", "brand":"Visa" } }Required
Fields{ }Dependent
Endpoints
obp.makePaymentv210
Make Paymentv210Kafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "fromAccount":{ "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "accountType":"AC", "balance":"10", "currency":"EUR", "name":"bankAccount name string", "label":"My Account", "number":"bankAccount number string", "bankId":{ "value":"gh.29.uk" }, "lastUpdate":"2018-03-09T00:00:00Z", "branchId":"DERBY6", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "accountRules":[{ "scheme":"AccountRule scheme string", "value":"AccountRule value string" }], "accountHolder":"bankAccount accountHolder string", "attributes":[{ "name":"STATUS", "type":"STRING", "value":"closed" }] }, "toAccount":{ "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "accountType":"AC", "balance":"10", "currency":"EUR", "name":"bankAccount name string", "label":"My Account", "number":"bankAccount number string", "bankId":{ "value":"gh.29.uk" }, "lastUpdate":"2018-03-09T00:00:00Z", "branchId":"DERBY6", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "accountRules":[{ "scheme":"AccountRule scheme string", "value":"AccountRule value string" }], "accountHolder":"bankAccount accountHolder string", "attributes":[{ "name":"STATUS", "type":"STRING", "value":"closed" }] }, "transactionRequestId":{ "value":"8138a7e4-6d02-40e3-a129-0b2bf89de9f1" }, "transactionRequestCommonBody":{ "value":{ "currency":"EUR", "amount":"10.12" }, "description":"This an optional field. Maximum length is 2000. It can be any characters here." }, "amount":"10.12", "description":"This an optional field. Maximum length is 2000. It can be any characters here.", "transactionRequestType":{ "value":"SEPA" }, "chargePolicy":"SHARED" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "value":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub" } }Required
Fields{ }Dependent
Endpoints
obp.createTransactionRequestv210
Create Transaction Requestv210Kafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "initiator":{ "userPrimaryKey":{ "value":123 }, "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "idGivenByProvider":"string", "provider":"ETHEREUM", "emailAddress":"", "name":"felixsmith", "createdByConsentId":"string", "createdByUserInvitationId":"string", "isDeleted":true, "lastMarketingAgreementSignedDate":"2020-01-27T00:00:00Z" }, "viewId":{ "value":"owner" }, "fromAccount":{ "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "accountType":"AC", "balance":"10", "currency":"EUR", "name":"bankAccount name string", "label":"My Account", "number":"bankAccount number string", "bankId":{ "value":"gh.29.uk" }, "lastUpdate":"2018-03-09T00:00:00Z", "branchId":"DERBY6", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "accountRules":[{ "scheme":"AccountRule scheme string", "value":"AccountRule value string" }], "accountHolder":"bankAccount accountHolder string", "attributes":[{ "name":"STATUS", "type":"STRING", "value":"closed" }] }, "toAccount":{ "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "accountType":"AC", "balance":"10", "currency":"EUR", "name":"bankAccount name string", "label":"My Account", "number":"bankAccount number string", "bankId":{ "value":"gh.29.uk" }, "lastUpdate":"2018-03-09T00:00:00Z", "branchId":"DERBY6", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "accountRules":[{ "scheme":"AccountRule scheme string", "value":"AccountRule value string" }], "accountHolder":"bankAccount accountHolder string", "attributes":[{ "name":"STATUS", "type":"STRING", "value":"closed" }] }, "transactionRequestType":{ "value":"SEPA" }, "transactionRequestCommonBody":{ "value":{ "currency":"EUR", "amount":"10.12" }, "description":"This an optional field. Maximum length is 2000. It can be any characters here." }, "detailsPlain":"string", "chargePolicy":"SHARED", "challengeType":"", "scaMethod":"SMS" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "id":{ "value":"8138a7e4-6d02-40e3-a129-0b2bf89de9f1" }, "type":"SEPA", "from":{ "bank_id":"gh.29.uk", "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "body":{ "value":{ "currency":"EUR", "amount":"10.12" }, "description":"This an optional field. Maximum length is 2000. It can be any characters here." }, "transaction_ids":"string", "status":"", "start_date":"2019-09-07T00:00:00Z", "end_date":"2019-09-08T00:00:00Z", "challenge":{ "id":"123chaneid13-6d02-40e3-a129-0b2bf89de9f0", "allowed_attempts":123, "challenge_type":"string" }, "charge":{ "summary":"", "value":{ "currency":"EUR", "amount":"10.12" } } } }Required
Fields{ }Dependent
Endpoints
obp.createTransactionRequestv400
Create Transaction Requestv400Kafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "initiator":{ "userPrimaryKey":{ "value":123 }, "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "idGivenByProvider":"string", "provider":"ETHEREUM", "emailAddress":"", "name":"felixsmith", "createdByConsentId":"string", "createdByUserInvitationId":"string", "isDeleted":true, "lastMarketingAgreementSignedDate":"2020-01-27T00:00:00Z" }, "viewId":{ "value":"owner" }, "fromAccount":{ "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "accountType":"AC", "balance":"10", "currency":"EUR", "name":"bankAccount name string", "label":"My Account", "number":"bankAccount number string", "bankId":{ "value":"gh.29.uk" }, "lastUpdate":"2018-03-09T00:00:00Z", "branchId":"DERBY6", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "accountRules":[{ "scheme":"AccountRule scheme string", "value":"AccountRule value string" }], "accountHolder":"bankAccount accountHolder string", "attributes":[{ "name":"STATUS", "type":"STRING", "value":"closed" }] }, "toAccount":{ "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "accountType":"AC", "balance":"10", "currency":"EUR", "name":"bankAccount name string", "label":"My Account", "number":"bankAccount number string", "bankId":{ "value":"gh.29.uk" }, "lastUpdate":"2018-03-09T00:00:00Z", "branchId":"DERBY6", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "accountRules":[{ "scheme":"AccountRule scheme string", "value":"AccountRule value string" }], "accountHolder":"bankAccount accountHolder string", "attributes":[{ "name":"STATUS", "type":"STRING", "value":"closed" }] }, "transactionRequestType":{ "value":"SEPA" }, "transactionRequestCommonBody":{ "value":{ "currency":"EUR", "amount":"10.12" }, "description":"This an optional field. Maximum length is 2000. It can be any characters here." }, "detailsPlain":"string", "chargePolicy":"SHARED", "challengeType":"", "scaMethod":"SMS", "reasons":[{ "code":"125", "documentNumber":"", "amount":"10.12", "currency":"EUR", "description":"This an optional field. Maximum length is 2000. It can be any characters here." }], "berlinGroupPayments":{ "endToEndIdentification":"string", "instructionIdentification":"string", "debtorName":"string", "debtorAccount":{ "iban":"string" }, "debtorId":"string", "ultimateDebtor":"string", "instructedAmount":{ "currency":"EUR", "amount":"10.12" }, "currencyOfTransfer":"string", "exchangeRateInformation":"string", "creditorAccount":{ "iban":"string" }, "creditorAgent":"string", "creditorAgentName":"string", "creditorName":"string", "creditorId":"string", "creditorAddress":"string", "creditorNameAndAddress":"string", "ultimateCreditor":"string", "purposeCode":"string", "chargeBearer":"string", "serviceLevel":"string", "remittanceInformationUnstructured":"string", "remittanceInformationUnstructuredArray":"string", "remittanceInformationStructured":"string", "remittanceInformationStructuredArray":"string", "requestedExecutionDate":"string", "requestedExecutionTime":"string" } }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "id":{ "value":"8138a7e4-6d02-40e3-a129-0b2bf89de9f1" }, "type":"SEPA", "from":{ "bank_id":"gh.29.uk", "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "body":{ "value":{ "currency":"EUR", "amount":"10.12" }, "description":"This an optional field. Maximum length is 2000. It can be any characters here." }, "transaction_ids":"string", "status":"", "start_date":"2019-09-07T00:00:00Z", "end_date":"2019-09-08T00:00:00Z", "challenge":{ "id":"123chaneid13-6d02-40e3-a129-0b2bf89de9f0", "allowed_attempts":123, "challenge_type":"string" }, "charge":{ "summary":"", "value":{ "currency":"EUR", "amount":"10.12" } } } }Required
Fields{ }Dependent
Endpoints
obp.getTransactionRequests210
Get Transaction Requests210Kafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "initiator":{ "userPrimaryKey":{ "value":123 }, "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "idGivenByProvider":"string", "provider":"ETHEREUM", "emailAddress":"", "name":"felixsmith", "createdByConsentId":"string", "createdByUserInvitationId":"string", "isDeleted":true, "lastMarketingAgreementSignedDate":"2020-01-27T00:00:00Z" }, "fromAccount":{ "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "accountType":"AC", "balance":"10", "currency":"EUR", "name":"bankAccount name string", "label":"My Account", "number":"bankAccount number string", "bankId":{ "value":"gh.29.uk" }, "lastUpdate":"2018-03-09T00:00:00Z", "branchId":"DERBY6", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "accountRules":[{ "scheme":"AccountRule scheme string", "value":"AccountRule value string" }], "accountHolder":"bankAccount accountHolder string", "attributes":[{ "name":"STATUS", "type":"STRING", "value":"closed" }] } }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":[{ "id":{ "value":"8138a7e4-6d02-40e3-a129-0b2bf89de9f1" }, "type":"SEPA", "from":{ "bank_id":"gh.29.uk", "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "body":{ "value":{ "currency":"EUR", "amount":"10.12" }, "description":"This an optional field. Maximum length is 2000. It can be any characters here." }, "transaction_ids":"string", "status":"", "start_date":"2019-09-07T00:00:00Z", "end_date":"2019-09-08T00:00:00Z", "challenge":{ "id":"123chaneid13-6d02-40e3-a129-0b2bf89de9f0", "allowed_attempts":123, "challenge_type":"string" }, "charge":{ "summary":"", "value":{ "currency":"EUR", "amount":"10.12" } } }] }Required
Fields{ }Dependent
Endpoints
obp.getTransactionRequestImpl
Get Transaction Request ImplKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "transactionRequestId":{ "value":"8138a7e4-6d02-40e3-a129-0b2bf89de9f1" } }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "id":{ "value":"8138a7e4-6d02-40e3-a129-0b2bf89de9f1" }, "type":"SEPA", "from":{ "bank_id":"gh.29.uk", "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "body":{ "value":{ "currency":"EUR", "amount":"10.12" }, "description":"This an optional field. Maximum length is 2000. It can be any characters here." }, "transaction_ids":"string", "status":"", "start_date":"2019-09-07T00:00:00Z", "end_date":"2019-09-08T00:00:00Z", "challenge":{ "id":"123chaneid13-6d02-40e3-a129-0b2bf89de9f0", "allowed_attempts":123, "challenge_type":"string" }, "charge":{ "summary":"", "value":{ "currency":"EUR", "amount":"10.12" } } } }Required
Fields{ }Dependent
Endpoints
obp.createTransactionAfterChallengeV210
Create Transaction After Challenge V210Kafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "fromAccount":{ "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "accountType":"AC", "balance":"10", "currency":"EUR", "name":"bankAccount name string", "label":"My Account", "number":"bankAccount number string", "bankId":{ "value":"gh.29.uk" }, "lastUpdate":"2018-03-09T00:00:00Z", "branchId":"DERBY6", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "accountRules":[{ "scheme":"AccountRule scheme string", "value":"AccountRule value string" }], "accountHolder":"bankAccount accountHolder string", "attributes":[{ "name":"STATUS", "type":"STRING", "value":"closed" }] }, "transactionRequest":{ "id":{ "value":"8138a7e4-6d02-40e3-a129-0b2bf89de9f1" }, "type":"SEPA", "from":{ "bank_id":"gh.29.uk", "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "body":{ "value":{ "currency":"EUR", "amount":"10.12" }, "description":"This an optional field. Maximum length is 2000. It can be any characters here." }, "transaction_ids":"string", "status":"", "start_date":"2019-09-07T00:00:00Z", "end_date":"2019-09-08T00:00:00Z", "challenge":{ "id":"123chaneid13-6d02-40e3-a129-0b2bf89de9f0", "allowed_attempts":123, "challenge_type":"string" }, "charge":{ "summary":"", "value":{ "currency":"EUR", "amount":"10.12" } } } }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "id":{ "value":"8138a7e4-6d02-40e3-a129-0b2bf89de9f1" }, "type":"SEPA", "from":{ "bank_id":"gh.29.uk", "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "body":{ "value":{ "currency":"EUR", "amount":"10.12" }, "description":"This an optional field. Maximum length is 2000. It can be any characters here." }, "transaction_ids":"string", "status":"", "start_date":"2019-09-07T00:00:00Z", "end_date":"2019-09-08T00:00:00Z", "challenge":{ "id":"123chaneid13-6d02-40e3-a129-0b2bf89de9f0", "allowed_attempts":123, "challenge_type":"string" }, "charge":{ "summary":"", "value":{ "currency":"EUR", "amount":"10.12" } } } }Required
Fields{ }Dependent
Endpoints
obp.updateBankAccount
Update Bank AccountKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "bankId":{ "value":"gh.29.uk" }, "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "accountType":"AC", "accountLabel":"string", "branchId":"DERBY6", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }] }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "accountType":"AC", "balance":"10", "currency":"EUR", "name":"bankAccount name string", "number":"bankAccount number string", "bankId":{ "value":"gh.29.uk" }, "lastUpdate":"2018-03-09T00:00:00Z", "branchId":"DERBY6", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "attributes":[{ "name":"STATUS", "type":"STRING", "value":"closed" }] } }Required
Fields{ }Dependent
Endpoints
obp.createBankAccount
Create Bank AccountKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "bankId":{ "value":"gh.29.uk" }, "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "accountType":"AC", "accountLabel":"string", "currency":"EUR", "initialBalance":"123.321", "accountHolderName":"string", "branchId":"DERBY6", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }] }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "accountType":"AC", "balance":"10", "currency":"EUR", "name":"bankAccount name string", "number":"bankAccount number string", "bankId":{ "value":"gh.29.uk" }, "lastUpdate":"2018-03-09T00:00:00Z", "branchId":"DERBY6", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "attributes":[{ "name":"STATUS", "type":"STRING", "value":"closed" }] } }Required
Fields{ }Dependent
Endpoints
obp.accountExists
Account ExistsKafka/AkkaOutboundInboundTopicMessage{ "bankId":{ "value":"gh.29.uk" }, "accountNumber":"546387432" }{ "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":true }Required
Fields{ }Dependent
Endpoints
obp.getProducts
Get ProductsKafka/AkkaOutboundInboundTopicMessage{ "bankId":{ "value":"gh.29.uk" }, "params":[{ "name":"ACCOUNT_MANAGEMENT_FEE", "value":["5987953"] }] }{ "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":[{ "bankId":{ "value":"gh.29.uk" }, "code":{ "value":"1234BW" }, "parentProductCode":{ "value":"787LOW" }, "name":"Deposit Account 1", "category":"", "family":"", "superFamily":"", "moreInfoUrl":"www.example.com/abc", "termsAndConditionsUrl":"www.example.com/xyz", "details":"", "description":"This an optional field. Maximum length is 2000. It can be any characters here.", "meta":{ "license":{ "id":"ODbL-1.0", "name":"Open Database License" } } }] }Required
Fields{ }Dependent
Endpoints
obp.getProduct
Get ProductKafka/AkkaOutboundInboundTopicMessage{ "bankId":{ "value":"gh.29.uk" }, "productCode":{ "value":"1234BW" } }{ "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "bankId":{ "value":"gh.29.uk" }, "code":{ "value":"1234BW" }, "parentProductCode":{ "value":"787LOW" }, "name":"Deposit Account 1", "category":"", "family":"", "superFamily":"", "moreInfoUrl":"www.example.com/abc", "termsAndConditionsUrl":"www.example.com/xyz", "details":"", "description":"This an optional field. Maximum length is 2000. It can be any characters here.", "meta":{ "license":{ "id":"ODbL-1.0", "name":"Open Database License" } } } }Required
Fields{ }Dependent
Endpoints
obp.getBranch
Get BranchKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "bankId":{ "value":"gh.29.uk" }, "branchId":{ "value":"DERBY6" } }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "branchId":{ "value":"DERBY6" }, "bankId":{ "value":"gh.29.uk" }, "name":"ACCOUNT_MANAGEMENT_FEE", "address":{ "line1":"", "line2":"", "line3":"", "city":"", "county":"", "state":"", "postCode":"789", "countryCode":"1254" }, "location":{ "latitude":38.8951, "longitude":-77.0364, "date":"2020-01-27T00:00:00Z", "user":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "provider":"ETHEREUM", "username":"felixsmith" } }, "lobbyString":{ "hours":"string" }, "driveUpString":{ "hours":"string" }, "meta":{ "license":{ "id":"ODbL-1.0", "name":"Open Database License" } }, "branchRouting":{ "scheme":"BRANCH-CODE", "address":"DERBY6" }, "lobby":{ "monday":[{ "openingTime":"", "closingTime":"2020-01-27" }], "tuesday":[{ "openingTime":"", "closingTime":"2020-01-27" }], "wednesday":[{ "openingTime":"", "closingTime":"2020-01-27" }], "thursday":[{ "openingTime":"", "closingTime":"2020-01-27" }], "friday":[{ "openingTime":"", "closingTime":"2020-01-27" }], "saturday":[{ "openingTime":"", "closingTime":"2020-01-27" }], "sunday":[{ "openingTime":"", "closingTime":"2020-01-27" }] }, "driveUp":{ "monday":{ "openingTime":"", "closingTime":"2020-01-27" }, "tuesday":{ "openingTime":"", "closingTime":"2020-01-27" }, "wednesday":{ "openingTime":"", "closingTime":"2020-01-27" }, "thursday":{ "openingTime":"", "closingTime":"2020-01-27" }, "friday":{ "openingTime":"", "closingTime":"2020-01-27" }, "saturday":{ "openingTime":"", "closingTime":"2020-01-27" }, "sunday":{ "openingTime":"", "closingTime":"2020-01-27" } }, "isAccessible":false, "accessibleFeatures":"string", "branchType":"", "moreInfo":"More information about this fee", "phoneNumber":"", "isDeleted":true } }Required
Fields{ }Dependent
Endpoints
obp.getBranches
Get BranchesKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "bankId":{ "value":"gh.29.uk" }, "limit":100, "offset":100, "fromDate":"", "toDate":"" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":[{ "branchId":{ "value":"DERBY6" }, "bankId":{ "value":"gh.29.uk" }, "name":"ACCOUNT_MANAGEMENT_FEE", "address":{ "line1":"", "line2":"", "line3":"", "city":"", "county":"", "state":"", "postCode":"789", "countryCode":"1254" }, "location":{ "latitude":38.8951, "longitude":-77.0364, "date":"2020-01-27T00:00:00Z", "user":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "provider":"ETHEREUM", "username":"felixsmith" } }, "lobbyString":{ "hours":"string" }, "driveUpString":{ "hours":"string" }, "meta":{ "license":{ "id":"ODbL-1.0", "name":"Open Database License" } }, "branchRouting":{ "scheme":"BRANCH-CODE", "address":"DERBY6" }, "lobby":{ "monday":[{ "openingTime":"", "closingTime":"2020-01-27" }], "tuesday":[{ "openingTime":"", "closingTime":"2020-01-27" }], "wednesday":[{ "openingTime":"", "closingTime":"2020-01-27" }], "thursday":[{ "openingTime":"", "closingTime":"2020-01-27" }], "friday":[{ "openingTime":"", "closingTime":"2020-01-27" }], "saturday":[{ "openingTime":"", "closingTime":"2020-01-27" }], "sunday":[{ "openingTime":"", "closingTime":"2020-01-27" }] }, "driveUp":{ "monday":{ "openingTime":"", "closingTime":"2020-01-27" }, "tuesday":{ "openingTime":"", "closingTime":"2020-01-27" }, "wednesday":{ "openingTime":"", "closingTime":"2020-01-27" }, "thursday":{ "openingTime":"", "closingTime":"2020-01-27" }, "friday":{ "openingTime":"", "closingTime":"2020-01-27" }, "saturday":{ "openingTime":"", "closingTime":"2020-01-27" }, "sunday":{ "openingTime":"", "closingTime":"2020-01-27" } }, "isAccessible":false, "accessibleFeatures":"string", "branchType":"", "moreInfo":"More information about this fee", "phoneNumber":"", "isDeleted":true }] }Required
Fields{ }Dependent
Endpoints
obp.getAtm
Get AtmKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "bankId":{ "value":"gh.29.uk" }, "atmId":{ "value":"atme-9a0f-4bfa-b30b-9003aa467f51" } }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "atmId":{ "value":"atme-9a0f-4bfa-b30b-9003aa467f51" }, "bankId":{ "value":"gh.29.uk" }, "name":"ACCOUNT_MANAGEMENT_FEE", "address":{ "line1":"", "line2":"", "line3":"", "city":"", "county":"", "state":"", "postCode":"789", "countryCode":"1254" }, "location":{ "latitude":38.8951, "longitude":-77.0364, "date":"2020-01-27T00:00:00Z", "user":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "provider":"ETHEREUM", "username":"felixsmith" } }, "meta":{ "license":{ "id":"ODbL-1.0", "name":"Open Database License" } }, "OpeningTimeOnMonday":"string", "ClosingTimeOnMonday":"string", "OpeningTimeOnTuesday":"string", "ClosingTimeOnTuesday":"string", "OpeningTimeOnWednesday":"string", "ClosingTimeOnWednesday":"string", "OpeningTimeOnThursday":"string", "ClosingTimeOnThursday":"string", "OpeningTimeOnFriday":"string", "ClosingTimeOnFriday":"string", "OpeningTimeOnSaturday":"string", "ClosingTimeOnSaturday":"string", "OpeningTimeOnSunday":"string", "ClosingTimeOnSunday":"string", "isAccessible":false, "locatedAt":"", "moreInfo":"More information about this fee", "hasDepositCapability":false, "supportedLanguages":["[\"es\"","\"fr\"","\"de\"]"], "services":[""], "accessibilityFeatures":["[\"ATAC\"","\"ATAD\"]"], "supportedCurrencies":["[\"EUR\"","\"MXN\"","\"USD\"]"], "notes":[""], "locationCategories":[""], "minimumWithdrawal":"string", "branchIdentification":"string", "siteIdentification":"", "siteName":"string", "cashWithdrawalNationalFee":"", "cashWithdrawalInternationalFee":"", "balanceInquiryFee":"", "atmType":"", "phone":"" } }Required
Fields{ }Dependent
Endpoints
obp.getAtms
Get AtmsKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "bankId":{ "value":"gh.29.uk" }, "limit":100, "offset":100, "fromDate":"", "toDate":"" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":[{ "atmId":{ "value":"atme-9a0f-4bfa-b30b-9003aa467f51" }, "bankId":{ "value":"gh.29.uk" }, "name":"ACCOUNT_MANAGEMENT_FEE", "address":{ "line1":"", "line2":"", "line3":"", "city":"", "county":"", "state":"", "postCode":"789", "countryCode":"1254" }, "location":{ "latitude":38.8951, "longitude":-77.0364, "date":"2020-01-27T00:00:00Z", "user":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "provider":"ETHEREUM", "username":"felixsmith" } }, "meta":{ "license":{ "id":"ODbL-1.0", "name":"Open Database License" } }, "OpeningTimeOnMonday":"string", "ClosingTimeOnMonday":"string", "OpeningTimeOnTuesday":"string", "ClosingTimeOnTuesday":"string", "OpeningTimeOnWednesday":"string", "ClosingTimeOnWednesday":"string", "OpeningTimeOnThursday":"string", "ClosingTimeOnThursday":"string", "OpeningTimeOnFriday":"string", "ClosingTimeOnFriday":"string", "OpeningTimeOnSaturday":"string", "ClosingTimeOnSaturday":"string", "OpeningTimeOnSunday":"string", "ClosingTimeOnSunday":"string", "isAccessible":false, "locatedAt":"", "moreInfo":"More information about this fee", "hasDepositCapability":false, "supportedLanguages":["[\"es\"","\"fr\"","\"de\"]"], "services":[""], "accessibilityFeatures":["[\"ATAC\"","\"ATAD\"]"], "supportedCurrencies":["[\"EUR\"","\"MXN\"","\"USD\"]"], "notes":[""], "locationCategories":[""], "minimumWithdrawal":"string", "branchIdentification":"string", "siteIdentification":"", "siteName":"string", "cashWithdrawalNationalFee":"", "cashWithdrawalInternationalFee":"", "balanceInquiryFee":"", "atmType":"", "phone":"" }] }Required
Fields{ }Dependent
Endpoints
obp.getCurrentFxRate
Get Current Fx RateKafka/AkkaOutboundInboundTopicMessage{ "bankId":{ "value":"gh.29.uk" }, "fromCurrencyCode":"", "toCurrencyCode":"EUR" }{ "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "bankId":{ "value":"gh.29.uk" }, "fromCurrencyCode":"", "toCurrencyCode":"EUR", "conversionValue":100.0, "inverseConversionValue":50.0, "effectiveDate":"2020-01-27T00:00:00Z" } }Required
Fields{ }Dependent
Endpoints
obp.createTransactionAfterChallengev300
Create Transaction After Challengev300Kafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "initiator":{ "userPrimaryKey":{ "value":123 }, "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "idGivenByProvider":"string", "provider":"ETHEREUM", "emailAddress":"", "name":"felixsmith", "createdByConsentId":"string", "createdByUserInvitationId":"string", "isDeleted":true, "lastMarketingAgreementSignedDate":"2020-01-27T00:00:00Z" }, "fromAccount":{ "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "accountType":"AC", "balance":"10", "currency":"EUR", "name":"bankAccount name string", "label":"My Account", "number":"bankAccount number string", "bankId":{ "value":"gh.29.uk" }, "lastUpdate":"2018-03-09T00:00:00Z", "branchId":"DERBY6", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "accountRules":[{ "scheme":"AccountRule scheme string", "value":"AccountRule value string" }], "accountHolder":"bankAccount accountHolder string", "attributes":[{ "name":"STATUS", "type":"STRING", "value":"closed" }] }, "transReqId":{ "value":"8138a7e4-6d02-40e3-a129-0b2bf89de9f1" }, "transactionRequestType":{ "value":"SEPA" } }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "id":{ "value":"8138a7e4-6d02-40e3-a129-0b2bf89de9f1" }, "type":"SEPA", "from":{ "bank_id":"gh.29.uk", "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "body":{ "value":{ "currency":"EUR", "amount":"10.12" }, "description":"This an optional field. Maximum length is 2000. It can be any characters here." }, "transaction_ids":"string", "status":"", "start_date":"2019-09-07T00:00:00Z", "end_date":"2019-09-08T00:00:00Z", "challenge":{ "id":"123chaneid13-6d02-40e3-a129-0b2bf89de9f0", "allowed_attempts":123, "challenge_type":"string" }, "charge":{ "summary":"", "value":{ "currency":"EUR", "amount":"10.12" } } } }Required
Fields{ }Dependent
Endpoints
obp.makePaymentv300
Make Paymentv300Kafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "initiator":{ "userPrimaryKey":{ "value":123 }, "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "idGivenByProvider":"string", "provider":"ETHEREUM", "emailAddress":"", "name":"felixsmith", "createdByConsentId":"string", "createdByUserInvitationId":"string", "isDeleted":true, "lastMarketingAgreementSignedDate":"2020-01-27T00:00:00Z" }, "fromAccount":{ "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "accountType":"AC", "balance":"10", "currency":"EUR", "name":"bankAccount name string", "label":"My Account", "number":"bankAccount number string", "bankId":{ "value":"gh.29.uk" }, "lastUpdate":"2018-03-09T00:00:00Z", "branchId":"DERBY6", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "accountRules":[{ "scheme":"AccountRule scheme string", "value":"AccountRule value string" }], "accountHolder":"bankAccount accountHolder string", "attributes":[{ "name":"STATUS", "type":"STRING", "value":"closed" }] }, "toAccount":{ "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "accountType":"AC", "balance":"10", "currency":"EUR", "name":"bankAccount name string", "label":"My Account", "number":"bankAccount number string", "bankId":{ "value":"gh.29.uk" }, "lastUpdate":"2018-03-09T00:00:00Z", "branchId":"DERBY6", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "accountRules":[{ "scheme":"AccountRule scheme string", "value":"AccountRule value string" }], "accountHolder":"bankAccount accountHolder string", "attributes":[{ "name":"STATUS", "type":"STRING", "value":"closed" }] }, "toCounterparty":{ "createdByUserId":"", "name":"John Smith Ltd.", "description":"This an optional field. Maximum length is 2000. It can be any characters here.", "currency":"EUR", "thisBankId":"", "thisAccountId":"", "thisViewId":"", "counterpartyId":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh", "otherAccountRoutingScheme":"OBP", "otherAccountRoutingAddress":"36f8a9e6-c2b1-407a-8bd0-421b7119307e", "otherAccountSecondaryRoutingScheme":"IBAN", "otherAccountSecondaryRoutingAddress":"DE89370400440532013000", "otherBankRoutingScheme":"OBP", "otherBankRoutingAddress":"gh.29.uk", "otherBranchRoutingScheme":"OBP", "otherBranchRoutingAddress":"12f8a9e6-c2b1-407a-8bd0-421b7119307e", "isBeneficiary":false, "bespoke":[{ "key":"CustomerNumber", "value":"5987953" }] }, "transactionRequestCommonBody":{ "value":{ "currency":"EUR", "amount":"10.12" }, "description":"This an optional field. Maximum length is 2000. It can be any characters here." }, "transactionRequestType":{ "value":"SEPA" }, "chargePolicy":"SHARED" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "value":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub" } }Required
Fields{ }Dependent
Endpoints
obp.createTransactionRequestv300
Create Transaction Requestv300Kafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "initiator":{ "userPrimaryKey":{ "value":123 }, "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "idGivenByProvider":"string", "provider":"ETHEREUM", "emailAddress":"", "name":"felixsmith", "createdByConsentId":"string", "createdByUserInvitationId":"string", "isDeleted":true, "lastMarketingAgreementSignedDate":"2020-01-27T00:00:00Z" }, "viewId":{ "value":"owner" }, "fromAccount":{ "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "accountType":"AC", "balance":"10", "currency":"EUR", "name":"bankAccount name string", "label":"My Account", "number":"bankAccount number string", "bankId":{ "value":"gh.29.uk" }, "lastUpdate":"2018-03-09T00:00:00Z", "branchId":"DERBY6", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "accountRules":[{ "scheme":"AccountRule scheme string", "value":"AccountRule value string" }], "accountHolder":"bankAccount accountHolder string", "attributes":[{ "name":"STATUS", "type":"STRING", "value":"closed" }] }, "toAccount":{ "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "accountType":"AC", "balance":"10", "currency":"EUR", "name":"bankAccount name string", "label":"My Account", "number":"bankAccount number string", "bankId":{ "value":"gh.29.uk" }, "lastUpdate":"2018-03-09T00:00:00Z", "branchId":"DERBY6", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "accountRules":[{ "scheme":"AccountRule scheme string", "value":"AccountRule value string" }], "accountHolder":"bankAccount accountHolder string", "attributes":[{ "name":"STATUS", "type":"STRING", "value":"closed" }] }, "toCounterparty":{ "createdByUserId":"", "name":"John Smith Ltd.", "description":"This an optional field. Maximum length is 2000. It can be any characters here.", "currency":"EUR", "thisBankId":"", "thisAccountId":"", "thisViewId":"", "counterpartyId":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh", "otherAccountRoutingScheme":"OBP", "otherAccountRoutingAddress":"36f8a9e6-c2b1-407a-8bd0-421b7119307e", "otherAccountSecondaryRoutingScheme":"IBAN", "otherAccountSecondaryRoutingAddress":"DE89370400440532013000", "otherBankRoutingScheme":"OBP", "otherBankRoutingAddress":"gh.29.uk", "otherBranchRoutingScheme":"OBP", "otherBranchRoutingAddress":"12f8a9e6-c2b1-407a-8bd0-421b7119307e", "isBeneficiary":false, "bespoke":[{ "key":"CustomerNumber", "value":"5987953" }] }, "transactionRequestType":{ "value":"SEPA" }, "transactionRequestCommonBody":{ "value":{ "currency":"EUR", "amount":"10.12" }, "description":"This an optional field. Maximum length is 2000. It can be any characters here." }, "detailsPlain":"string", "chargePolicy":"SHARED" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "id":{ "value":"8138a7e4-6d02-40e3-a129-0b2bf89de9f1" }, "type":"SEPA", "from":{ "bank_id":"gh.29.uk", "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "body":{ "value":{ "currency":"EUR", "amount":"10.12" }, "description":"This an optional field. Maximum length is 2000. It can be any characters here." }, "transaction_ids":"string", "status":"", "start_date":"2019-09-07T00:00:00Z", "end_date":"2019-09-08T00:00:00Z", "challenge":{ "id":"123chaneid13-6d02-40e3-a129-0b2bf89de9f0", "allowed_attempts":123, "challenge_type":"string" }, "charge":{ "summary":"", "value":{ "currency":"EUR", "amount":"10.12" } } } }Required
Fields{ }Dependent
Endpoints
obp.makePaymentV400
Make Payment V400Kafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "transactionRequest":{ "id":{ "value":"8138a7e4-6d02-40e3-a129-0b2bf89de9f1" }, "type":"SEPA", "from":{ "bank_id":"gh.29.uk", "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "body":{ "value":{ "currency":"EUR", "amount":"10.12" }, "description":"This an optional field. Maximum length is 2000. It can be any characters here." }, "transaction_ids":"string", "status":"", "start_date":"2019-09-07T00:00:00Z", "end_date":"2019-09-08T00:00:00Z", "challenge":{ "id":"123chaneid13-6d02-40e3-a129-0b2bf89de9f0", "allowed_attempts":123, "challenge_type":"string" }, "charge":{ "summary":"", "value":{ "currency":"EUR", "amount":"10.12" } } }, "reasons":[{ "code":"125", "documentNumber":"", "amount":"10.12", "currency":"EUR", "description":"This an optional field. Maximum length is 2000. It can be any characters here." }] }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "value":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub" } }Required
Fields{ }Dependent
Endpoints
obp.cancelPaymentV400
Cancel Payment V400Kafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "transactionId":{ "value":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub" } }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "canBeCancelled":true, "startSca":true } }Required
Fields{ }Dependent
Endpoints
obp.createCounterparty
Create CounterpartyKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "name":"ACCOUNT_MANAGEMENT_FEE", "description":"This an optional field. Maximum length is 2000. It can be any characters here.", "currency":"EUR", "createdByUserId":"", "thisBankId":"", "thisAccountId":"", "thisViewId":"", "otherAccountRoutingScheme":"", "otherAccountRoutingAddress":"", "otherAccountSecondaryRoutingScheme":"", "otherAccountSecondaryRoutingAddress":"", "otherBankRoutingScheme":"", "otherBankRoutingAddress":"", "otherBranchRoutingScheme":"", "otherBranchRoutingAddress":"", "isBeneficiary":false, "bespoke":[{ "key":"CustomerNumber", "value":"5987953" }] }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "createdByUserId":"", "name":"ACCOUNT_MANAGEMENT_FEE", "description":"This an optional field. Maximum length is 2000. It can be any characters here.", "currency":"EUR", "thisBankId":"", "thisAccountId":"", "thisViewId":"", "counterpartyId":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh", "otherAccountRoutingScheme":"", "otherAccountRoutingAddress":"", "otherAccountSecondaryRoutingScheme":"", "otherAccountSecondaryRoutingAddress":"", "otherBankRoutingScheme":"", "otherBankRoutingAddress":"", "otherBranchRoutingScheme":"", "otherBranchRoutingAddress":"", "isBeneficiary":false, "bespoke":[{ "key":"CustomerNumber", "value":"5987953" }] } }Required
Fields{ }Dependent
Endpoints
obp.checkCustomerNumberAvailable
Check Customer Number AvailableKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "bankId":{ "value":"gh.29.uk" }, "customerNumber":"5987953" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":true }Required
Fields{ }Dependent
Endpoints
obp.createCustomer
Create CustomerKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "bankId":{ "value":"gh.29.uk" }, "legalName":"Eveline Tripman", "mobileNumber":"+44 07972 444 876", "email":"felixsmith@example.com", "faceImage":{ "date":"2019-09-08T00:00:00Z", "url":"http://www.example.com/id-docs/123/image.png" }, "dateOfBirth":"2018-03-09T00:00:00Z", "relationshipStatus":"single", "dependents":2, "dobOfDependents":["2019-09-08T00:00:00Z","2019-01-03T00:00:00Z"], "highestEducationAttained":"Master", "employmentStatus":"worker", "kycStatus":false, "lastOkDate":"2019-09-12T00:00:00Z", "creditRating":{ "rating":"", "source":"" }, "creditLimit":{ "currency":"EUR", "amount":"1000.00" }, "title":"Dr.", "branchId":"DERBY6", "nameSuffix":"Sr" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "bankId":"gh.29.uk", "number":"5987953", "legalName":"Eveline Tripman", "mobileNumber":"+44 07972 444 876", "email":"felixsmith@example.com", "faceImage":{ "date":"2019-09-08T00:00:00Z", "url":"http://www.example.com/id-docs/123/image.png" }, "dateOfBirth":"2018-03-09T00:00:00Z", "relationshipStatus":"single", "dependents":2, "dobOfDependents":["2019-09-08T00:00:00Z","2019-01-03T00:00:00Z"], "highestEducationAttained":"Master", "employmentStatus":"worker", "creditRating":{ "rating":"", "source":"" }, "creditLimit":{ "currency":"EUR", "amount":"1000.00" }, "kycStatus":false, "lastOkDate":"2019-09-08T00:00:00Z", "title":"title of customer", "branchId":"DERBY6", "nameSuffix":"Sr" } }Required
Fields{ }Dependent
Endpoints
obp.updateCustomerScaData
Update Customer Sca DataKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "mobileNumber":"+44 07972 444 876", "email":"felixsmith@example.com", "customerNumber":"5987953" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "bankId":"gh.29.uk", "number":"5987953", "legalName":"Eveline Tripman", "mobileNumber":"+44 07972 444 876", "email":"felixsmith@example.com", "faceImage":{ "date":"2019-09-08T00:00:00Z", "url":"http://www.example.com/id-docs/123/image.png" }, "dateOfBirth":"2018-03-09T00:00:00Z", "relationshipStatus":"single", "dependents":2, "dobOfDependents":["2019-09-08T00:00:00Z","2019-01-03T00:00:00Z"], "highestEducationAttained":"Master", "employmentStatus":"worker", "creditRating":{ "rating":"", "source":"" }, "creditLimit":{ "currency":"EUR", "amount":"1000.00" }, "kycStatus":false, "lastOkDate":"2019-09-08T00:00:00Z", "title":"title of customer", "branchId":"DERBY6", "nameSuffix":"Sr" } }Required
Fields{ }Dependent
Endpoints
obp.updateCustomerCreditData
Update Customer Credit DataKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "creditRating":"", "creditSource":"string", "creditLimit":{ "currency":"EUR", "amount":"1000.00" } }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "bankId":"gh.29.uk", "number":"5987953", "legalName":"Eveline Tripman", "mobileNumber":"+44 07972 444 876", "email":"felixsmith@example.com", "faceImage":{ "date":"2019-09-08T00:00:00Z", "url":"http://www.example.com/id-docs/123/image.png" }, "dateOfBirth":"2018-03-09T00:00:00Z", "relationshipStatus":"single", "dependents":2, "dobOfDependents":["2019-09-08T00:00:00Z","2019-01-03T00:00:00Z"], "highestEducationAttained":"Master", "employmentStatus":"worker", "creditRating":{ "rating":"", "source":"" }, "creditLimit":{ "currency":"EUR", "amount":"1000.00" }, "kycStatus":false, "lastOkDate":"2019-09-08T00:00:00Z", "title":"title of customer", "branchId":"DERBY6", "nameSuffix":"Sr" } }Required
Fields{ }Dependent
Endpoints
obp.updateCustomerGeneralData
Update Customer General DataKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "legalName":"Eveline Tripman", "faceImage":{ "date":"2019-09-08T00:00:00Z", "url":"http://www.example.com/id-docs/123/image.png" }, "dateOfBirth":"2018-03-09T00:00:00Z", "relationshipStatus":"single", "dependents":2, "highestEducationAttained":"Master", "employmentStatus":"worker", "title":"Dr.", "branchId":"DERBY6", "nameSuffix":"Sr" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "bankId":"gh.29.uk", "number":"5987953", "legalName":"Eveline Tripman", "mobileNumber":"+44 07972 444 876", "email":"felixsmith@example.com", "faceImage":{ "date":"2019-09-08T00:00:00Z", "url":"http://www.example.com/id-docs/123/image.png" }, "dateOfBirth":"2018-03-09T00:00:00Z", "relationshipStatus":"single", "dependents":2, "dobOfDependents":["2019-09-08T00:00:00Z","2019-01-03T00:00:00Z"], "highestEducationAttained":"Master", "employmentStatus":"worker", "creditRating":{ "rating":"", "source":"" }, "creditLimit":{ "currency":"EUR", "amount":"1000.00" }, "kycStatus":false, "lastOkDate":"2019-09-08T00:00:00Z", "title":"title of customer", "branchId":"DERBY6", "nameSuffix":"Sr" } }Required
Fields{ }Dependent
Endpoints
obp.getCustomersByUserId
Get Customers By User IdKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "bankId":"gh.29.uk", "number":"5987953", "legalName":"Eveline Tripman", "mobileNumber":"+44 07972 444 876", "email":"felixsmith@example.com", "faceImage":{ "date":"2019-09-08T00:00:00Z", "url":"http://www.example.com/id-docs/123/image.png" }, "dateOfBirth":"2018-03-09T00:00:00Z", "relationshipStatus":"single", "dependents":2, "dobOfDependents":["2019-09-08T00:00:00Z","2019-01-03T00:00:00Z"], "highestEducationAttained":"Master", "employmentStatus":"worker", "creditRating":{ "rating":"", "source":"" }, "creditLimit":{ "currency":"EUR", "amount":"1000.00" }, "kycStatus":false, "lastOkDate":"2019-09-08T00:00:00Z", "title":"title of customer", "branchId":"DERBY6", "nameSuffix":"Sr" }] }Required
Fields{ }Dependent
Endpoints
obp.getCustomerByCustomerId
Get Customer By Customer IdKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "bankId":"gh.29.uk", "number":"5987953", "legalName":"Eveline Tripman", "mobileNumber":"+44 07972 444 876", "email":"felixsmith@example.com", "faceImage":{ "date":"2019-09-08T00:00:00Z", "url":"http://www.example.com/id-docs/123/image.png" }, "dateOfBirth":"2018-03-09T00:00:00Z", "relationshipStatus":"single", "dependents":2, "dobOfDependents":["2019-09-08T00:00:00Z","2019-01-03T00:00:00Z"], "highestEducationAttained":"Master", "employmentStatus":"worker", "creditRating":{ "rating":"", "source":"" }, "creditLimit":{ "currency":"EUR", "amount":"1000.00" }, "kycStatus":false, "lastOkDate":"2019-09-08T00:00:00Z", "title":"title of customer", "branchId":"DERBY6", "nameSuffix":"Sr" } }Required
Fields{ }Dependent
Endpoints
obp.getCustomerByCustomerNumber
Get Customer By Customer NumberKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "customerNumber":"5987953", "bankId":{ "value":"gh.29.uk" } }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "bankId":"gh.29.uk", "number":"5987953", "legalName":"Eveline Tripman", "mobileNumber":"+44 07972 444 876", "email":"felixsmith@example.com", "faceImage":{ "date":"2019-09-08T00:00:00Z", "url":"http://www.example.com/id-docs/123/image.png" }, "dateOfBirth":"2018-03-09T00:00:00Z", "relationshipStatus":"single", "dependents":2, "dobOfDependents":["2019-09-08T00:00:00Z","2019-01-03T00:00:00Z"], "highestEducationAttained":"Master", "employmentStatus":"worker", "creditRating":{ "rating":"", "source":"" }, "creditLimit":{ "currency":"EUR", "amount":"1000.00" }, "kycStatus":false, "lastOkDate":"2019-09-08T00:00:00Z", "title":"title of customer", "branchId":"DERBY6", "nameSuffix":"Sr" } }Required
Fields{ }Dependent
Endpoints
obp.getCustomerAddress
Get Customer AddressKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerAddressId":"", "line1":"", "line2":"", "line3":"", "city":"", "county":"", "state":"", "postcode":"", "countryCode":"1254", "status":"", "tags":"Create-My-User", "insertDate":"2020-01-27T00:00:00Z" }] }Required
Fields{ }Dependent
Endpoints
obp.createCustomerAddress
Create Customer AddressKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "line1":"", "line2":"", "line3":"", "city":"", "county":"", "state":"", "postcode":"", "countryCode":"1254", "tags":"Create-My-User", "status":"" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerAddressId":"", "line1":"", "line2":"", "line3":"", "city":"", "county":"", "state":"", "postcode":"", "countryCode":"1254", "status":"", "tags":"Create-My-User", "insertDate":"2020-01-27T00:00:00Z" } }Required
Fields{ }Dependent
Endpoints
obp.updateCustomerAddress
Update Customer AddressKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "customerAddressId":"", "line1":"", "line2":"", "line3":"", "city":"", "county":"", "state":"", "postcode":"", "countryCode":"1254", "tags":"Create-My-User", "status":"" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerAddressId":"", "line1":"", "line2":"", "line3":"", "city":"", "county":"", "state":"", "postcode":"", "countryCode":"1254", "status":"", "tags":"Create-My-User", "insertDate":"2020-01-27T00:00:00Z" } }Required
Fields{ }Dependent
Endpoints
obp.deleteCustomerAddress
Delete Customer AddressKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "customerAddressId":"" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":true }Required
Fields{ }Dependent
Endpoints
obp.createTaxResidence
Create Tax ResidenceKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "domain":"", "taxNumber":"456" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "taxResidenceId":"", "domain":"", "taxNumber":"456" } }Required
Fields{ }Dependent
Endpoints
obp.getTaxResidence
Get Tax ResidenceKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "taxResidenceId":"", "domain":"", "taxNumber":"456" }] }Required
Fields{ }Dependent
Endpoints
obp.deleteTaxResidence
Delete Tax ResidenceKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "taxResourceId":"string" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":true }Required
Fields{ }Dependent
Endpoints
obp.getCustomers
Get CustomersKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "bankId":{ "value":"gh.29.uk" }, "limit":100, "offset":100, "fromDate":"", "toDate":"" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "bankId":"gh.29.uk", "number":"5987953", "legalName":"Eveline Tripman", "mobileNumber":"+44 07972 444 876", "email":"felixsmith@example.com", "faceImage":{ "date":"2019-09-08T00:00:00Z", "url":"http://www.example.com/id-docs/123/image.png" }, "dateOfBirth":"2018-03-09T00:00:00Z", "relationshipStatus":"single", "dependents":2, "dobOfDependents":["2019-09-08T00:00:00Z","2019-01-03T00:00:00Z"], "highestEducationAttained":"Master", "employmentStatus":"worker", "creditRating":{ "rating":"", "source":"" }, "creditLimit":{ "currency":"EUR", "amount":"1000.00" }, "kycStatus":false, "lastOkDate":"2019-09-08T00:00:00Z", "title":"title of customer", "branchId":"DERBY6", "nameSuffix":"Sr" }] }Required
Fields{ }Dependent
Endpoints
obp.getCustomersByCustomerPhoneNumber
Get Customers By Customer Phone NumberKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "bankId":{ "value":"gh.29.uk" }, "phoneNumber":"" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "bankId":"gh.29.uk", "number":"5987953", "legalName":"Eveline Tripman", "mobileNumber":"+44 07972 444 876", "email":"felixsmith@example.com", "faceImage":{ "date":"2019-09-08T00:00:00Z", "url":"http://www.example.com/id-docs/123/image.png" }, "dateOfBirth":"2018-03-09T00:00:00Z", "relationshipStatus":"single", "dependents":2, "dobOfDependents":["2019-09-08T00:00:00Z","2019-01-03T00:00:00Z"], "highestEducationAttained":"Master", "employmentStatus":"worker", "creditRating":{ "rating":"", "source":"" }, "creditLimit":{ "currency":"EUR", "amount":"1000.00" }, "kycStatus":false, "lastOkDate":"2019-09-08T00:00:00Z", "title":"title of customer", "branchId":"DERBY6", "nameSuffix":"Sr" }] }Required
Fields{ }Dependent
Endpoints
obp.getCheckbookOrders
Get Checkbook OrdersKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "bankId":"gh.29.uk", "accountId":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "account":{ "bank_id":"gh.29.uk", "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "account_type":"string", "account_routings":[{ "scheme":"scheme value", "address":"" }], "branch_routings":[{ "scheme":"scheme value", "address":"" }] }, "orders":[{ "order":{ "order_id":"string", "order_date":"string", "number_of_checkbooks":"string", "distribution_channel":"string", "status":"", "first_check_number":"string", "shipping_code":"string" } }] } }Required
Fields{ }Dependent
Endpoints
obp.getStatusOfCreditCardOrder
Get Status Of Credit Card OrderKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "bankId":"gh.29.uk", "accountId":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":[{ "card_type":"string", "card_description":"string", "use_type":"string" }] }Required
Fields{ }Dependent
Endpoints
obp.createUserAuthContext
Create User Auth ContextKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "key":"CustomerNumber", "value":"5987953" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "userAuthContextId":"", "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "key":"CustomerNumber", "value":"5987953", "timeStamp":"1100-01-01T00:00:00Z", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh" } }Required
Fields{ }Dependent
Endpoints
obp.createUserAuthContextUpdate
Create User Auth Context UpdateKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "key":"CustomerNumber", "value":"5987953" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "userAuthContextUpdateId":"", "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "key":"CustomerNumber", "value":"5987953", "challenge":"", "status":"", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh" } }Required
Fields{ }Dependent
Endpoints
obp.deleteUserAuthContexts
Delete User Auth ContextsKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":true }Required
Fields{ }Dependent
Endpoints
obp.deleteUserAuthContextById
Delete User Auth Context By IdKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "userAuthContextId":"" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":true }Required
Fields{ }Dependent
Endpoints
obp.getUserAuthContexts
Get User Auth ContextsKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":[{ "userAuthContextId":"", "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "key":"CustomerNumber", "value":"5987953", "timeStamp":"1100-01-01T00:00:00Z", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh" }] }Required
Fields{ }Dependent
Endpoints
obp.createOrUpdateProductAttribute
Create Or Update Product AttributeKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "bankId":{ "value":"gh.29.uk" }, "productCode":{ "value":"1234BW" }, "productAttributeId":"", "name":"ACCOUNT_MANAGEMENT_FEE", "productAttributeType":"STRING", "value":"5987953", "isActive":false }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "bankId":{ "value":"gh.29.uk" }, "productCode":{ "value":"1234BW" }, "productAttributeId":"", "name":"ACCOUNT_MANAGEMENT_FEE", "attributeType":"STRING", "value":"5987953", "isActive":false } }Required
Fields{ }Dependent
Endpoints
obp.getProductAttributeById
Get Product Attribute By IdKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "productAttributeId":"" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "bankId":{ "value":"gh.29.uk" }, "productCode":{ "value":"1234BW" }, "productAttributeId":"", "name":"ACCOUNT_MANAGEMENT_FEE", "attributeType":"STRING", "value":"5987953", "isActive":false } }Required
Fields{ }Dependent
Endpoints
obp.getProductAttributesByBankAndCode
Get Product Attributes By Bank And CodeKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "bank":{ "value":"" }, "productCode":{ "value":"1234BW" } }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":[{ "bankId":{ "value":"gh.29.uk" }, "productCode":{ "value":"1234BW" }, "productAttributeId":"", "name":"ACCOUNT_MANAGEMENT_FEE", "attributeType":"STRING", "value":"5987953", "isActive":false }] }Required
Fields{ }Dependent
Endpoints
obp.deleteProductAttribute
Delete Product AttributeKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "productAttributeId":"" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":true }Required
Fields{ }Dependent
Endpoints
obp.getAccountAttributeById
Get Account Attribute By IdKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "accountAttributeId":"" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "bankId":{ "value":"gh.29.uk" }, "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "productCode":{ "value":"1234BW" }, "accountAttributeId":"", "name":"ACCOUNT_MANAGEMENT_FEE", "attributeType":"STRING", "value":"5987953", "productInstanceCode":"string" } }Required
Fields{ }Dependent
Endpoints
obp.getTransactionAttributeById
Get Transaction Attribute By IdKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "transactionAttributeId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "bankId":{ "value":"gh.29.uk" }, "transactionId":{ "value":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub" }, "transactionAttributeId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "attributeType":"STRING", "name":"HOUSE_RENT", "value":"123456789" } }Required
Fields{ }Dependent
Endpoints
obp.createOrUpdateAccountAttribute
Create Or Update Account AttributeKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "bankId":{ "value":"gh.29.uk" }, "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "productCode":{ "value":"1234BW" }, "productAttributeId":"", "name":"ACCOUNT_MANAGEMENT_FEE", "accountAttributeType":"STRING", "value":"5987953", "productInstanceCode":"string" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "bankId":{ "value":"gh.29.uk" }, "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "productCode":{ "value":"1234BW" }, "accountAttributeId":"", "name":"ACCOUNT_MANAGEMENT_FEE", "attributeType":"STRING", "value":"5987953", "productInstanceCode":"string" } }Required
Fields{ }Dependent
Endpoints
obp.createOrUpdateCustomerAttribute
Create Or Update Customer AttributeKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "bankId":{ "value":"gh.29.uk" }, "customerId":{ "value":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh" }, "customerAttributeId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "name":"ACCOUNT_MANAGEMENT_FEE", "attributeType":"STRING", "value":"5987953" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "bankId":{ "value":"gh.29.uk" }, "customerId":{ "value":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh" }, "customerAttributeId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "attributeType":"STRING", "name":"SPECIAL_TAX_NUMBER", "value":"123456789" } }Required
Fields{ }Dependent
Endpoints
obp.createOrUpdateTransactionAttribute
Create Or Update Transaction AttributeKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "bankId":{ "value":"gh.29.uk" }, "transactionId":{ "value":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub" }, "transactionAttributeId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "name":"ACCOUNT_MANAGEMENT_FEE", "attributeType":"STRING", "value":"5987953" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "bankId":{ "value":"gh.29.uk" }, "transactionId":{ "value":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub" }, "transactionAttributeId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "attributeType":"STRING", "name":"HOUSE_RENT", "value":"123456789" } }Required
Fields{ }Dependent
Endpoints
obp.createAccountAttributes
Create Account AttributesKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "bankId":{ "value":"gh.29.uk" }, "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "productCode":{ "value":"1234BW" }, "accountAttributes":[{ "bankId":{ "value":"gh.29.uk" }, "productCode":{ "value":"1234BW" }, "productAttributeId":"", "name":"ACCOUNT_MANAGEMENT_FEE", "attributeType":"STRING", "value":"5987953", "isActive":false }], "productInstanceCode":"string" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":[{ "bankId":{ "value":"gh.29.uk" }, "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "productCode":{ "value":"1234BW" }, "accountAttributeId":"", "name":"ACCOUNT_MANAGEMENT_FEE", "attributeType":"STRING", "value":"5987953", "productInstanceCode":"string" }] }Required
Fields{ }Dependent
Endpoints
obp.getAccountAttributesByAccount
Get Account Attributes By AccountKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "bankId":{ "value":"gh.29.uk" }, "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" } }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":[{ "bankId":{ "value":"gh.29.uk" }, "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "productCode":{ "value":"1234BW" }, "accountAttributeId":"", "name":"ACCOUNT_MANAGEMENT_FEE", "attributeType":"STRING", "value":"5987953", "productInstanceCode":"string" }] }Required
Fields{ }Dependent
Endpoints
obp.getCustomerAttributes
Get Customer AttributesKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "bankId":{ "value":"gh.29.uk" }, "customerId":{ "value":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh" } }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":[{ "bankId":{ "value":"gh.29.uk" }, "customerId":{ "value":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh" }, "customerAttributeId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "attributeType":"STRING", "name":"SPECIAL_TAX_NUMBER", "value":"123456789" }] }Required
Fields{ }Dependent
Endpoints
obp.getCustomerIdsByAttributeNameValues
Get Customer Ids By Attribute Name ValuesKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "bankId":{ "value":"gh.29.uk" }, "nameValues":{ "some_name":["name1","name2"] } }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":[""] }Required
Fields{ }Dependent
Endpoints
obp.getCustomerAttributesForCustomers
Get Customer Attributes For CustomersKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "customers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "bankId":"gh.29.uk", "number":"5987953", "legalName":"Eveline Tripman", "mobileNumber":"+44 07972 444 876", "email":"felixsmith@example.com", "faceImage":{ "date":"2019-09-08T00:00:00Z", "url":"http://www.example.com/id-docs/123/image.png" }, "dateOfBirth":"2018-03-09T00:00:00Z", "relationshipStatus":"single", "dependents":2, "dobOfDependents":["2019-09-08T00:00:00Z","2019-01-03T00:00:00Z"], "highestEducationAttained":"Master", "employmentStatus":"worker", "creditRating":{ "rating":"", "source":"" }, "creditLimit":{ "currency":"EUR", "amount":"1000.00" }, "kycStatus":false, "lastOkDate":"2019-09-08T00:00:00Z", "title":"title of customer", "branchId":"DERBY6", "nameSuffix":"Sr" }] }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":[{ "customer":{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "bankId":"gh.29.uk", "number":"546387432", "legalName":"Eveline Tripman", "mobileNumber":"+44 07972 444 876", "email":"felixsmith@example.com", "faceImage":{ "date":"1100-01-01T00:00:00Z", "url":"http://www.example.com/id-docs/123/image.png" }, "dateOfBirth":"1100-01-01T00:00:00Z", "relationshipStatus":"single", "dependents":2, "dobOfDependents":["1100-01-01T00:00:00Z"], "highestEducationAttained":"Master", "employmentStatus":"worker", "creditRating":{ "rating":"", "source":"" }, "creditLimit":{ "currency":"EUR", "amount":"50.89" }, "kycStatus":false, "lastOkDate":"1100-01-01T00:00:00Z", "title":"Dr.", "branchId":"DERBY6", "nameSuffix":"Sr" }, "attributes":[{ "bankId":{ "value":"gh.29.uk" }, "customerId":{ "value":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh" }, "customerAttributeId":"some_customer_attributeId_value", "attributeType":"INTEGER", "name":"customer_attribute_field", "value":"example_value" }] }] }Required
Fields{ }Dependent
Endpoints
obp.getTransactionIdsByAttributeNameValues
Get Transaction Ids By Attribute Name ValuesKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "bankId":{ "value":"gh.29.uk" }, "nameValues":{ "some_name":["name1","name2"] } }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":[""] }Required
Fields{ }Dependent
Endpoints
obp.getTransactionAttributes
Get Transaction AttributesKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "bankId":{ "value":"gh.29.uk" }, "transactionId":{ "value":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub" } }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":[{ "bankId":{ "value":"gh.29.uk" }, "transactionId":{ "value":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub" }, "transactionAttributeId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "attributeType":"STRING", "name":"HOUSE_RENT", "value":"123456789" }] }Required
Fields{ }Dependent
Endpoints
obp.getCustomerAttributeById
Get Customer Attribute By IdKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "customerAttributeId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "bankId":{ "value":"gh.29.uk" }, "customerId":{ "value":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh" }, "customerAttributeId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "attributeType":"STRING", "name":"SPECIAL_TAX_NUMBER", "value":"123456789" } }Required
Fields{ }Dependent
Endpoints
obp.createOrUpdateCardAttribute
Create Or Update Card AttributeKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "bankId":{ "value":"gh.29.uk" }, "cardId":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ", "cardAttributeId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "name":"ACCOUNT_MANAGEMENT_FEE", "cardAttributeType":"STRING", "value":"5987953" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "name":"OVERDRAFT_START_DATE", "card_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ", "attribute_type":"STRING", "bank_id":{ "value":"gh.29.uk" }, "value":"2012-04-23", "card_attribute_id":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50" } }Required
Fields{ }Dependent
Endpoints
obp.getCardAttributeById
Get Card Attribute By IdKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "cardAttributeId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "name":"OVERDRAFT_START_DATE", "card_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ", "attribute_type":"STRING", "bank_id":{ "value":"gh.29.uk" }, "value":"2012-04-23", "card_attribute_id":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50" } }Required
Fields{ }Dependent
Endpoints
obp.getCardAttributesFromProvider
Get Card Attributes From ProviderKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "cardId":"36f8a9e6-c2b1-407a-8bd0-421b7119307e " }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":[{ "name":"OVERDRAFT_START_DATE", "card_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ", "attribute_type":"STRING", "bank_id":{ "value":"gh.29.uk" }, "value":"2012-04-23", "card_attribute_id":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50" }] }Required
Fields{ }Dependent
Endpoints
obp.createAccountApplication
Create Account ApplicationKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "productCode":{ "value":"1234BW" }, "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "accountApplicationId":"", "productCode":{ "value":"1234BW" }, "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "dateOfApplication":"2020-01-27T00:00:00Z", "status":"" } }Required
Fields{ }Dependent
Endpoints
obp.getAllAccountApplication
Get All Account ApplicationKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } } }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":[{ "accountApplicationId":"", "productCode":{ "value":"1234BW" }, "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "dateOfApplication":"2020-01-27T00:00:00Z", "status":"" }] }Required
Fields{ }Dependent
Endpoints
obp.getAccountApplicationById
Get Account Application By IdKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "accountApplicationId":"" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "accountApplicationId":"", "productCode":{ "value":"1234BW" }, "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "dateOfApplication":"2020-01-27T00:00:00Z", "status":"" } }Required
Fields{ }Dependent
Endpoints
obp.updateAccountApplicationStatus
Update Account Application StatusKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "accountApplicationId":"", "status":"" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "accountApplicationId":"", "productCode":{ "value":"1234BW" }, "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "dateOfApplication":"2020-01-27T00:00:00Z", "status":"" } }Required
Fields{ }Dependent
Endpoints
obp.getOrCreateProductCollection
Get Or Create Product CollectionKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "collectionCode":"", "productCodes":[""] }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":[{ "collectionCode":"", "productCode":"1234BW" }] }Required
Fields{ }Dependent
Endpoints
obp.getProductCollection
Get Product CollectionKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "collectionCode":"" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":[{ "collectionCode":"", "productCode":"1234BW" }] }Required
Fields{ }Dependent
Endpoints
obp.getOrCreateProductCollectionItem
Get Or Create Product Collection ItemKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "collectionCode":"", "memberProductCodes":[""] }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":[{ "collectionCode":"", "memberProductCode":"" }] }Required
Fields{ }Dependent
Endpoints
obp.getProductCollectionItem
Get Product Collection ItemKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "collectionCode":"" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":[{ "collectionCode":"", "memberProductCode":"" }] }Required
Fields{ }Dependent
Endpoints
obp.getProductCollectionItemsTree
Get Product Collection Items TreeKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "collectionCode":"", "bankId":"gh.29.uk" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":[{ "productCollectionItem":{ "collectionCode":"", "memberProductCode":"" }, "product":{ "bankId":{ "value":"gh.29.uk" }, "code":{ "value":"1234BW" }, "parentProductCode":{ "value":"787LOW" }, "name":"Deposit Account 1", "category":"", "family":"", "superFamily":"", "moreInfoUrl":"www.example.com/abc", "termsAndConditionsUrl":"www.example.com/xyz", "details":"", "description":"This an optional field. Maximum length is 2000. It can be any characters here.", "meta":{ "license":{ "id":"ODbL-1.0", "name":"Open Database License" } } }, "attributes":[{ "bankId":{ "value":"gh.29.uk" }, "productCode":{ "value":"1234BW" }, "productAttributeId":"", "name":"ACCOUNT_MANAGEMENT_FEE", "attributeType":"STRING", "value":"5987953", "isActive":false }] }] }Required
Fields{ }Dependent
Endpoints
obp.createMeeting
Create MeetingKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "bankId":{ "value":"gh.29.uk" }, "staffUser":{ "userPrimaryKey":{ "value":123 }, "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "idGivenByProvider":"string", "provider":"ETHEREUM", "emailAddress":"", "name":"felixsmith", "createdByConsentId":"string", "createdByUserInvitationId":"string", "isDeleted":true, "lastMarketingAgreementSignedDate":"2020-01-27T00:00:00Z" }, "customerUser":{ "userPrimaryKey":{ "value":123 }, "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "idGivenByProvider":"string", "provider":"ETHEREUM", "emailAddress":"", "name":"felixsmith", "createdByConsentId":"string", "createdByUserInvitationId":"string", "isDeleted":true, "lastMarketingAgreementSignedDate":"2020-01-27T00:00:00Z" }, "providerId":"", "purposeId":"", "when":"2020-01-27T00:00:00Z", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "customerToken":"", "staffToken":"", "creator":{ "name":"ACCOUNT_MANAGEMENT_FEE", "phone":"", "email":"felixsmith@example.com" }, "invitees":[{ "contactDetails":{ "name":"ACCOUNT_MANAGEMENT_FEE", "phone":"", "email":"felixsmith@example.com" }, "status":"" }] }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "meetingId":"", "providerId":"", "purposeId":"", "bankId":"gh.29.uk", "present":{ "staffUserId":"", "customerUserId":"" }, "keys":{ "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "customerToken":"", "staffToken":"" }, "when":"2020-01-27T00:00:00Z", "creator":{ "name":"ACCOUNT_MANAGEMENT_FEE", "phone":"", "email":"felixsmith@example.com" }, "invitees":[{ "contactDetails":{ "name":"ACCOUNT_MANAGEMENT_FEE", "phone":"", "email":"felixsmith@example.com" }, "status":"" }] } }Required
Fields{ }Dependent
Endpoints
obp.getMeetings
Get MeetingsKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "bankId":{ "value":"gh.29.uk" }, "user":{ "userPrimaryKey":{ "value":123 }, "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "idGivenByProvider":"string", "provider":"ETHEREUM", "emailAddress":"", "name":"felixsmith", "createdByConsentId":"string", "createdByUserInvitationId":"string", "isDeleted":true, "lastMarketingAgreementSignedDate":"2020-01-27T00:00:00Z" } }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":[{ "meetingId":"", "providerId":"", "purposeId":"", "bankId":"gh.29.uk", "present":{ "staffUserId":"", "customerUserId":"" }, "keys":{ "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "customerToken":"", "staffToken":"" }, "when":"2020-01-27T00:00:00Z", "creator":{ "name":"ACCOUNT_MANAGEMENT_FEE", "phone":"", "email":"felixsmith@example.com" }, "invitees":[{ "contactDetails":{ "name":"ACCOUNT_MANAGEMENT_FEE", "phone":"", "email":"felixsmith@example.com" }, "status":"" }] }] }Required
Fields{ }Dependent
Endpoints
obp.getMeeting
Get MeetingKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "bankId":{ "value":"gh.29.uk" }, "user":{ "userPrimaryKey":{ "value":123 }, "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "idGivenByProvider":"string", "provider":"ETHEREUM", "emailAddress":"", "name":"felixsmith", "createdByConsentId":"string", "createdByUserInvitationId":"string", "isDeleted":true, "lastMarketingAgreementSignedDate":"2020-01-27T00:00:00Z" }, "meetingId":"" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "meetingId":"", "providerId":"", "purposeId":"", "bankId":"gh.29.uk", "present":{ "staffUserId":"", "customerUserId":"" }, "keys":{ "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "customerToken":"", "staffToken":"" }, "when":"2020-01-27T00:00:00Z", "creator":{ "name":"ACCOUNT_MANAGEMENT_FEE", "phone":"", "email":"felixsmith@example.com" }, "invitees":[{ "contactDetails":{ "name":"ACCOUNT_MANAGEMENT_FEE", "phone":"", "email":"felixsmith@example.com" }, "status":"" }] } }Required
Fields{ }Dependent
Endpoints
obp.createOrUpdateKycCheck
Create Or Update Kyc CheckKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "id":"d8839721-ad8f-45dd-9f78-2080414b93f9", "customerNumber":"5987953", "date":"2020-01-27T00:00:00Z", "how":"", "staffUserId":"", "mStaffName":"string", "mSatisfied":true, "comments":"" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "idKycCheck":"string", "customerNumber":"5987953", "date":"2020-01-27T00:00:00Z", "how":"", "staffUserId":"", "staffName":"", "satisfied":false, "comments":"" } }Required
Fields{ }Dependent
Endpoints
obp.createOrUpdateKycDocument
Create Or Update Kyc DocumentKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "id":"d8839721-ad8f-45dd-9f78-2080414b93f9", "customerNumber":"5987953", "type":"", "number":"", "issueDate":"2020-01-27T00:00:00Z", "issuePlace":"", "expiryDate":"2021-01-27T00:00:00Z" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "idKycDocument":"string", "customerNumber":"5987953", "type":"", "number":"", "issueDate":"2020-01-27T00:00:00Z", "issuePlace":"", "expiryDate":"2021-01-27T00:00:00Z" } }Required
Fields{ }Dependent
Endpoints
obp.createOrUpdateKycMedia
Create Or Update Kyc MediaKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "id":"d8839721-ad8f-45dd-9f78-2080414b93f9", "customerNumber":"5987953", "type":"", "url":"http://www.example.com/id-docs/123/image.png", "date":"2020-01-27T00:00:00Z", "relatesToKycDocumentId":"", "relatesToKycCheckId":"" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "idKycMedia":"string", "customerNumber":"5987953", "type":"", "url":"http://www.example.com/id-docs/123/image.png", "date":"2020-01-27T00:00:00Z", "relatesToKycDocumentId":"", "relatesToKycCheckId":"" } }Required
Fields{ }Dependent
Endpoints
obp.createOrUpdateKycStatus
Create Or Update Kyc StatusKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "ok":false, "date":"2020-01-27T00:00:00Z" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "ok":false, "date":"2020-01-27T00:00:00Z" } }Required
Fields{ }Dependent
Endpoints
obp.getKycChecks
Get Kyc ChecksKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "idKycCheck":"string", "customerNumber":"5987953", "date":"2020-01-27T00:00:00Z", "how":"", "staffUserId":"", "staffName":"", "satisfied":false, "comments":"" }] }Required
Fields{ }Dependent
Endpoints
obp.getKycDocuments
Get Kyc DocumentsKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "idKycDocument":"string", "customerNumber":"5987953", "type":"", "number":"", "issueDate":"2020-01-27T00:00:00Z", "issuePlace":"", "expiryDate":"2021-01-27T00:00:00Z" }] }Required
Fields{ }Dependent
Endpoints
obp.getKycMedias
Get Kyc MediasKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "idKycMedia":"string", "customerNumber":"5987953", "type":"", "url":"http://www.example.com/id-docs/123/image.png", "date":"2020-01-27T00:00:00Z", "relatesToKycDocumentId":"", "relatesToKycCheckId":"" }] }Required
Fields{ }Dependent
Endpoints
obp.getKycStatuses
Get Kyc StatusesKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "ok":false, "date":"2020-01-27T00:00:00Z" }] }Required
Fields{ }Dependent
Endpoints
obp.createMessage
Create MessageKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "user":{ "userPrimaryKey":{ "value":123 }, "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "idGivenByProvider":"string", "provider":"ETHEREUM", "emailAddress":"", "name":"felixsmith", "createdByConsentId":"string", "createdByUserInvitationId":"string", "isDeleted":true, "lastMarketingAgreementSignedDate":"2020-01-27T00:00:00Z" }, "bankId":{ "value":"gh.29.uk" }, "message":"123456", "fromDepartment":"Open Bank", "fromPerson":"Tom" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "messageId":"string", "date":"2020-01-27T00:00:00Z", "message":"123456", "fromDepartment":"Open Bank", "fromPerson":"Tom", "transport":"SMS" } }Required
Fields{ }Dependent
Endpoints
obp.makeHistoricalPayment
Make Historical PaymentKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "fromAccount":{ "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "accountType":"AC", "balance":"10", "currency":"EUR", "name":"bankAccount name string", "label":"My Account", "number":"bankAccount number string", "bankId":{ "value":"gh.29.uk" }, "lastUpdate":"2018-03-09T00:00:00Z", "branchId":"DERBY6", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "accountRules":[{ "scheme":"AccountRule scheme string", "value":"AccountRule value string" }], "accountHolder":"bankAccount accountHolder string", "attributes":[{ "name":"STATUS", "type":"STRING", "value":"closed" }] }, "toAccount":{ "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "accountType":"AC", "balance":"10", "currency":"EUR", "name":"bankAccount name string", "label":"My Account", "number":"bankAccount number string", "bankId":{ "value":"gh.29.uk" }, "lastUpdate":"2018-03-09T00:00:00Z", "branchId":"DERBY6", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "accountRules":[{ "scheme":"AccountRule scheme string", "value":"AccountRule value string" }], "accountHolder":"bankAccount accountHolder string", "attributes":[{ "name":"STATUS", "type":"STRING", "value":"closed" }] }, "posted":"2020-01-27T00:00:00Z", "completed":"2020-01-27T00:00:00Z", "amount":"10.12", "currency":"EUR", "description":"This an optional field. Maximum length is 2000. It can be any characters here.", "transactionRequestType":"SEPA", "chargePolicy":"SHARED" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "value":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub" } }Required
Fields{ }Dependent
Endpoints
obp.createDirectDebit
Create Direct DebitKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "bankId":"gh.29.uk", "accountId":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "counterpartyId":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh", "dateSigned":"2020-01-27T00:00:00Z", "dateStarts":"2020-01-27T00:00:00Z", "dateExpires":"2021-01-27T00:00:00Z" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":{ "directDebitId":"", "bankId":"gh.29.uk", "accountId":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "counterpartyId":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh", "dateSigned":"2020-01-27T00:00:00Z", "dateCancelled":"2020-01-27T00:00:00Z", "dateStarts":"2020-01-27T00:00:00Z", "dateExpires":"2021-01-27T00:00:00Z", "active":false } }Required
Fields{ }Dependent
Endpoints
obp.deleteCustomerAttribute
Delete Customer AttributeKafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "customerAttributeId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"Status errorCode", "backendMessages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }, "data":true }Required
Fields{ }Dependent
Endpoints
obp.dynamicEntityProcess
operate committed dynamic entity data, the available value of 'operation' can be: ["GET_ALL", "GET_ONE", "CREATE", "UPDATE", "DELETE"]Kafka/AkkaOutboundInboundTopicMessage{ "outboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }], "outboundAdapterAuthInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContext":[{ "key":"CustomerNumber", "value":"5987953" }], "authViews":[{ "view":{ "id":"owner", "name":"owner", "description":"This view is for the owner for the account." }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2018-03-09T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"felixsmith" }] } }] } }, "operation":"UPDATE", "entityName":"FooBar", "requestBody":{ "name":"James Brown", "number":1234567890 }, "entityId":"foobar-id-value" }{ "inboundAdapterCallContext":{ "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "generalContext":[{ "key":"CustomerNumber", "value":"5987953" }] }, "status":{ "errorCode":"status error code string", "backendMessages":[{ "source":"", "status":"Status string", "errorCode":"errorCode string", "text":"text string" }] }, "data":{ "name":"James Brown", "number":1234567890, "fooBarId":"foobar-id-value" } }Required
Fields{ }Dependent
Endpoints