-
Core
- obp.getAdapterInfo
- obp.validateAndCheckIbanNumber
- obp.getChallengeThreshold
- obp.getChargeLevel
- obp.getChargeLevelC2
- obp.createChallenge
- obp.createChallenges
- obp.createChallengesC2
- obp.validateChallengeAnswer
- obp.validateChallengeAnswerC2
- 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: stored_procedure_vDec2019
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
- OBPv3.0.0: getAdapterInfoForBank
- OBPv3.1.0: getAdapterInfo
- OBPv5.0.0: getAdapterInfo
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
- BGv1.3: cancelPayment
- BGv1.3: initiatePayment
- : cancelPayment
- : initiatePayment
- OBPv4.0.0: ibanChecker
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":"", "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
- OBPv2.1.0: answerTransactionRequestChallenge
- OBPv4.0.0: answerTransactionRequestChallenge
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":"", "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":"", "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":"", "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":"", "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
- UKv2.0: getAccountTransactions
- UKv3.1: getAccountsAccountIdTransactions
- UKv3.1: getTransactions
- STETv1.4: accountsBalancesGet
- STETv1.4: accountsGet
- STETv1.4: accountsTransactionsGet
- BGv1: getAccountList
- BGv1: getAccountBalances
- BGv1: getTransactionList
- BGv1.3: getCardAccountTransactionList
- BGv1.3: getTransactionList
- : getCardAccountTransactionList
- : getTransactionList
- OBPv1.2.1: deleteViewForBankAccount
- OBPv1.2.1: addPermissionForUserForBankAccountForMultipleViews
- OBPv1.2.1: addPermissionForUserForBankAccountForOneView
- OBPv1.2.1: removePermissionForUserForBankAccountForOneView
- OBPv1.2.1: removePermissionForUserForBankAccountForAllViews
- OBPv1.2.1: addCounterpartyPublicAlias
- OBPv1.2.1: updateCounterpartyPublicAlias
- OBPv1.2.1: deleteCounterpartyPublicAlias
- OBPv1.2.1: addOtherAccountPrivateAlias
- OBPv1.2.1: updateCounterpartyPrivateAlias
- OBPv1.2.1: deleteCounterpartyPrivateAlias
- OBPv1.2.1: addCounterpartyMoreInfo
- OBPv1.2.1: updateCounterpartyMoreInfo
- OBPv1.2.1: deleteCounterpartyMoreInfo
- OBPv1.2.1: addCounterpartyUrl
- OBPv1.2.1: updateCounterpartyUrl
- OBPv1.2.1: deleteCounterpartyUrl
- OBPv1.2.1: addCounterpartyImageUrl
- OBPv1.2.1: updateCounterpartyImageUrl
- OBPv1.2.1: deleteCounterpartyImageUrl
- OBPv1.2.1: addCounterpartyOpenCorporatesUrl
- OBPv1.2.1: updateCounterpartyOpenCorporatesUrl
- OBPv1.2.1: deleteCounterpartyOpenCorporatesUrl
- OBPv1.2.1: deleteCounterpartyCorporateLocation
- OBPv1.2.1: deleteCounterpartyPhysicalLocation
- OBPv1.4.0: addCustomerMessage
- OBPv1.4.0: getTransactionRequestTypes
- OBPv2.0.0: getPrivateAccountsAtOneBank
- OBPv2.0.0: corePrivateAccountsAtOneBank
- OBPv2.0.0: privateAccountsAtOneBank
- OBPv2.0.0: publicAccountsAtOneBank
- OBPv2.0.0: addKycDocument
- OBPv2.0.0: addKycMedia
- OBPv2.0.0: addKycCheck
- OBPv2.0.0: addKycStatus
- OBPv2.0.0: getPermissionsForBankAccount
- OBPv2.0.0: getTransactionTypes
- OBPv2.1.0: getTransactionRequestTypesSupportedByBank
- OBPv2.1.0: createTransactionRequestSandboxTan
- OBPv2.1.0: createTransactionRequestCounterparty
- OBPv2.1.0: createTransactionRequestSepa
- OBPv2.1.0: createTransactionRequestFreeForm
- OBPv2.1.0: answerTransactionRequestChallenge
- OBPv2.1.0: getEntitlementsByBankAndUser
- OBPv2.1.0: createTransactionType
- OBPv2.1.0: getCustomersForCurrentUserAtBank
- OBPv2.2.0: getCurrentFxRate
- OBPv2.2.0: createAccount
- OBPv2.2.0: createCounterparty
- OBPv3.0.0: getPermissionForUserForBankAccount
- OBPv3.0.0: getFirehoseAccountsAtOneBank
- OBPv3.0.0: getFirehoseTransactionsForBankAccount
- OBPv3.0.0: getCoreTransactionsForBankAccount
- OBPv3.0.0: getTransactionsForBankAccount
- OBPv3.0.0: getAdapterInfoForBank
- OBPv3.0.0: getBranch
- OBPv3.0.0: getBranches
- OBPv3.0.0: getAtm
- OBPv3.0.0: getAtms
- OBPv3.0.0: privateAccountsAtOneBank
- OBPv3.0.0: getPrivateAccountIdsbyBankId
- OBPv3.0.0: addEntitlementRequest
- OBPv3.0.0: getAccountsHeld
- OBPv3.0.0: bankById
- OBPv3.1.0: getCheckbookOrders
- OBPv3.1.0: getStatusOfCreditCardOrder
- OBPv3.1.0: getFirehoseCustomers
- OBPv3.1.0: checkFundsAvailable
- OBPv3.1.0: createAccountWebhook
- OBPv3.1.0: enableDisableAccountWebhook
- OBPv3.1.0: getAccountWebhooks
- OBPv3.1.0: getTransactionByIdForBankAccount
- OBPv3.1.0: getTransactionRequests
- OBPv3.1.0: createCustomer
- OBPv3.1.0: getCustomerByCustomerId
- OBPv3.1.0: getCustomerByCustomerNumber
- OBPv3.1.0: createTaxResidence
- OBPv3.1.0: getTaxResidence
- OBPv3.1.0: deleteTaxResidence
- OBPv3.1.0: createCustomerAddress
- OBPv3.1.0: updateCustomerAddress
- OBPv3.1.0: getCustomerAddresses
- OBPv3.1.0: deleteCustomerAddress
- OBPv3.1.0: createProductAttribute
- OBPv3.1.0: getProductAttribute
- OBPv3.1.0: updateProductAttribute
- OBPv3.1.0: deleteProductAttribute
- OBPv3.1.0: createAccountApplication
- OBPv3.1.0: getAccountApplications
- OBPv3.1.0: getAccountApplication
- OBPv3.1.0: updateAccountApplicationStatus
- OBPv3.1.0: createProduct
- OBPv3.1.0: getProduct
- OBPv3.1.0: getProductTree
- OBPv3.1.0: getProducts
- OBPv3.1.0: createAccountAttribute
- OBPv3.1.0: updateAccountAttribute
- OBPv3.1.0: createProductCollection
- OBPv3.1.0: getProductCollection
- OBPv3.1.0: deleteBranch
- OBPv3.1.0: createMeeting
- OBPv3.1.0: getMeetings
- OBPv3.1.0: getMeeting
- OBPv3.1.0: createConsentEmail
- OBPv3.1.0: createConsentSms
- OBPv3.1.0: answerConsentChallenge
- OBPv3.1.0: getConsents
- OBPv3.1.0: revokeConsent
- OBPv3.1.0: createUserAuthContextUpdateRequest
- OBPv3.1.0: updateCustomerEmail
- OBPv3.1.0: updateCustomerNumber
- OBPv3.1.0: updateCustomerMobileNumber
- OBPv3.1.0: updateCustomerIdentity
- OBPv3.1.0: updateCustomerCreditLimit
- OBPv3.1.0: updateCustomerCreditRatingAndSource
- OBPv3.1.0: updateAccount
- OBPv3.1.0: getCardsForBank
- OBPv3.1.0: getCardForBank
- OBPv3.1.0: deleteCardForBank
- OBPv3.1.0: createCardAttribute
- OBPv3.1.0: updateCardAttribute
- OBPv3.1.0: updateCustomerBranch
- OBPv3.1.0: updateCustomerData
- OBPv3.1.0: createAccount
- OBPv3.1.0: saveHistoricalTransaction
- OBPv3.1.0: getBankAccountsBalances
- OBPv4.0.0: getBank
- OBPv4.0.0: createSettlementAccount
- OBPv4.0.0: addAccount
- OBPv4.0.0: createProductAttribute
- OBPv4.0.0: updateProductAttribute
- OBPv4.0.0: getProductAttribute
- OBPv4.0.0: createBankAttribute
- OBPv4.0.0: updateBankAttribute
- OBPv4.0.0: deleteBankAttribute
- OBPv4.0.0: createCounterparty
- OBPv4.0.0: createCounterpartyForAnyAccount
- OBPv4.0.0: getProducts
- OBPv5.0.0: getBank
- OBPv5.0.0: updateBank
- OBPv5.0.0: createAccount
- OBPv5.0.0: getMyCustomersAtBank
- OBPv5.1.0: getCurrenciesAtBank
- OBPv5.1.0: revokeConsentAtBank
- OBPv5.1.0: getAtm
- OBPv5.0.0: createUserAuthContextUpdateRequest
- OBPv5.0.0: answerUserAuthContextUpdateChallenge
- OBPv5.0.0: headAtms
- OBPv5.0.0: createCustomer
- OBPv5.0.0: createProduct
- OBPv5.0.0: addCardForBank
- OBPv5.0.0: createCustomerAccountLink
- OBPv5.0.0: getCustomerAccountLinksByCustomerId
- OBPv5.0.0: getCustomerAccountLinksByBankIdAccountId
- OBPv5.0.0: getCustomerAccountLinkById
- OBPv5.0.0: updateCustomerAccountLinkById
- OBPv5.0.0: deleteCustomerAccountLinkById
- OBPv4.0.0: getDoubleEntryTransaction
- OBPv4.0.0: getSettlementAccounts
- OBPv4.0.0: createTransactionRequestAccount
- OBPv4.0.0: createTransactionRequestAccountOtp
- OBPv4.0.0: createTransactionRequestCounterparty
- OBPv4.0.0: createTransactionRequestSimple
- OBPv4.0.0: createTransactionRequestSepa
- OBPv4.0.0: createTransactionRequestRefund
- OBPv4.0.0: createTransactionRequestFreeForm
- OBPv4.0.0: answerTransactionRequestChallenge
- OBPv4.0.0: createTransactionRequestAttribute
- OBPv4.0.0: getTransactionRequestAttributeById
- OBPv4.0.0: getTransactionRequestAttributes
- OBPv4.0.0: updateTransactionRequestAttribute
- OBPv4.0.0: createOrUpdateTransactionRequestAttributeDefinition
- OBPv4.0.0: getTransactionRequestAttributeDefinition
- OBPv4.0.0: deleteTransactionRequestAttributeDefinition
- OBPv4.0.0: getBankLevelDynamicEntities
- OBPv4.0.0: deleteBankLevelDynamicEntity
- OBPv4.0.0: updateAccountLabel
- OBPv4.0.0: addTagForViewOnAccount
- OBPv4.0.0: deleteTagForViewOnAccount
- OBPv4.0.0: getTagsForViewOnAccount
- OBPv4.0.0: getPrivateAccountByIdFull
- OBPv4.0.0: getBankAccountsBalances
- OBPv4.0.0: getBankAccountBalances
- OBPv4.0.0: getFirehoseAccountsAtOneBank
- OBPv4.0.0: getFastFirehoseAccountsAtOneBank
- OBPv4.0.0: createUserInvitation
- OBPv4.0.0: getUserInvitationAnonymous
- OBPv4.0.0: getUserInvitation
- OBPv4.0.0: getUserInvitations
- OBPv4.0.0: createDirectDebit
- OBPv4.0.0: createDirectDebitManagement
- OBPv4.0.0: createStandingOrder
- OBPv4.0.0: createStandingOrderManagement
- OBPv4.0.0: createCustomerAttribute
- OBPv4.0.0: updateCustomerAttribute
- OBPv4.0.0: getCustomerAttributes
- OBPv4.0.0: getCustomerAttributeById
- OBPv4.0.0: createTransactionAttribute
- OBPv4.0.0: updateTransactionAttribute
- OBPv4.0.0: getTransactionAttributes
- OBPv4.0.0: getTransactionAttributeById
- OBPv4.0.0: createHistoricalTransactionAtBank
- OBPv4.0.0: getTransactionRequest
- OBPv4.0.0: getPrivateAccountsAtOneBank
- OBPv4.0.0: deleteCustomerAttribute
- OBPv4.0.0: createBankLevelDynamicEndpoint
- OBPv4.0.0: updateBankLevelDynamicEndpointHost
- OBPv4.0.0: getBankLevelDynamicEndpoint
- OBPv4.0.0: getBankLevelDynamicEndpoints
- OBPv4.0.0: deleteBankLevelDynamicEndpoint
- OBPv4.0.0: createOrUpdateCustomerAttributeAttributeDefinition
- OBPv4.0.0: createOrUpdateAccountAttributeDefinition
- OBPv4.0.0: createOrUpdateProductAttributeDefinition
- OBPv4.0.0: createProductFee
- OBPv4.0.0: updateProductFee
- OBPv4.0.0: getProductFee
- OBPv4.0.0: getProductFees
- OBPv4.0.0: deleteProductFee
- OBPv4.0.0: createOrUpdateBankAttributeDefinition
- OBPv4.0.0: getBankAttributes
- OBPv4.0.0: getBankAttribute
- OBPv4.0.0: createOrUpdateTransactionAttributeDefinition
- OBPv4.0.0: createOrUpdateCardAttributeDefinition
- OBPv4.0.0: deleteTransactionAttributeDefinition
- OBPv4.0.0: deleteCustomerAttributeDefinition
- OBPv4.0.0: deleteAccountAttributeDefinition
- OBPv4.0.0: deleteProductAttributeDefinition
- OBPv4.0.0: deleteCardAttributeDefinition
- OBPv4.0.0: getProductAttributeDefinition
- OBPv4.0.0: getCustomerAttributeDefinition
- OBPv4.0.0: getAccountAttributeDefinition
- OBPv4.0.0: getTransactionAttributeDefinition
- OBPv4.0.0: getCardAttributeDefinition
- OBPv4.0.0: deleteUserCustomerLink
- OBPv4.0.0: getUserCustomerLinksByUserId
- OBPv4.0.0: createUserCustomerLinks
- OBPv4.0.0: getUserCustomerLinksByCustomerId
- OBPv4.0.0: getCorrelatedUsersInfoByCustomerId
- OBPv4.0.0: deleteTransactionCascade
- OBPv4.0.0: deleteAccountCascade
- OBPv4.0.0: deleteBankCascade
- OBPv4.0.0: deleteProductCascade
- OBPv4.0.0: deleteCustomerCascade
- OBPv4.0.0: deleteExplicitCounterparty
- OBPv4.0.0: deleteCounterpartyForAnyAccount
- OBPv4.0.0: getExplictCounterpartiesForAccount
- OBPv4.0.0: getCounterpartiesForAnyAccount
- OBPv4.0.0: getExplictCounterpartyById
- OBPv4.0.0: getCounterpartyByNameForAnyAccount
- OBPv4.0.0: getCounterpartyByIdForAnyAccount
- OBPv4.0.0: addConsentUser
- OBPv4.0.0: updateConsentStatus
- OBPv4.0.0: getConsents
- OBPv4.0.0: getConsentInfos
- OBPv4.0.0: createBankLevelDynamicResourceDoc
- OBPv4.0.0: updateBankLevelDynamicResourceDoc
- OBPv4.0.0: deleteBankLevelDynamicResourceDoc
- OBPv4.0.0: getBankLevelDynamicResourceDoc
- OBPv4.0.0: getAllBankLevelDynamicResourceDocs
- OBPv4.0.0: createBankLevelDynamicMessageDoc
- OBPv4.0.0: updateBankLevelDynamicMessageDoc
- OBPv4.0.0: getBankLevelDynamicMessageDoc
- OBPv4.0.0: getAllBankLevelDynamicMessageDocs
- OBPv4.0.0: deleteBankLevelDynamicMessageDoc
- OBPv4.0.0: createBankLevelEndpointMapping
- OBPv4.0.0: updateBankLevelEndpointMapping
- OBPv4.0.0: getBankLevelEndpointMapping
- OBPv4.0.0: getAllBankLevelEndpointMappings
- OBPv4.0.0: deleteBankLevelEndpointMapping
- OBPv4.0.0: getAtms
- OBPv4.0.0: createBankLevelEndpointTag
- OBPv4.0.0: updateBankLevelEndpointTag
- OBPv4.0.0: getBankLevelEndpointTags
- OBPv4.0.0: deleteBankLevelEndpointTag
- OBPv4.0.0: getProduct
- OBPv4.0.0: createCustomerMessage
- OBPv4.0.0: getCustomerMessages
- OBPv4.0.0: createBankAccountNotificationWebhook
- OBPv4.0.0: createBankLevelDynamicEntity
- OBPv4.0.0: updateBankLevelDynamicEntity
- OBPv5.1.0: createAtmAttribute
- OBPv5.1.0: getAtmAttributes
- OBPv5.1.0: getAtmAttribute
- OBPv5.1.0: updateAtmAttribute
- OBPv5.1.0: deleteAtmAttribute
- OBPv5.1.0: getAtms
- OBPv4.0.0: getCustomersByAttributes
- OBPv4.0.0: createCustomer
- OBPv4.0.0: createProduct
- OBPv1.4.0: getBankLevelDynamicResourceDocsObp
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
- CNBV9v1.0.0: getMxAtms
- MXOFv1.0.0: getMxAtms
- OBPv3.0.0: getBanks
- OBPv4.0.0: getBanks
- OBPv5.0.0: createBank
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
- UKv2.0: getAccountList
- UKv2.0: getAccountTransactions
- UKv2.0: getAccount
- UKv2.0: getAccountBalances
- UKv2.0: getBalances
- UKv3.1: createAccountAccessConsents
- UKv3.1: deleteAccountAccessConsentsConsentId
- UKv3.1: getAccountAccessConsentsConsentId
- UKv3.1: getAccounts
- UKv3.1: getAccountsAccountId
- UKv3.1: getAccountsAccountIdBalances
- UKv3.1: getBalances
- UKv3.1: getAccountsAccountIdBeneficiaries
- UKv3.1: getBeneficiaries
- UKv3.1: getAccountsAccountIdDirectDebits
- UKv3.1: getDirectDebits
- UKv3.1: createDomesticPaymentConsents
- UKv3.1: createDomesticPayments
- UKv3.1: getDomesticPaymentConsentsConsentId
- UKv3.1: getDomesticPaymentConsentsConsentIdFundsConfirmation
- UKv3.1: getDomesticPaymentsDomesticPaymentId
- UKv3.1: createDomesticScheduledPaymentConsents
- UKv3.1: createDomesticScheduledPayments
- UKv3.1: getDomesticScheduledPaymentConsentsConsentId
- UKv3.1: getDomesticScheduledPaymentsDomesticScheduledPaymentId
- UKv3.1: createDomesticStandingOrderConsents
- UKv3.1: createDomesticStandingOrders
- UKv3.1: getDomesticStandingOrderConsentsConsentId
- UKv3.1: getDomesticStandingOrdersDomesticStandingOrderId
- UKv3.1: createFilePaymentConsents
- UKv3.1: createFilePaymentConsentsConsentIdFile
- UKv3.1: createFilePayments
- UKv3.1: getFilePaymentConsentsConsentId
- UKv3.1: getFilePaymentConsentsConsentIdFile
- UKv3.1: getFilePaymentsFilePaymentId
- UKv3.1: getFilePaymentsFilePaymentIdReportFile
- UKv3.1: createFundsConfirmationConsents
- UKv3.1: createFundsConfirmations
- UKv3.1: deleteFundsConfirmationConsentsConsentId
- UKv3.1: getFundsConfirmationConsentsConsentId
- UKv3.1: createInternationalPaymentConsents
- UKv3.1: createInternationalPayments
- UKv3.1: getInternationalPaymentConsentsConsentId
- UKv3.1: getInternationalPaymentConsentsConsentIdFundsConfirmation
- UKv3.1: getInternationalPaymentsInternationalPaymentId
- UKv3.1: createInternationalScheduledPaymentConsents
- UKv3.1: createInternationalScheduledPayments
- UKv3.1: getInternationalScheduledPaymentConsentsConsentId
- UKv3.1: getInternationalScheduledPaymentConsentsConsentIdFundsConfirmation
- UKv3.1: getInternationalScheduledPaymentsInternationalScheduledPaymentId
- UKv3.1: createInternationalStandingOrderConsents
- UKv3.1: createInternationalStandingOrders
- UKv3.1: getInternationalStandingOrderConsentsConsentId
- UKv3.1: getInternationalStandingOrdersInternationalStandingOrderPaymentId
- UKv3.1: getAccountsAccountIdOffers
- UKv3.1: getOffers
- UKv3.1: getAccountsAccountIdParty
- UKv3.1: getParty
- UKv3.1: getAccountsAccountIdProduct
- UKv3.1: getProducts
- UKv3.1: getAccountsAccountIdScheduledPayments
- UKv3.1: getScheduledPayments
- UKv3.1: getAccountsAccountIdStandingOrders
- UKv3.1: getStandingOrders
- UKv3.1: getAccountsAccountIdStatements
- UKv3.1: getAccountsAccountIdStatementsStatementId
- UKv3.1: getAccountsAccountIdStatementsStatementIdFile
- UKv3.1: getAccountsAccountIdStatementsStatementIdTransactions
- UKv3.1: getStatements
- UKv3.1: getAccountsAccountIdTransactions
- UKv3.1: getTransactions
- BAHRAIN-OBFv1.0.0: domesticFutureDatedPaymentCancellationConsentsConsentIdGet
- BAHRAIN-OBFv1.0.0: domesticFutureDatedPaymentCancellationConsentsPost
- BAHRAIN-OBFv1.0.0: domesticFutureDatedPaymentConsentsConsentIdGet
- BAHRAIN-OBFv1.0.0: domesticFutureDatedPaymentConsentsPost
- BAHRAIN-OBFv1.0.0: domesticFutureDatedPaymentsDomesticFutureDatedPaymentIdGet
- BAHRAIN-OBFv1.0.0: domesticFutureDatedPaymentsDomesticFutureDatedPaymentIdPatch
- BAHRAIN-OBFv1.0.0: domesticFutureDatedPaymentsDomesticFutureDatedPaymentIdPaymentDetailsGet
- BAHRAIN-OBFv1.0.0: domesticFutureDatedPaymentsPost
- BAHRAIN-OBFv1.0.0: domesticPaymentsDomesticPaymentIdGet
- BAHRAIN-OBFv1.0.0: domesticPaymentsDomesticPaymentIdPaymentDetailsGet
- BAHRAIN-OBFv1.0.0: domesticPaymentsPost
- BAHRAIN-OBFv1.0.0: domesticPaymentConsentsConsentIdFundsConfirmationGet
- BAHRAIN-OBFv1.0.0: domesticPaymentConsentsConsentIdGet
- BAHRAIN-OBFv1.0.0: domesticPaymentConsentsPost
- BAHRAIN-OBFv1.0.0: filePaymentConsentsConsentIdFileGet
- BAHRAIN-OBFv1.0.0: filePaymentConsentsConsentIdFilePost
- BAHRAIN-OBFv1.0.0: filePaymentConsentsConsentIdGet
- BAHRAIN-OBFv1.0.0: filePaymentConsentsPost
- BAHRAIN-OBFv1.0.0: filePaymentsFilePaymentIdGet
- BAHRAIN-OBFv1.0.0: filePaymentsFilePaymentIdPaymentDetailsGet
- BAHRAIN-OBFv1.0.0: filePaymentsFilePaymentIdReportFileGet
- BAHRAIN-OBFv1.0.0: filePaymentsPost
- BAHRAIN-OBFv1.0.0: internationalPaymentConsentsConsentIdFundsConfirmationGet
- BAHRAIN-OBFv1.0.0: internationalPaymentConsentsConsentIdGet
- BAHRAIN-OBFv1.0.0: internationalPaymentConsentsPost
- BAHRAIN-OBFv1.0.0: internationalPaymentsInternationalPaymentIdGet
- BAHRAIN-OBFv1.0.0: internationalPaymentsInternationalPaymentIdPaymentDetailsGet
- BAHRAIN-OBFv1.0.0: internationalPaymentsPost
- BAHRAIN-OBFv1.0.0: accountAccessConsentsConsentIdGet
- BAHRAIN-OBFv1.0.0: accountAccessConsentsConsentIdPatch
- BAHRAIN-OBFv1.0.0: accountAccessConsentsPost
- BAHRAIN-OBFv1.0.0: accountsAccountIdGet
- BAHRAIN-OBFv1.0.0: accountsGet
- BAHRAIN-OBFv1.0.0: accountsAccountIdBalancesGet
- BAHRAIN-OBFv1.0.0: balancesGet
- BAHRAIN-OBFv1.0.0: accountsAccountIdBeneficiariesGet
- BAHRAIN-OBFv1.0.0: beneficiariesGet
- BAHRAIN-OBFv1.0.0: accountsAccountIdDirectDebitsGet
- BAHRAIN-OBFv1.0.0: directDebitsGet
- BAHRAIN-OBFv1.0.0: accountsAccountIdFutureDatedPaymentsGet
- BAHRAIN-OBFv1.0.0: futureDatedPaymentsGet
- BAHRAIN-OBFv1.0.0: accountsAccountIdOffersGet
- BAHRAIN-OBFv1.0.0: offersGet
- BAHRAIN-OBFv1.0.0: accountsAccountIdPartiesGet
- BAHRAIN-OBFv1.0.0: accountsAccountIdPartyGet
- BAHRAIN-OBFv1.0.0: partyGet
- BAHRAIN-OBFv1.0.0: accountsAccountIdStandingOrdersGet
- BAHRAIN-OBFv1.0.0: standingOrdersGet
- BAHRAIN-OBFv1.0.0: accountsAccountIdStatementsGet
- BAHRAIN-OBFv1.0.0: accountsAccountIdStatementsStatementIdFileGet
- BAHRAIN-OBFv1.0.0: accountsAccountIdStatementsStatementIdGet
- BAHRAIN-OBFv1.0.0: accountsAccountIdStatementsStatementIdTransactionsGet
- BAHRAIN-OBFv1.0.0: statementsGet
- BAHRAIN-OBFv1.0.0: accountsAccountIdSupplementaryAccountInfoGet
- BAHRAIN-OBFv1.0.0: accountsAccountIdTransactionsGet
- BAHRAIN-OBFv1.0.0: transactionsGet
- BAHRAIN-OBFv1.0.0: eventNotificationsPost
- STETv1.4: accountsBalancesGet
- STETv1.4: accountsGet
- STETv1.4: accountsTransactionsGet
- STETv1.4: consentsPut
- STETv1.4: endUserIdentityGet
- STETv1.4: trustedBeneficiariesGet
- STETv1.4: fundsConfirmationsPost
- STETv1.4: paymentRequestConfirmationPost
- STETv1.4: paymentRequestPut
- STETv1.4: paymentRequestsGet
- STETv1.4: paymentRequestsPost
- AUv1.0.0: getAccountDetail
- AUv1.0.0: getTransactionDetail
- AUv1.0.0: getTransactions
- AUv1.0.0: listBalancesBulk
- AUv1.0.0: listBalancesSpecificAccounts
- AUv1.0.0: getPayeeDetail
- AUv1.0.0: getProductDetail
- AUv1.0.0: listAccounts
- AUv1.0.0: listBalance
- AUv1.0.0: listDirectDebits
- AUv1.0.0: listDirectDebitsBulk
- AUv1.0.0: listDirectDebitsSpecificAccounts
- AUv1.0.0: listPayees
- AUv1.0.0: listProducts
- AUv1.0.0: listScheduledPayments
- AUv1.0.0: listScheduledPaymentsBulk
- AUv1.0.0: listScheduledPaymentsSpecificAccounts
- AUv1.0.0: getCustomer
- AUv1.0.0: getCustomerDetail
- AUv1.0.0: getOutages
- AUv1.0.0: getStatus
- PAPIv2.1.1.1: deleteConsent
- PAPIv2.1.1.1: getAccount
- PAPIv2.1.1.1: getAccounts
- PAPIv2.1.1.1: getHolds
- PAPIv2.1.1.1: getTransactionDetail
- PAPIv2.1.1.1: getTransactionsCancelled
- PAPIv2.1.1.1: getTransactionsDone
- PAPIv2.1.1.1: getTransactionsPending
- PAPIv2.1.1.1: getTransactionsRejected
- PAPIv2.1.1.1: getTransactionsScheduled
- PAPIv2.1.1.1: authorize
- PAPIv2.1.1.1: authorizeExt
- PAPIv2.1.1.1: token
- PAPIv2.1.1.1: getConfirmationOfFunds
- PAPIv2.1.1.1: bundle
- PAPIv2.1.1.1: cancelPayments
- PAPIv2.1.1.1: cancelRecurringPayment
- PAPIv2.1.1.1: domestic
- PAPIv2.1.1.1: eEA
- PAPIv2.1.1.1: getBundle
- PAPIv2.1.1.1: getMultiplePayments
- PAPIv2.1.1.1: getPayment
- PAPIv2.1.1.1: getRecurringPayment
- PAPIv2.1.1.1: nonEEA
- PAPIv2.1.1.1: recurring
- PAPIv2.1.1.1: tax
- CNBV9v1.0.0: getMxAtms
- CNBV9v1.0.0: headMxAtms
- MXOFv1.0.0: getMxAtms
- MXOFv1.0.0: headMxAtms
- BGv1: getAccountList
- BGv1: getAccountBalances
- BGv1: getTransactionList
- BGv1.3: createConsent
- BGv1.3: deleteConsent
- BGv1.3: getAccountList
- BGv1.3: getBalances
- BGv1.3: getCardAccounts
- BGv1.3: getCardAccountBalances
- BGv1.3: getCardAccountTransactionList
- BGv1.3: getConsentAuthorisation
- BGv1.3: getConsentInformation
- BGv1.3: getConsentScaStatus
- BGv1.3: getConsentStatus
- BGv1.3: getTransactionDetails
- BGv1.3: getTransactionList
- BGv1.3: readAccountDetails
- BGv1.3: readCardAccount
- BGv1.3: startConsentAuthorisation
- BGv1.3: updateConsentsPsuData
- BGv1.3: checkAvailabilityOfFunds
- BGv1.3: cancelPayment
- BGv1.3: getPaymentCancellationScaStatus
- BGv1.3: getPaymentInformation
- BGv1.3: getPaymentInitiationAuthorisation
- BGv1.3: getPaymentInitiationCancellationAuthorisationInformation
- BGv1.3: getPaymentInitiationScaStatus
- BGv1.3: getPaymentInitiationStatus
- BGv1.3: initiatePayment
- BGv1.3: startPaymentAuthorisation
- BGv1.3: startPaymentInitiationCancellationAuthorisation
- BGv1.3: updatePaymentCancellationPsuData
- BGv1.3: updatePaymentPsuData
- BGv1.3: createSigningBasket
- BGv1.3: deleteSigningBasket
- BGv1.3: getSigningBasket
- BGv1.3: getSigningBasketAuthorisation
- BGv1.3: getSigningBasketScaStatus
- BGv1.3: getSigningBasketStatus
- BGv1.3: startSigningBasketAuthorisation
- BGv1.3: updateSigningBasketPsuData
- : createConsent
- : deleteConsent
- : getAccountList
- : getBalances
- : getCardAccounts
- : getCardAccountBalances
- : getCardAccountTransactionList
- : getConsentAuthorisation
- : getConsentInformation
- : getConsentScaStatus
- : getConsentStatus
- : getTransactionDetails
- : getTransactionList
- : readAccountDetails
- : readCardAccount
- : startConsentAuthorisation
- : updateConsentsPsuData
- : checkAvailabilityOfFunds
- : cancelPayment
- : getPaymentCancellationScaStatus
- : getPaymentInformation
- : getPaymentInitiationAuthorisation
- : getPaymentInitiationCancellationAuthorisationInformation
- : getPaymentInitiationScaStatus
- : getPaymentInitiationStatus
- : initiatePayment
- : startPaymentAuthorisation
- : startPaymentInitiationCancellationAuthorisation
- : updatePaymentCancellationPsuData
- : updatePaymentPsuData
- : createSigningBasket
- : deleteSigningBasket
- : getSigningBasket
- : getSigningBasketAuthorisation
- : getSigningBasketScaStatus
- : getSigningBasketStatus
- : startSigningBasketAuthorisation
- : updateSigningBasketPsuData
- OBPv1.3.0: getCards
- OBPv1.2.1: updateAccountLabel
- OBPv1.2.1: deleteViewForBankAccount
- OBPv1.2.1: addPermissionForUserForBankAccountForMultipleViews
- OBPv1.2.1: addPermissionForUserForBankAccountForOneView
- OBPv1.2.1: removePermissionForUserForBankAccountForOneView
- OBPv1.2.1: removePermissionForUserForBankAccountForAllViews
- OBPv1.2.1: getOtherAccountMetadata
- OBPv1.2.1: getCounterpartyPublicAlias
- OBPv1.2.1: addCounterpartyPublicAlias
- OBPv1.2.1: updateCounterpartyPublicAlias
- OBPv1.2.1: deleteCounterpartyPublicAlias
- OBPv1.2.1: getOtherAccountPrivateAlias
- OBPv1.2.1: addOtherAccountPrivateAlias
- OBPv1.2.1: updateCounterpartyPrivateAlias
- OBPv1.2.1: deleteCounterpartyPrivateAlias
- OBPv1.2.1: addCounterpartyMoreInfo
- OBPv1.2.1: updateCounterpartyMoreInfo
- OBPv1.2.1: deleteCounterpartyMoreInfo
- OBPv1.2.1: addCounterpartyUrl
- OBPv1.2.1: updateCounterpartyUrl
- OBPv1.2.1: deleteCounterpartyUrl
- OBPv1.2.1: addCounterpartyImageUrl
- OBPv1.2.1: updateCounterpartyImageUrl
- OBPv1.2.1: deleteCounterpartyImageUrl
- OBPv1.2.1: addCounterpartyOpenCorporatesUrl
- OBPv1.2.1: updateCounterpartyOpenCorporatesUrl
- OBPv1.2.1: deleteCounterpartyOpenCorporatesUrl
- OBPv1.2.1: deleteCounterpartyCorporateLocation
- OBPv1.2.1: deleteCounterpartyPhysicalLocation
- OBPv1.2.1: getTransactionNarrative
- OBPv1.2.1: addTransactionNarrative
- OBPv1.2.1: updateTransactionNarrative
- OBPv1.2.1: deleteTransactionNarrative
- OBPv1.2.1: getCommentsForViewOnTransaction
- OBPv1.2.1: addCommentForViewOnTransaction
- OBPv1.2.1: deleteCommentForViewOnTransaction
- OBPv1.2.1: getTagsForViewOnTransaction
- OBPv1.2.1: addTagForViewOnTransaction
- OBPv1.2.1: deleteTagForViewOnTransaction
- OBPv1.2.1: getImagesForViewOnTransaction
- OBPv1.2.1: addImageForViewOnTransaction
- OBPv1.2.1: deleteImageForViewOnTransaction
- OBPv1.2.1: getWhereTagForViewOnTransaction
- OBPv1.2.1: addWhereTagForViewOnTransaction
- OBPv1.2.1: updateWhereTagForViewOnTransaction
- OBPv1.2.1: deleteWhereTagForViewOnTransaction
- OBPv1.2.1: getOtherAccountForTransaction
- OBPv1.4.0: addCustomerMessage
- OBPv1.4.0: getTransactionRequestTypes
- OBPv2.0.0: getPrivateAccountsAtOneBank
- OBPv2.0.0: corePrivateAccountsAtOneBank
- OBPv2.0.0: privateAccountsAtOneBank
- OBPv2.0.0: publicAccountsAtOneBank
- OBPv2.0.0: getKycDocuments
- OBPv2.0.0: getKycMedia
- OBPv2.0.0: getKycChecks
- OBPv2.0.0: getKycStatuses
- OBPv2.0.0: addKycDocument
- OBPv2.0.0: addKycMedia
- OBPv2.0.0: addKycCheck
- OBPv2.0.0: addKycStatus
- OBPv2.0.0: getPermissionsForBankAccount
- OBPv2.0.0: createAccount
- OBPv2.0.0: getTransactionTypes
- OBPv2.0.0: createUserCustomerLinks
- OBPv2.0.0: addEntitlement
- OBPv2.0.0: deleteEntitlement
- OBPv2.0.0: getAllEntitlements
- OBPv2.1.0: getTransactionRequestTypesSupportedByBank
- OBPv2.1.0: createTransactionRequestSandboxTan
- OBPv2.1.0: createTransactionRequestCounterparty
- OBPv2.1.0: createTransactionRequestSepa
- OBPv2.1.0: createTransactionRequestFreeForm
- OBPv2.1.0: answerTransactionRequestChallenge
- OBPv2.1.0: getRoles
- OBPv2.1.0: getEntitlementsByBankAndUser
- OBPv2.1.0: addCardsForBank
- OBPv2.1.0: getUsers
- OBPv2.1.0: createTransactionType
- OBPv2.1.0: getCustomersForCurrentUserAtBank
- OBPv2.1.0: getMetrics
- OBPv2.2.0: getViewsForBankAccount
- OBPv2.2.0: getCurrentFxRate
- OBPv2.2.0: getExplictCounterpartiesForAccount
- OBPv2.2.0: getExplictCounterpartyById
- OBPv2.2.0: createAccount
- OBPv2.2.0: config
- OBPv2.2.0: getConnectorMetrics
- OBPv2.2.0: createCounterparty
- OBPv3.0.0: getViewsForBankAccount
- OBPv3.0.0: createViewForBankAccount
- OBPv3.0.0: getPermissionForUserForBankAccount
- OBPv3.0.0: updateViewForBankAccount
- OBPv3.0.0: getPrivateAccountById
- OBPv3.0.0: getCoreAccountById
- OBPv3.0.0: corePrivateAccountsAllBanks
- OBPv3.0.0: getFirehoseAccountsAtOneBank
- OBPv3.0.0: getFirehoseTransactionsForBankAccount
- OBPv3.0.0: getCoreTransactionsForBankAccount
- OBPv3.0.0: getTransactionsForBankAccount
- OBPv3.0.0: dataWarehouseSearch
- OBPv3.0.0: dataWarehouseStatistics
- OBPv3.0.0: getUser
- OBPv3.0.0: getUserByUserId
- OBPv3.0.0: getUserByUsername
- OBPv3.0.0: getAdapterInfoForBank
- OBPv3.0.0: getBranch
- OBPv3.0.0: getBranches
- OBPv3.0.0: getAtm
- OBPv3.0.0: getAtms
- OBPv3.0.0: getUsers
- OBPv3.0.0: getCustomersForUser
- OBPv3.0.0: getCurrentUser
- OBPv3.0.0: privateAccountsAtOneBank
- OBPv3.0.0: getPrivateAccountIdsbyBankId
- OBPv3.0.0: getOtherAccountsForBankAccount
- OBPv3.0.0: getOtherAccountByIdForBankAccount
- OBPv3.0.0: addEntitlementRequest
- OBPv3.0.0: getAllEntitlementRequests
- OBPv3.0.0: getEntitlementRequests
- OBPv3.0.0: getEntitlementRequestsForCurrentUser
- OBPv3.0.0: deleteEntitlementRequest
- OBPv3.0.0: getEntitlementsForCurrentUser
- OBPv3.0.0: getApiGlossary
- OBPv3.0.0: getAccountsHeld
- OBPv3.0.0: getAggregateMetrics
- OBPv3.0.0: addScope
- OBPv3.0.0: deleteScope
- OBPv3.0.0: getScopes
- OBPv3.0.0: getBanks
- OBPv3.1.0: getCheckbookOrders
- OBPv3.1.0: getStatusOfCreditCardOrder
- OBPv3.1.0: getTopAPIs
- OBPv3.1.0: getMetricsTopConsumers
- OBPv3.1.0: getFirehoseCustomers
- OBPv3.1.0: getBadLoginStatus
- OBPv3.1.0: unlockUser
- OBPv3.1.0: callsLimit
- OBPv3.1.0: getCallsLimit
- OBPv3.1.0: checkFundsAvailable
- OBPv3.1.0: getConsumer
- OBPv3.1.0: getConsumersForCurrentUser
- OBPv3.1.0: getConsumers
- OBPv3.1.0: createAccountWebhook
- OBPv3.1.0: enableDisableAccountWebhook
- OBPv3.1.0: getAccountWebhooks
- OBPv3.1.0: config
- OBPv3.1.0: getAdapterInfo
- OBPv3.1.0: getTransactionByIdForBankAccount
- OBPv3.1.0: getTransactionRequests
- OBPv3.1.0: createCustomer
- OBPv3.1.0: getRateLimitingInfo
- OBPv3.1.0: getCustomerByCustomerId
- OBPv3.1.0: getCustomerByCustomerNumber
- OBPv3.1.0: createUserAuthContext
- OBPv3.1.0: getUserAuthContexts
- OBPv3.1.0: deleteUserAuthContexts
- OBPv3.1.0: deleteUserAuthContextById
- OBPv3.1.0: createTaxResidence
- OBPv3.1.0: getTaxResidence
- OBPv3.1.0: deleteTaxResidence
- OBPv3.1.0: getAllEntitlements
- OBPv3.1.0: createCustomerAddress
- OBPv3.1.0: updateCustomerAddress
- OBPv3.1.0: getCustomerAddresses
- OBPv3.1.0: deleteCustomerAddress
- OBPv3.1.0: getObpConnectorLoopback
- OBPv3.1.0: refreshUser
- OBPv3.1.0: createProductAttribute
- OBPv3.1.0: getProductAttribute
- OBPv3.1.0: updateProductAttribute
- OBPv3.1.0: deleteProductAttribute
- OBPv3.1.0: createAccountApplication
- OBPv3.1.0: getAccountApplications
- OBPv3.1.0: getAccountApplication
- OBPv3.1.0: updateAccountApplicationStatus
- OBPv3.1.0: createProduct
- OBPv3.1.0: getProduct
- OBPv3.1.0: getProductTree
- OBPv3.1.0: getProducts
- OBPv3.1.0: createAccountAttribute
- OBPv3.1.0: updateAccountAttribute
- OBPv3.1.0: createProductCollection
- OBPv3.1.0: getProductCollection
- OBPv3.1.0: deleteBranch
- OBPv3.1.0: createMeeting
- OBPv3.1.0: getMeetings
- OBPv3.1.0: getMeeting
- OBPv3.1.0: getServerJWK
- OBPv3.1.0: getMessageDocsSwagger
- OBPv3.1.0: createConsentEmail
- OBPv3.1.0: createConsentSms
- OBPv3.1.0: answerConsentChallenge
- OBPv3.1.0: getConsents
- OBPv3.1.0: revokeConsent
- OBPv3.1.0: createUserAuthContextUpdateRequest
- OBPv3.1.0: answerUserAuthContextUpdateChallenge
- OBPv3.1.0: getSystemView
- OBPv3.1.0: createSystemView
- OBPv3.1.0: deleteSystemView
- OBPv3.1.0: updateSystemView
- OBPv3.1.0: getOAuth2ServerJWKsURIs
- OBPv3.1.0: getMethodRoutings
- OBPv3.1.0: createMethodRouting
- OBPv3.1.0: updateMethodRouting
- OBPv3.1.0: deleteMethodRouting
- OBPv3.1.0: updateCustomerEmail
- OBPv3.1.0: updateCustomerNumber
- OBPv3.1.0: updateCustomerMobileNumber
- OBPv3.1.0: updateCustomerIdentity
- OBPv3.1.0: updateCustomerCreditLimit
- OBPv3.1.0: updateCustomerCreditRatingAndSource
- OBPv3.1.0: updateAccount
- OBPv3.1.0: addCardForBank
- OBPv3.1.0: updatedCardForBank
- OBPv3.1.0: getCardsForBank
- OBPv3.1.0: getCardForBank
- OBPv3.1.0: deleteCardForBank
- OBPv3.1.0: createCardAttribute
- OBPv3.1.0: updateCardAttribute
- OBPv3.1.0: updateCustomerBranch
- OBPv3.1.0: updateCustomerData
- OBPv3.1.0: createAccount
- OBPv3.1.0: getPrivateAccountByIdFull
- OBPv3.1.0: saveHistoricalTransaction
- OBPv3.1.0: getWebUiProps
- OBPv3.1.0: createWebUiProps
- OBPv3.1.0: deleteWebUiProps
- OBPv3.1.0: getBankAccountsBalances
- OBPv3.1.0: enableDisableConsumers
- OBPv4.0.0: callsLimit
- OBPv4.0.0: createSettlementAccount
- OBPv4.0.0: addAccount
- OBPv4.0.0: createUserWithRoles
- OBPv4.0.0: getCurrentUserId
- OBPv4.0.0: createHistoricalTransactionAtBank
- OBPv4.0.0: getScopes
- OBPv4.0.0: addScope
- OBPv4.0.0: createProductAttribute
- OBPv4.0.0: updateProductAttribute
- OBPv4.0.0: getProductAttribute
- OBPv4.0.0: getProductFee
- OBPv4.0.0: getProductFees
- OBPv4.0.0: createBankAttribute
- OBPv4.0.0: updateBankAttribute
- OBPv4.0.0: deleteBankAttribute
- OBPv4.0.0: getAtms
- OBPv4.0.0: getAtm
- OBPv4.0.0: getProducts
- OBPv4.0.0: getProduct
- OBPv4.0.0: createSystemAccountNotificationWebhook
- OBPv4.0.0: createBankAccountNotificationWebhook
- OBPv5.0.0: createAccount
- OBPv5.0.0: createUserAuthContext
- OBPv5.0.0: getUserAuthContexts
- OBPv5.0.0: createUserAuthContextUpdateRequest
- OBPv5.0.0: answerUserAuthContextUpdateChallenge
- OBPv5.0.0: createConsentRequest
- OBPv5.0.0: getConsentRequest
- OBPv5.0.0: getConsentByConsentRequestId
- OBPv5.0.0: createConsentByConsentRequestIdEmail
- OBPv5.0.0: createConsentByConsentRequestIdSms
- OBPv5.0.0: headAtms
- OBPv5.1.0: deleteNonPersonalUserAttribute
- OBPv5.1.0: getNonPersonalUserAttributes
- OBPv5.1.0: revokeConsentAtBank
- OBPv5.1.0: selfRevokeConsent
- OBPv5.1.0: mtlsClientCertificateInfo
- OBPv5.1.0: getAggregateMetrics
- OBPv5.1.0: getAtms
- OBPv5.1.0: getAtm
- OBPv5.0.0: getBank
- OBPv5.0.0: createBank
- OBPv5.0.0: updateBank
- OBPv5.0.0: createCustomer
- OBPv5.0.0: getCustomerOverview
- OBPv5.0.0: getCustomerOverviewFlat
- OBPv5.0.0: getMyCustomersAtAnyBank
- OBPv5.0.0: getMyCustomersAtBank
- OBPv5.0.0: getCustomersAtOneBank
- OBPv5.0.0: getCustomersMinimalAtOneBank
- OBPv5.0.0: createProduct
- OBPv5.0.0: addCardForBank
- OBPv5.0.0: getViewsForBankAccount
- OBPv5.0.0: deleteSystemView
- OBPv5.0.0: getMetricsAtBank
- OBPv5.0.0: getSystemView
- OBPv5.0.0: getSystemViewsIds
- OBPv5.0.0: createSystemView
- OBPv5.0.0: updateSystemView
- OBPv5.0.0: createCustomerAccountLink
- OBPv5.0.0: getCustomerAccountLinksByCustomerId
- OBPv5.0.0: getCustomerAccountLinksByBankIdAccountId
- OBPv5.0.0: getCustomerAccountLinkById
- OBPv5.0.0: updateCustomerAccountLinkById
- OBPv5.0.0: deleteCustomerAccountLinkById
- OBPv5.0.0: getAdapterInfo
- OBPv4.0.0: getMapperDatabaseInfo
- OBPv4.0.0: getLogoutLink
- OBPv4.0.0: getBanks
- OBPv4.0.0: ibanChecker
- OBPv4.0.0: getDoubleEntryTransaction
- OBPv4.0.0: getBalancingTransaction
- OBPv4.0.0: getSettlementAccounts
- OBPv4.0.0: createTransactionRequestAccount
- OBPv4.0.0: createTransactionRequestAccountOtp
- OBPv4.0.0: createTransactionRequestCounterparty
- OBPv4.0.0: createTransactionRequestSimple
- OBPv4.0.0: createTransactionRequestSepa
- OBPv4.0.0: createTransactionRequestRefund
- OBPv4.0.0: createTransactionRequestFreeForm
- OBPv4.0.0: createTransactionRequestCard
- OBPv4.0.0: answerTransactionRequestChallenge
- OBPv4.0.0: createTransactionRequestAttribute
- OBPv4.0.0: getTransactionRequestAttributeById
- OBPv4.0.0: getTransactionRequestAttributes
- OBPv4.0.0: updateTransactionRequestAttribute
- OBPv4.0.0: createOrUpdateTransactionRequestAttributeDefinition
- OBPv4.0.0: getTransactionRequestAttributeDefinition
- OBPv4.0.0: deleteTransactionRequestAttributeDefinition
- OBPv4.0.0: getSystemDynamicEntities
- OBPv4.0.0: getBankLevelDynamicEntities
- OBPv4.0.0: deleteSystemDynamicEntity
- OBPv4.0.0: deleteBankLevelDynamicEntity
- OBPv4.0.0: getMyDynamicEntities
- OBPv4.0.0: deleteMyDynamicEntity
- OBPv4.0.0: resetPasswordUrl
- OBPv4.0.0: getCallContext
- OBPv4.0.0: verifyRequestSignResponse
- OBPv4.0.0: updateAccountLabel
- OBPv4.0.0: lockUser
- OBPv4.0.0: getEntitlements
- OBPv4.0.0: getEntitlementsForBank
- OBPv4.0.0: addTagForViewOnAccount
- OBPv4.0.0: deleteTagForViewOnAccount
- OBPv4.0.0: getTagsForViewOnAccount
- OBPv4.0.0: getCoreAccountById
- OBPv4.0.0: getPrivateAccountByIdFull
- OBPv4.0.0: getAccountByAccountRouting
- OBPv4.0.0: getAccountsByAccountRoutingRegex
- OBPv4.0.0: getBankAccountsBalances
- OBPv4.0.0: getBankAccountBalances
- OBPv4.0.0: getFirehoseAccountsAtOneBank
- OBPv4.0.0: getFastFirehoseAccountsAtOneBank
- OBPv4.0.0: getCustomersByCustomerPhoneNumber
- OBPv4.0.0: getUserByUserId
- OBPv4.0.0: getUserByUsername
- OBPv4.0.0: getUsersByEmail
- OBPv4.0.0: getUsers
- OBPv4.0.0: createUserInvitation
- OBPv4.0.0: getUserInvitationAnonymous
- OBPv4.0.0: getUserInvitation
- OBPv4.0.0: getUserInvitations
- OBPv4.0.0: deleteUser
- OBPv4.0.0: createDirectDebit
- OBPv4.0.0: createDirectDebitManagement
- OBPv4.0.0: createStandingOrder
- OBPv4.0.0: createStandingOrderManagement
- OBPv4.0.0: grantUserAccessToView
- OBPv4.0.0: createUserWithAccountAccess
- OBPv4.0.0: revokeUserAccessToView
- OBPv4.0.0: revokeGrantUserAccessToViews
- OBPv4.0.0: createCustomerAttribute
- OBPv4.0.0: updateCustomerAttribute
- OBPv4.0.0: getCustomerAttributes
- OBPv4.0.0: getCustomerAttributeById
- OBPv4.0.0: createTransactionAttribute
- OBPv4.0.0: updateTransactionAttribute
- OBPv4.0.0: getTransactionAttributes
- OBPv4.0.0: getTransactionAttributeById
- OBPv4.0.0: getTransactionRequest
- OBPv4.0.0: getPrivateAccountsAtOneBank
- OBPv4.0.0: createConsumer
- OBPv4.0.0: getCustomersAtAnyBank
- OBPv4.0.0: getCustomersMinimalAtAnyBank
- OBPv4.0.0: deleteCustomerAttribute
- OBPv4.0.0: createDynamicEndpoint
- OBPv4.0.0: createBankLevelDynamicEndpoint
- OBPv4.0.0: updateDynamicEndpointHost
- OBPv4.0.0: updateBankLevelDynamicEndpointHost
- OBPv4.0.0: getDynamicEndpoint
- OBPv4.0.0: getDynamicEndpoints
- OBPv4.0.0: getBankLevelDynamicEndpoint
- OBPv4.0.0: getBankLevelDynamicEndpoints
- OBPv4.0.0: deleteDynamicEndpoint
- OBPv4.0.0: deleteBankLevelDynamicEndpoint
- OBPv4.0.0: getMyDynamicEndpoints
- OBPv4.0.0: deleteMyDynamicEndpoint
- OBPv4.0.0: createOrUpdateCustomerAttributeAttributeDefinition
- OBPv4.0.0: createOrUpdateAccountAttributeDefinition
- OBPv4.0.0: createOrUpdateProductAttributeDefinition
- OBPv4.0.0: createProductFee
- OBPv4.0.0: updateProductFee
- OBPv4.0.0: deleteProductFee
- OBPv4.0.0: createOrUpdateBankAttributeDefinition
- OBPv4.0.0: getBankAttributes
- OBPv4.0.0: getBankAttribute
- OBPv4.0.0: createOrUpdateTransactionAttributeDefinition
- OBPv4.0.0: createOrUpdateCardAttributeDefinition
- OBPv4.0.0: deleteTransactionAttributeDefinition
- OBPv4.0.0: deleteCustomerAttributeDefinition
- OBPv4.0.0: deleteAccountAttributeDefinition
- OBPv4.0.0: deleteProductAttributeDefinition
- OBPv4.0.0: deleteCardAttributeDefinition
- OBPv4.0.0: getProductAttributeDefinition
- OBPv4.0.0: getCustomerAttributeDefinition
- OBPv4.0.0: getAccountAttributeDefinition
- OBPv4.0.0: getTransactionAttributeDefinition
- OBPv4.0.0: getCardAttributeDefinition
- OBPv4.0.0: deleteUserCustomerLink
- OBPv4.0.0: getUserCustomerLinksByUserId
- OBPv4.0.0: createUserCustomerLinks
- OBPv4.0.0: getUserCustomerLinksByCustomerId
- OBPv4.0.0: getCorrelatedUsersInfoByCustomerId
- OBPv4.0.0: getMyCorrelatedEntities
- OBPv4.0.0: getAccountsMinimalByCustomerId
- OBPv4.0.0: deleteTransactionCascade
- OBPv4.0.0: deleteAccountCascade
- OBPv4.0.0: deleteBankCascade
- OBPv4.0.0: deleteProductCascade
- OBPv4.0.0: deleteCustomerCascade
- OBPv4.0.0: createCounterparty
- OBPv4.0.0: deleteExplicitCounterparty
- OBPv4.0.0: deleteCounterpartyForAnyAccount
- OBPv4.0.0: createCounterpartyForAnyAccount
- OBPv4.0.0: getExplictCounterpartiesForAccount
- OBPv4.0.0: getCounterpartiesForAnyAccount
- OBPv4.0.0: getExplictCounterpartyById
- OBPv4.0.0: getCounterpartyByNameForAnyAccount
- OBPv4.0.0: getCounterpartyByIdForAnyAccount
- OBPv4.0.0: addConsentUser
- OBPv4.0.0: updateConsentStatus
- OBPv4.0.0: getConsents
- OBPv4.0.0: getConsentInfos
- OBPv4.0.0: getMyPersonalUserAttributes
- OBPv4.0.0: getUserWithAttributes
- OBPv4.0.0: createMyPersonalUserAttribute
- OBPv4.0.0: updateMyPersonalUserAttribute
- OBPv4.0.0: getScannedApiVersions
- OBPv4.0.0: createMyApiCollection
- OBPv4.0.0: getMyApiCollectionByName
- OBPv4.0.0: getMyApiCollectionById
- OBPv4.0.0: getSharableApiCollectionById
- OBPv4.0.0: getApiCollectionsForUser
- OBPv4.0.0: getFeaturedApiCollections
- OBPv4.0.0: getMyApiCollections
- OBPv4.0.0: deleteMyApiCollection
- OBPv4.0.0: createMyApiCollectionEndpoint
- OBPv4.0.0: createMyApiCollectionEndpointById
- OBPv4.0.0: getMyApiCollectionEndpoint
- OBPv4.0.0: getApiCollectionEndpoints
- OBPv4.0.0: getMyApiCollectionEndpoints
- OBPv4.0.0: getMyApiCollectionEndpointsById
- OBPv4.0.0: deleteMyApiCollectionEndpoint
- OBPv4.0.0: deleteMyApiCollectionEndpointByOperationId
- OBPv4.0.0: deleteMyApiCollectionEndpointById
- OBPv4.0.0: createJsonSchemaValidation
- OBPv4.0.0: updateJsonSchemaValidation
- OBPv4.0.0: deleteJsonSchemaValidation
- OBPv4.0.0: getJsonSchemaValidation
- OBPv4.0.0: getAllJsonSchemaValidations
- OBPv4.0.0: getAllJsonSchemaValidationsPublic
- OBPv4.0.0: createAuthenticationTypeValidation
- OBPv4.0.0: updateAuthenticationTypeValidation
- OBPv4.0.0: deleteAuthenticationTypeValidation
- OBPv4.0.0: getAuthenticationTypeValidation
- OBPv4.0.0: getAllAuthenticationTypeValidations
- OBPv4.0.0: getAllAuthenticationTypeValidationsPublic
- OBPv4.0.0: createConnectorMethod
- OBPv4.0.0: updateConnectorMethod
- OBPv4.0.0: getConnectorMethod
- OBPv4.0.0: getAllConnectorMethods
- OBPv4.0.0: createDynamicResourceDoc
- OBPv4.0.0: updateDynamicResourceDoc
- OBPv4.0.0: deleteDynamicResourceDoc
- OBPv4.0.0: getDynamicResourceDoc
- OBPv4.0.0: getAllDynamicResourceDocs
- OBPv4.0.0: createBankLevelDynamicResourceDoc
- OBPv4.0.0: updateBankLevelDynamicResourceDoc
- OBPv4.0.0: deleteBankLevelDynamicResourceDoc
- OBPv4.0.0: getBankLevelDynamicResourceDoc
- OBPv4.0.0: getAllBankLevelDynamicResourceDocs
- OBPv4.0.0: buildDynamicEndpointTemplate
- OBPv4.0.0: createDynamicMessageDoc
- OBPv4.0.0: createBankLevelDynamicMessageDoc
- OBPv4.0.0: updateDynamicMessageDoc
- OBPv4.0.0: getDynamicMessageDoc
- OBPv4.0.0: getAllDynamicMessageDocs
- OBPv4.0.0: deleteDynamicMessageDoc
- OBPv4.0.0: updateBankLevelDynamicMessageDoc
- OBPv4.0.0: getBankLevelDynamicMessageDoc
- OBPv4.0.0: getAllBankLevelDynamicMessageDocs
- OBPv4.0.0: deleteBankLevelDynamicMessageDoc
- OBPv4.0.0: createEndpointMapping
- OBPv4.0.0: updateEndpointMapping
- OBPv4.0.0: getEndpointMapping
- OBPv4.0.0: getAllEndpointMappings
- OBPv4.0.0: deleteEndpointMapping
- OBPv4.0.0: createBankLevelEndpointMapping
- OBPv4.0.0: updateBankLevelEndpointMapping
- OBPv4.0.0: getBankLevelEndpointMapping
- OBPv4.0.0: getAllBankLevelEndpointMappings
- OBPv4.0.0: deleteBankLevelEndpointMapping
- OBPv4.0.0: updateAtmSupportedCurrencies
- OBPv4.0.0: updateAtmSupportedLanguages
- OBPv4.0.0: updateAtmAccessibilityFeatures
- OBPv4.0.0: updateAtmServices
- OBPv4.0.0: updateAtmNotes
- OBPv4.0.0: updateAtmLocationCategories
- OBPv4.0.0: createAtm
- OBPv4.0.0: updateAtm
- OBPv4.0.0: deleteAtm
- OBPv4.0.0: createSystemLevelEndpointTag
- OBPv4.0.0: updateSystemLevelEndpointTag
- OBPv4.0.0: getSystemLevelEndpointTags
- OBPv4.0.0: deleteSystemLevelEndpointTag
- OBPv4.0.0: createBankLevelEndpointTag
- OBPv4.0.0: updateBankLevelEndpointTag
- OBPv4.0.0: getBankLevelEndpointTags
- OBPv4.0.0: deleteBankLevelEndpointTag
- OBPv4.0.0: getMySpaces
- OBPv4.0.0: createCustomerMessage
- OBPv4.0.0: getCustomerMessages
- OBPv4.0.0: createSystemDynamicEntity
- OBPv4.0.0: createBankLevelDynamicEntity
- OBPv4.0.0: updateSystemDynamicEntity
- OBPv4.0.0: updateBankLevelDynamicEntity
- OBPv4.0.0: updateMyDynamicEntity
- OBPv5.1.0: waitingForGodot
- OBPv5.1.0: getAllApiCollections
- OBPv5.1.0: createNonPersonalUserAttribute
- OBPv5.1.0: customViewNamesCheck
- OBPv5.1.0: systemViewNamesCheck
- OBPv5.1.0: accountAccessUniqueIndexCheck
- OBPv5.1.0: accountCurrencyCheck
- OBPv5.1.0: getCurrenciesAtBank
- OBPv5.1.0: orphanedAccountCheck
- OBPv5.1.0: createAtmAttribute
- OBPv5.1.0: getAtmAttributes
- OBPv5.1.0: getAtmAttribute
- OBPv5.1.0: updateAtmAttribute
- OBPv5.1.0: deleteAtmAttribute
- OBPv5.1.0: updateMyApiCollection
- OBPv5.1.0: getUserByProviderAndUsername
- OBPv5.1.0: getUserLockStatus
- OBPv5.1.0: unlockUserByProviderAndUsername
- OBPv5.1.0: lockUserByProviderAndUsername
- OBPv5.1.0: createAtm
- OBPv5.1.0: updateAtm
- OBPv5.1.0: deleteAtm
- OBPv4.0.0: getBank
- OBPv4.0.0: createBank
- OBPv4.0.0: getCustomersByAttributes
- OBPv4.0.0: createCustomer
- OBPv4.0.0: createProduct
- OBPv1.4.0: getResourceDocsObp
- OBPv1.4.0: getResourceDocsObpV400
- OBPv1.4.0: getBankLevelDynamicResourceDocsObp
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
- OBPv1.2.1: getViewsForBankAccount
- OBPv1.2.1: createViewForBankAccount
- OBPv1.2.1: updateViewForBankAccount
- OBPv1.2.1: getPermissionsForBankAccount
- OBPv1.2.1: getPermissionForUserForBankAccount
- OBPv1.2.1: getOtherAccountsForBankAccount
- OBPv1.2.1: getOtherAccountByIdForBankAccount
- OBPv1.2.1: addCounterpartyCorporateLocation
- OBPv1.2.1: updateCounterpartyCorporateLocation
- OBPv1.2.1: addCounterpartyPhysicalLocation
- OBPv1.2.1: updateCounterpartyPhysicalLocation
- OBPv1.4.0: getTransactionRequests
- OBPv1.4.0: createTransactionRequest
- OBPv1.4.0: answerTransactionRequestChallenge
- OBPv2.0.0: getCoreAccountById
- OBPv2.0.0: getCoreTransactionsForBankAccount
- OBPv2.0.0: accountById
- OBPv2.0.0: getPermissionForUserForBankAccount
- OBPv2.0.0: createAccount
- OBPv2.0.0: createTransactionRequest
- OBPv2.0.0: answerTransactionRequestChallenge
- OBPv2.0.0: getTransactionRequests
- OBPv2.2.0: createViewForBankAccount
- OBPv2.2.0: updateViewForBankAccount
- OBPv3.0.0: getFirehoseAccountsAtOneBank
- OBPv4.0.0: getFirehoseAccountsAtOneBank
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
- BGv1.3: checkAvailabilityOfFunds
- BGv1.3: cancelPayment
- BGv1.3: initiatePayment
- : checkAvailabilityOfFunds
- : cancelPayment
- : initiatePayment
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
- OBPv4.0.0: getAccountByAccountRouting
- OBPv5.0.0: createConsentByConsentRequestIdEmail
- OBPv5.0.0: createConsentByConsentRequestIdSms
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
- UKv2.0: getAccountList
- UKv2.0: getAccount
- UKv2.0: getBalances
- UKv3.1: getAccounts
- UKv3.1: getAccountsAccountId
- UKv3.1: getBalances
- UKv3.1: getTransactions
- STETv1.4: accountsGet
- BGv1.3: getAccountList
- BGv1.3: getCardAccounts
- : getAccountList
- : getCardAccounts
- OBPv2.0.0: getPrivateAccountsAtOneBank
- OBPv2.0.0: corePrivateAccountsAtOneBank
- OBPv2.0.0: privateAccountsAtOneBank
- OBPv4.0.0: getPrivateAccountsAtOneBank
- OBPv5.0.0: getCustomerOverview
- OBPv5.0.0: getCustomerOverviewFlat
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
- OBPv3.1.0: getBankAccountsBalances
- OBPv4.0.0: getBankAccountsBalances
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
- AUv1.0.0: listAccounts
- BGv1: getAccountList
- OBPv3.0.0: corePrivateAccountsAllBanks
- OBPv3.0.0: privateAccountsAtOneBank
- OBPv3.0.0: getPrivateAccountIdsbyBankId
- OBPv3.0.0: getAccountsHeld
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
- OBPv3.0.0: getAccountsHeld
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
- STETv1.4: accountsBalancesGet
- STETv1.4: accountsTransactionsGet
- AUv1.0.0: listBalance
- BGv1: getAccountBalances
- BGv1: getTransactionList
- BGv1.3: getPaymentInitiationStatus
- BGv1.3: updatePaymentCancellationPsuData
- BGv1.3: updatePaymentPsuData
- : getPaymentInitiationStatus
- : updatePaymentCancellationPsuData
- : updatePaymentPsuData
- OBPv1.2.1: updateAccountLabel
- OBPv1.2.1: deleteViewForBankAccount
- OBPv1.2.1: addPermissionForUserForBankAccountForMultipleViews
- OBPv1.2.1: addPermissionForUserForBankAccountForOneView
- OBPv1.2.1: removePermissionForUserForBankAccountForOneView
- OBPv1.2.1: removePermissionForUserForBankAccountForAllViews
- OBPv1.2.1: getOtherAccountMetadata
- OBPv1.2.1: getCounterpartyPublicAlias
- OBPv1.2.1: addCounterpartyPublicAlias
- OBPv1.2.1: updateCounterpartyPublicAlias
- OBPv1.2.1: deleteCounterpartyPublicAlias
- OBPv1.2.1: getOtherAccountPrivateAlias
- OBPv1.2.1: addOtherAccountPrivateAlias
- OBPv1.2.1: updateCounterpartyPrivateAlias
- OBPv1.2.1: deleteCounterpartyPrivateAlias
- OBPv1.2.1: addCounterpartyMoreInfo
- OBPv1.2.1: updateCounterpartyMoreInfo
- OBPv1.2.1: deleteCounterpartyMoreInfo
- OBPv1.2.1: addCounterpartyUrl
- OBPv1.2.1: updateCounterpartyUrl
- OBPv1.2.1: deleteCounterpartyUrl
- OBPv1.2.1: addCounterpartyImageUrl
- OBPv1.2.1: updateCounterpartyImageUrl
- OBPv1.2.1: deleteCounterpartyImageUrl
- OBPv1.2.1: addCounterpartyOpenCorporatesUrl
- OBPv1.2.1: updateCounterpartyOpenCorporatesUrl
- OBPv1.2.1: deleteCounterpartyOpenCorporatesUrl
- OBPv1.2.1: deleteCounterpartyCorporateLocation
- OBPv1.2.1: deleteCounterpartyPhysicalLocation
- OBPv1.2.1: getTransactionNarrative
- OBPv1.2.1: addTransactionNarrative
- OBPv1.2.1: updateTransactionNarrative
- OBPv1.2.1: deleteTransactionNarrative
- OBPv1.2.1: getCommentsForViewOnTransaction
- OBPv1.2.1: addCommentForViewOnTransaction
- OBPv1.2.1: deleteCommentForViewOnTransaction
- OBPv1.2.1: getTagsForViewOnTransaction
- OBPv1.2.1: addTagForViewOnTransaction
- OBPv1.2.1: deleteTagForViewOnTransaction
- OBPv1.2.1: getImagesForViewOnTransaction
- OBPv1.2.1: addImageForViewOnTransaction
- OBPv1.2.1: deleteImageForViewOnTransaction
- OBPv1.2.1: getWhereTagForViewOnTransaction
- OBPv1.2.1: addWhereTagForViewOnTransaction
- OBPv1.2.1: updateWhereTagForViewOnTransaction
- OBPv1.2.1: deleteWhereTagForViewOnTransaction
- OBPv1.2.1: getOtherAccountForTransaction
- OBPv1.4.0: getTransactionRequestTypes
- OBPv2.0.0: getPermissionsForBankAccount
- OBPv2.1.0: createTransactionRequestSandboxTan
- OBPv2.1.0: createTransactionRequestCounterparty
- OBPv2.1.0: createTransactionRequestSepa
- OBPv2.1.0: createTransactionRequestFreeForm
- OBPv2.1.0: answerTransactionRequestChallenge
- OBPv2.1.0: addCardsForBank
- OBPv2.2.0: getViewsForBankAccount
- OBPv2.2.0: getExplictCounterpartiesForAccount
- OBPv2.2.0: getExplictCounterpartyById
- OBPv2.2.0: createCounterparty
- OBPv3.0.0: getViewsForBankAccount
- OBPv3.0.0: createViewForBankAccount
- OBPv3.0.0: getPermissionForUserForBankAccount
- OBPv3.0.0: updateViewForBankAccount
- OBPv3.0.0: getPrivateAccountById
- OBPv3.0.0: getPublicAccountById
- OBPv3.0.0: getCoreAccountById
- OBPv3.0.0: getFirehoseTransactionsForBankAccount
- OBPv3.0.0: getCoreTransactionsForBankAccount
- OBPv3.0.0: getTransactionsForBankAccount
- OBPv3.0.0: getOtherAccountsForBankAccount
- OBPv3.0.0: getOtherAccountByIdForBankAccount
- OBPv3.1.0: getCheckbookOrders
- OBPv3.1.0: getStatusOfCreditCardOrder
- OBPv3.1.0: checkFundsAvailable
- OBPv3.1.0: getTransactionByIdForBankAccount
- OBPv3.1.0: getTransactionRequests
- OBPv3.1.0: createAccountAttribute
- OBPv3.1.0: updateAccountAttribute
- OBPv3.1.0: updateAccount
- OBPv3.1.0: addCardForBank
- OBPv3.1.0: updatedCardForBank
- OBPv3.1.0: createAccount
- OBPv3.1.0: getPrivateAccountByIdFull
- OBPv3.1.0: saveHistoricalTransaction
- OBPv4.0.0: getAccountsByAccountRoutingRegex
- OBPv4.0.0: createHistoricalTransactionAtBank
- OBPv4.0.0: createCounterparty
- OBPv4.0.0: createCounterpartyForAnyAccount
- OBPv5.0.0: createAccount
- OBPv5.0.0: addCardForBank
- OBPv5.0.0: createCustomerAccountLink
- OBPv5.0.0: getViewsForBankAccount
- OBPv5.0.0: getCustomerAccountLinksByBankIdAccountId
- OBPv4.0.0: getDoubleEntryTransaction
- OBPv4.0.0: createTransactionRequestAccount
- OBPv4.0.0: createTransactionRequestAccountOtp
- OBPv4.0.0: createTransactionRequestCounterparty
- OBPv4.0.0: createTransactionRequestSimple
- OBPv4.0.0: createTransactionRequestSepa
- OBPv4.0.0: createTransactionRequestRefund
- OBPv4.0.0: createTransactionRequestFreeForm
- OBPv4.0.0: answerTransactionRequestChallenge
- OBPv4.0.0: createTransactionRequestAttribute
- OBPv4.0.0: getTransactionRequestAttributeById
- OBPv4.0.0: getTransactionRequestAttributes
- OBPv4.0.0: updateTransactionRequestAttribute
- OBPv4.0.0: updateAccountLabel
- OBPv4.0.0: addTagForViewOnAccount
- OBPv4.0.0: deleteTagForViewOnAccount
- OBPv4.0.0: getTagsForViewOnAccount
- OBPv4.0.0: getCoreAccountById
- OBPv4.0.0: getPrivateAccountByIdFull
- OBPv4.0.0: createDirectDebit
- OBPv4.0.0: createDirectDebitManagement
- OBPv4.0.0: createStandingOrder
- OBPv4.0.0: createStandingOrderManagement
- OBPv4.0.0: createTransactionAttribute
- OBPv4.0.0: updateTransactionAttribute
- OBPv4.0.0: getTransactionAttributes
- OBPv4.0.0: getTransactionAttributeById
- OBPv4.0.0: getTransactionRequest
- OBPv4.0.0: deleteTransactionCascade
- OBPv4.0.0: deleteAccountCascade
- OBPv4.0.0: deleteExplicitCounterparty
- OBPv4.0.0: deleteCounterpartyForAnyAccount
- OBPv4.0.0: getExplictCounterpartiesForAccount
- OBPv4.0.0: getCounterpartiesForAnyAccount
- OBPv4.0.0: getExplictCounterpartyById
- OBPv4.0.0: getCounterpartyByNameForAnyAccount
- OBPv4.0.0: getCounterpartyByIdForAnyAccount
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":true, "bespoke":[{ "key":"CustomerNumber", "value":"5987953" }] } }Required
Fields{ }Dependent
Endpoints
- OBPv2.2.0: getExplictCounterpartyById
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":true, "bespoke":[{ "key":"CustomerNumber", "value":"5987953" }] } }Required
Fields{ }Dependent
Endpoints
- OBPv2.1.0: createTransactionRequestSandboxTan
- OBPv2.1.0: createTransactionRequestCounterparty
- OBPv2.1.0: createTransactionRequestSepa
- OBPv2.1.0: createTransactionRequestFreeForm
- OBPv3.1.0: saveHistoricalTransaction
- OBPv4.0.0: createDirectDebit
- OBPv4.0.0: createDirectDebitManagement
- OBPv4.0.0: createStandingOrder
- OBPv4.0.0: createStandingOrderManagement
- OBPv4.0.0: getExplictCounterpartyById
- OBPv4.0.0: getCounterpartyByIdForAnyAccount
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":true, "bespoke":[{ "key":"CustomerNumber", "value":"5987953" }] } }Required
Fields{ }Dependent
Endpoints
- OBPv2.1.0: createTransactionRequestSandboxTan
- OBPv2.1.0: createTransactionRequestCounterparty
- OBPv2.1.0: createTransactionRequestSepa
- OBPv2.1.0: createTransactionRequestFreeForm
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":true, "bespoke":[{ "key":"CustomerNumber", "value":"5987953" }] } }Required
Fields{ }Dependent
Endpoints
- OBPv4.0.0: answerTransactionRequestChallenge
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":true, "bespoke":[{ "key":"CustomerNumber", "value":"5987953" }] }] }Required
Fields{ }Dependent
Endpoints
- OBPv2.2.0: getExplictCounterpartiesForAccount
- OBPv4.0.0: getExplictCounterpartiesForAccount
- OBPv4.0.0: getCounterpartiesForAnyAccount
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":true }, "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
- UKv3.1: getAccountsAccountIdTransactions
- BGv1.3: getCardAccountTransactionList
- BGv1.3: getTransactionList
- : getCardAccountTransactionList
- : getTransactionList
- OBPv3.0.0: getTransactionsForBankAccount
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":true }, "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
- OBPv3.0.0: getCoreTransactionsForBankAccount
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":true }, "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
- BGv1.3: getTransactionDetails
- : getTransactionDetails
- OBPv1.2.1: getOtherAccountForTransaction
- OBPv3.1.0: getTransactionByIdForBankAccount
- OBPv4.0.0: getDoubleEntryTransaction
- OBPv4.0.0: createTransactionAttribute
- OBPv4.0.0: updateTransactionAttribute
- OBPv4.0.0: getTransactionAttributes
- OBPv4.0.0: getTransactionAttributeById
- OBPv4.0.0: deleteTransactionCascade
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":true, "cancelled":true, "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
- BGv1.3: getCardAccounts
- : getCardAccounts
- OBPv1.3.0: getCards
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":true, "cancelled":true, "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
- OBPv3.1.0: updatedCardForBank
- OBPv3.1.0: getCardForBank
- OBPv3.1.0: createCardAttribute
- OBPv3.1.0: updateCardAttribute
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
- OBPv3.1.0: deleteCardForBank
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":true, "cancelled":true, "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
- OBPv3.1.0: getCardsForBank
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":true, "cancelled":true, "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":true, "cancelled":true, "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
- OBPv2.1.0: addCardsForBank
- OBPv3.1.0: addCardForBank
- OBPv5.0.0: addCardForBank
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":true, "cancelled":true, "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":true, "cancelled":true, "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
- OBPv3.1.0: updatedCardForBank
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
- OBPv2.1.0: createTransactionRequestSandboxTan
- OBPv2.1.0: createTransactionRequestCounterparty
- OBPv2.1.0: createTransactionRequestSepa
- OBPv2.1.0: createTransactionRequestFreeForm
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
- BGv1.3: initiatePayment
- : initiatePayment
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
- UKv2.0: getAccountTransactions
- UKv3.1: getTransactions
- STETv1.4: accountsTransactionsGet
- BGv1: getAccountBalances
- BGv1: getTransactionList
- BGv1.3: getCardAccountTransactionList
- BGv1.3: getTransactionList
- : getCardAccountTransactionList
- : getTransactionList
- OBPv2.1.0: getTransactionRequests
- OBPv3.1.0: getTransactionRequests
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
- OBPv2.0.0: answerTransactionRequestChallenge
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
- BGv1.3: updatePaymentPsuData
- : updatePaymentPsuData
- OBPv2.1.0: answerTransactionRequestChallenge
- OBPv4.0.0: answerTransactionRequestChallenge
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
- OBPv3.1.0: updateAccount
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
- OBPv2.2.0: createAccount
- OBPv3.1.0: updateAccountApplicationStatus
- OBPv3.1.0: createAccount
- OBPv4.0.0: createSettlementAccount
- OBPv5.0.0: createAccount
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
- OBPv2.1.0: getProducts
- OBPv3.1.0: getProducts
- OBPv3.1.0: createProductCollection
- OBPv4.0.0: getProducts
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
- OBPv2.1.0: getProduct
- OBPv3.1.0: createProduct
- OBPv3.1.0: getProduct
- OBPv3.1.0: getProductTree
- OBPv3.1.0: createAccountAttribute
- OBPv4.0.0: createProductAttribute
- OBPv4.0.0: createProduct
- OBPv4.0.0: getProduct
- OBPv5.0.0: createProduct
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":true, "accessibleFeatures":"string", "branchType":"", "moreInfo":"More information about this fee", "phoneNumber":"", "isDeleted":true } }Required
Fields{ }Dependent
Endpoints
- OBPv3.0.0: getBranch
- OBPv3.1.0: deleteBranch
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":true, "accessibleFeatures":"string", "branchType":"", "moreInfo":"More information about this fee", "phoneNumber":"", "isDeleted":true }] }Required
Fields{ }Dependent
Endpoints
- OBPv3.0.0: getBranches
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":"atme0352a-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":"atme0352a-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":true, "locatedAt":"", "moreInfo":"More information about this fee", "hasDepositCapability":true, "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
- OBPv3.0.0: getAtm
- OBPv4.0.0: updateAtmSupportedCurrencies
- OBPv4.0.0: updateAtmSupportedLanguages
- OBPv4.0.0: updateAtmAccessibilityFeatures
- OBPv4.0.0: updateAtmServices
- OBPv4.0.0: updateAtmNotes
- OBPv4.0.0: updateAtmLocationCategories
- OBPv4.0.0: updateAtm
- OBPv4.0.0: deleteAtm
- OBPv4.0.0: getAtm
- OBPv5.1.0: createAtmAttribute
- OBPv5.1.0: getAtmAttributes
- OBPv5.1.0: getAtmAttribute
- OBPv5.1.0: updateAtmAttribute
- OBPv5.1.0: deleteAtmAttribute
- OBPv5.1.0: updateAtm
- OBPv5.1.0: getAtm
- OBPv5.1.0: deleteAtm
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":"atme0352a-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":true, "locatedAt":"", "moreInfo":"More information about this fee", "hasDepositCapability":true, "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
- OBPv2.1.0: answerTransactionRequestChallenge
- OBPv4.0.0: answerTransactionRequestChallenge
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":true, "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":true, "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
- BGv1.3: cancelPayment
- : cancelPayment
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":true, "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":true, "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
- OBPv3.1.0: updateCustomerNumber
- OBPv5.0.0: createCustomer
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":true, "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":true, "lastOkDate":"2019-09-08T00:00:00Z", "title":"title of customer", "branchId":"DERBY6", "nameSuffix":"Sr" } }Required
Fields{ }Dependent
Endpoints
- OBPv3.1.0: createCustomer
- OBPv4.0.0: createCustomer
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":true, "lastOkDate":"2019-09-08T00:00:00Z", "title":"title of customer", "branchId":"DERBY6", "nameSuffix":"Sr" } }Required
Fields{ }Dependent
Endpoints
- OBPv3.1.0: updateCustomerEmail
- OBPv3.1.0: updateCustomerNumber
- OBPv3.1.0: updateCustomerMobileNumber
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":true, "lastOkDate":"2019-09-08T00:00:00Z", "title":"title of customer", "branchId":"DERBY6", "nameSuffix":"Sr" } }Required
Fields{ }Dependent
Endpoints
- OBPv3.1.0: updateCustomerCreditLimit
- OBPv3.1.0: updateCustomerCreditRatingAndSource
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":true, "lastOkDate":"2019-09-08T00:00:00Z", "title":"title of customer", "branchId":"DERBY6", "nameSuffix":"Sr" } }Required
Fields{ }Dependent
Endpoints
- OBPv3.1.0: updateCustomerIdentity
- OBPv3.1.0: updateCustomerBranch
- OBPv3.1.0: updateCustomerData
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":true, "lastOkDate":"2019-09-08T00:00:00Z", "title":"title of customer", "branchId":"DERBY6", "nameSuffix":"Sr" }] }Required
Fields{ }Dependent
Endpoints
- OBPv2.1.0: getCustomersForCurrentUserAtBank
- OBPv3.0.0: getCustomersForUser
- OBPv5.0.0: getMyCustomersAtAnyBank
- OBPv5.0.0: getMyCustomersAtBank
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":true, "lastOkDate":"2019-09-08T00:00:00Z", "title":"title of customer", "branchId":"DERBY6", "nameSuffix":"Sr" } }Required
Fields{ }Dependent
Endpoints
- OBPv1.4.0: addCustomerMessage
- OBPv2.0.0: getKycDocuments
- OBPv2.0.0: getKycMedia
- OBPv2.0.0: getKycChecks
- OBPv2.0.0: getKycStatuses
- OBPv2.0.0: addKycDocument
- OBPv2.0.0: addKycMedia
- OBPv2.0.0: addKycCheck
- OBPv2.0.0: addKycStatus
- OBPv3.1.0: getCustomerByCustomerId
- OBPv3.1.0: createTaxResidence
- OBPv3.1.0: getTaxResidence
- OBPv3.1.0: deleteTaxResidence
- OBPv3.1.0: createCustomerAddress
- OBPv3.1.0: updateCustomerAddress
- OBPv3.1.0: getCustomerAddresses
- OBPv3.1.0: deleteCustomerAddress
- OBPv3.1.0: createAccountApplication
- OBPv3.1.0: getAccountApplication
- OBPv3.1.0: updateAccountApplicationStatus
- OBPv3.1.0: updateCustomerEmail
- OBPv3.1.0: updateCustomerNumber
- OBPv3.1.0: updateCustomerMobileNumber
- OBPv3.1.0: updateCustomerIdentity
- OBPv3.1.0: updateCustomerCreditLimit
- OBPv3.1.0: updateCustomerCreditRatingAndSource
- OBPv3.1.0: addCardForBank
- OBPv3.1.0: updatedCardForBank
- OBPv3.1.0: updateCustomerBranch
- OBPv3.1.0: updateCustomerData
- OBPv4.0.0: createDirectDebit
- OBPv4.0.0: createDirectDebitManagement
- OBPv4.0.0: createStandingOrder
- OBPv4.0.0: createStandingOrderManagement
- OBPv4.0.0: createCustomerAttribute
- OBPv4.0.0: updateCustomerAttribute
- OBPv4.0.0: getCustomerAttributes
- OBPv4.0.0: getCustomerAttributeById
- OBPv4.0.0: getCustomersByAttributes
- OBPv4.0.0: createUserCustomerLinks
- OBPv4.0.0: getCorrelatedUsersInfoByCustomerId
- OBPv4.0.0: getMyCorrelatedEntities
- OBPv4.0.0: getAccountsMinimalByCustomerId
- OBPv4.0.0: deleteCustomerCascade
- OBPv4.0.0: createCustomerMessage
- OBPv4.0.0: getCustomerMessages
- OBPv5.0.0: addCardForBank
- OBPv5.0.0: createCustomerAccountLink
- OBPv5.0.0: getCustomerAccountLinksByCustomerId
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":true, "lastOkDate":"2019-09-08T00:00:00Z", "title":"title of customer", "branchId":"DERBY6", "nameSuffix":"Sr" } }Required
Fields{ }Dependent
Endpoints
- OBPv3.1.0: getCustomerByCustomerNumber
- OBPv3.1.0: answerUserAuthContextUpdateChallenge
- OBPv5.0.0: answerUserAuthContextUpdateChallenge
- OBPv5.0.0: getCustomerOverview
- OBPv5.0.0: getCustomerOverviewFlat
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
- OBPv3.1.0: getCustomerAddresses
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
- OBPv3.1.0: createCustomerAddress
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
- OBPv3.1.0: updateCustomerAddress
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
- OBPv3.1.0: deleteCustomerAddress
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
- OBPv3.1.0: createTaxResidence
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
- OBPv3.1.0: getTaxResidence
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
- OBPv3.1.0: deleteTaxResidence
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":true, "lastOkDate":"2019-09-08T00:00:00Z", "title":"title of customer", "branchId":"DERBY6", "nameSuffix":"Sr" }] }Required
Fields{ }Dependent
Endpoints
- OBPv3.1.0: getFirehoseCustomers
- OBPv5.0.0: getCustomersAtOneBank
- OBPv5.0.0: getCustomersMinimalAtOneBank
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":true, "lastOkDate":"2019-09-08T00:00:00Z", "title":"title of customer", "branchId":"DERBY6", "nameSuffix":"Sr" }] }Required
Fields{ }Dependent
Endpoints
- OBPv4.0.0: getCustomersByCustomerPhoneNumber
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
- OBPv3.1.0: getCheckbookOrders
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
- OBPv3.1.0: getStatusOfCreditCardOrder
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
- OBPv3.1.0: createUserAuthContext
- OBPv3.1.0: answerUserAuthContextUpdateChallenge
- OBPv5.0.0: createUserAuthContext
- OBPv5.0.0: answerUserAuthContextUpdateChallenge
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
- OBPv3.1.0: deleteUserAuthContexts
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
- OBPv3.1.0: deleteUserAuthContextById
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
- OBPv3.1.0: getUserAuthContexts
- OBPv5.0.0: getUserAuthContexts
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":true }{ "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":true } }Required
Fields{ }Dependent
Endpoints
- OBPv3.1.0: createProductAttribute
- OBPv3.1.0: updateProductAttribute
- OBPv4.0.0: createProductAttribute
- OBPv4.0.0: updateProductAttribute
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":true } }Required
Fields{ }Dependent
Endpoints
- OBPv3.1.0: getProductAttribute
- OBPv3.1.0: updateProductAttribute
- OBPv4.0.0: updateProductAttribute
- OBPv4.0.0: getProductAttribute
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":true }] }Required
Fields{ }Dependent
Endpoints
- OBPv3.1.0: getProduct
- OBPv3.1.0: createAccount
- OBPv4.0.0: createSettlementAccount
- OBPv4.0.0: addAccount
- OBPv4.0.0: getProduct
- OBPv5.0.0: createAccount
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
- OBPv3.1.0: deleteProductAttribute
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
- OBPv3.1.0: updateAccountAttribute
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
- OBPv4.0.0: updateTransactionAttribute
- OBPv4.0.0: getTransactionAttributeById
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
- OBPv3.1.0: createAccountAttribute
- OBPv3.1.0: updateAccountAttribute
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
- OBPv4.0.0: createCustomerAttribute
- OBPv4.0.0: updateCustomerAttribute
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
- OBPv4.0.0: createTransactionAttribute
- OBPv4.0.0: updateTransactionAttribute
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":true }], "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
- OBPv3.1.0: createAccount
- OBPv4.0.0: createSettlementAccount
- OBPv4.0.0: addAccount
- OBPv5.0.0: createAccount
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
- OBPv3.0.0: getFirehoseAccountsAtOneBank
- OBPv3.1.0: getPrivateAccountByIdFull
- OBPv4.0.0: getSettlementAccounts
- OBPv4.0.0: getPrivateAccountByIdFull
- OBPv4.0.0: getAccountByAccountRouting
- OBPv4.0.0: getAccountsByAccountRoutingRegex
- OBPv4.0.0: getFirehoseAccountsAtOneBank
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
- OBPv3.1.0: getCustomerByCustomerId
- OBPv3.1.0: getCustomerByCustomerNumber
- OBPv4.0.0: getCustomerAttributes
- OBPv4.0.0: getCustomersByAttributes
- OBPv5.0.0: getCustomerOverview
- OBPv5.0.0: getCustomerOverviewFlat
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
- OBPv3.1.0: getFirehoseCustomers
- OBPv4.0.0: getCustomersByAttributes
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":true, "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":true, "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
- OBPv3.0.0: getCustomersForUser
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
- OBPv3.0.0: getFirehoseTransactionsForBankAccount
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
- OBPv3.0.0: getFirehoseTransactionsForBankAccount
- OBPv3.0.0: getCoreTransactionsForBankAccount
- OBPv3.0.0: getTransactionsForBankAccount
- OBPv3.1.0: getTransactionByIdForBankAccount
- OBPv4.0.0: getTransactionAttributes
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
- OBPv4.0.0: updateCustomerAttribute
- OBPv4.0.0: getCustomerAttributeById
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
- OBPv3.1.0: createCardAttribute
- OBPv3.1.0: updateCardAttribute
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
- OBPv3.1.0: updateCardAttribute
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
- OBPv3.1.0: getCardForBank
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
- OBPv3.1.0: createAccountApplication
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
- OBPv3.1.0: getAccountApplications
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
- OBPv3.1.0: getAccountApplication
- OBPv3.1.0: updateAccountApplicationStatus
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
- OBPv3.1.0: updateAccountApplicationStatus
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
- OBPv3.1.0: createProductCollection
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
- OBPv3.1.0: createProductCollection
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":true }] }] }Required
Fields{ }Dependent
Endpoints
- OBPv3.1.0: getProductCollection
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
- OBPv3.1.0: createMeeting
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
- OBPv3.1.0: getMeetings
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
- OBPv3.1.0: getMeeting
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":true, "comments":"" } }Required
Fields{ }Dependent
Endpoints
- OBPv2.0.0: addKycCheck
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":"", &quo