API Explorer

Message Docs for Connector: kafka_vSept2018

obp.getAdapterInfo

                            
Gets information about the active general (non bank specific) Adapter that is responding to messages sent by OBP.
Kafka/Akka
Outbound
Inbound
Topic
from.obp.api.1.to.adapter.mf.caseclass.OutboundGetAdapterInfo
to.obp.api.1.caseclass.OutboundGetAdapterInfo
Message
{ "date":"2017-09-19T02:31:05Z" }
{ "data":{ "errorCode":"", "backendMessages":[{ "source":"ESB", "status":"Success", "errorCode":"0", "text":"OK" }], "name":"Obp-Kafka-South", "version":"Sept2018", "git_commit":"59623811dd8a41f6ffe67be46954eee11913dc28", "date":"2017-09-19T02:31:05Z" } }
Required
Fields
{ }
Dependent
Endpoints

obp.getBanks

                            
Gets the banks list on this OBP installation.
Kafka/Akka
Outbound
Inbound
Topic
from.obp.api.1.to.adapter.mf.caseclass.OutboundGetBanks
to.obp.api.1.caseclass.OutboundGetBanks
Message
{ "authInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "cbsToken":"FYIUYF6SUYFSD", "isFirst":true, "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContexts":[{ "key":"CUSTOMER_NUMBER", "value":"5987953" },{ "key":"TOKEN", "value":"qieuriopwoir987ASYDUFISUYDF678u" }], "authViews":[{ "view":{ "id":"owner", "name":"Owner", "description":"This is the owner view" }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"AccountNumber", "address":"546387432" },{ "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":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"Eveline Tripman" }] } }] } }
{ "inboundAuthInfo":{ "cbsToken":"FYIUYF6SUYFSD", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50" }, "status":{ "errorCode":"", "backendMessages":[{ "source":"ESB", "status":"Success", "errorCode":"0", "text":"OK" }] }, "data":[{ "bankId":"gh.29.uk", "name":"sushan", "logo":"TESOBE", "url":"https://tesobe.com/" }] }
Required
Fields
{ }
Dependent
Endpoints

obp.getBank

                            
Get a specific Bank as specified by bankId
Kafka/Akka
Outbound
Inbound
Topic
from.obp.api.1.to.adapter.mf.caseclass.OutboundGetBank
to.obp.api.1.caseclass.OutboundGetBank
Message
{ "authInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "cbsToken":"FYIUYF6SUYFSD", "isFirst":true, "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContexts":[{ "key":"CUSTOMER_NUMBER", "value":"5987953" },{ "key":"TOKEN", "value":"qieuriopwoir987ASYDUFISUYDF678u" }], "authViews":[{ "view":{ "id":"owner", "name":"Owner", "description":"This is the owner view" }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"AccountNumber", "address":"546387432" },{ "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":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"Eveline Tripman" }] } }] }, "bankId":"bankId" }
{ "inboundAuthInfo":{ "cbsToken":"FYIUYF6SUYFSD", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50" }, "status":{ "errorCode":"", "backendMessages":[{ "source":"ESB", "status":"Success", "errorCode":"0", "text":"OK" }] }, "data":{ "bankId":"gh.29.uk", "name":"sushan", "logo":"TESOBE", "url":"https://tesobe.com/" } }
Required
Fields
{ }
Dependent
Endpoints

obp.createMessage

                            
Create Message
Kafka/Akka
Outbound
Inbound
Topic
from.obp.api.1.to.adapter.mf.caseclass.OutBoundCreateMessage
to.obp.api.1.caseclass.OutBoundCreateMessage
Message
{ "outboundAdapterCallContext":{ "correlationId":"string", "sessionId":"string", "consumerId":"string", "generalContext":[{ "key":"string", "value":"string" }], "outboundAdapterAuthInfo":{ "userId":"string", "username":"string", "linkedCustomers":[{ "customerId":"string", "customerNumber":"string", "legalName":"string" }], "userAuthContext":[{ "key":"string", "value":"string" }], "authViews":[{ "view":{ "id":"string", "name":"string", "description":"string" }, "account":{ "id":"string", "accountRoutings":[{ "scheme":"string", "address":"string" }], "customerOwners":[{ "bankId":"string", "customerId":"string", "customerNumber":"string", "legalName":"string", "dateOfBirth":"2020-09-29T20:36:32Z" }], "userOwners":[{ "userId":"string", "emailAddress":"string", "name":"string" }] } }] } }, "user":{ "userPrimaryKey":{ "value":123 }, "userId":"string", "idGivenByProvider":"string", "provider":"string", "emailAddress":"string", "name":"string" }, "bankId":{ "value":"string" }, "message":"string", "fromDepartment":"string", "fromPerson":"string" }
{ "inboundAdapterCallContext":{ "correlationId":"string", "sessionId":"string", "generalContext":[{ "key":"string", "value":"string" }] }, "status":{ "errorCode":"", "backendMessages":[{ "source":"string", "status":"string", "errorCode":"", "text":"string" }] }, "data":{ "messageId":"string", "date":"2020-09-29T20:36:32Z", "message":"string", "fromDepartment":"string", "fromPerson":"string" } }
Required
Fields
{ }
Dependent
Endpoints

obp.createOrUpdateKycCheck

                            
Create Or Update Kyc Check
Kafka/Akka
Outbound
Inbound
Topic
from.obp.api.1.to.adapter.mf.caseclass.OutBoundCreateOrUpdateKycCheck
to.obp.api.1.caseclass.OutBoundCreateOrUpdateKycCheck
Message
{ "outboundAdapterCallContext":{ "correlationId":"string", "sessionId":"string", "consumerId":"string", "generalContext":[{ "key":"string", "value":"string" }], "outboundAdapterAuthInfo":{ "userId":"string", "username":"string", "linkedCustomers":[{ "customerId":"string", "customerNumber":"string", "legalName":"string" }], "userAuthContext":[{ "key":"string", "value":"string" }], "authViews":[{ "view":{ "id":"string", "name":"string", "description":"string" }, "account":{ "id":"string", "accountRoutings":[{ "scheme":"string", "address":"string" }], "customerOwners":[{ "bankId":"string", "customerId":"string", "customerNumber":"string", "legalName":"string", "dateOfBirth":"2020-09-29T20:36:32Z" }], "userOwners":[{ "userId":"string", "emailAddress":"string", "name":"string" }] } }] } }, "bankId":"string", "customerId":"string", "id":"string", "customerNumber":"string", "date":"2020-09-29T20:36:32Z", "how":"string", "staffUserId":"string", "mStaffName":"string", "mSatisfied":true, "comments":"string" }
{ "inboundAdapterCallContext":{ "correlationId":"string", "sessionId":"string", "generalContext":[{ "key":"string", "value":"string" }] }, "status":{ "errorCode":"", "backendMessages":[{ "source":"string", "status":"string", "errorCode":"", "text":"string" }] }, "data":{ "bankId":"string", "customerId":"string", "idKycCheck":"string", "customerNumber":"string", "date":"2020-09-29T20:36:32Z", "how":"string", "staffUserId":"string", "staffName":"string", "satisfied":true, "comments":"string" } }
Required
Fields
{ }
Dependent
Endpoints

obp.createOrUpdateKycDocument

                            
Create Or Update KYC Document
Kafka/Akka
Outbound
Inbound
Topic
from.obp.api.1.to.adapter.mf.caseclass.OutBoundCreateOrUpdateKycDocument
to.obp.api.1.caseclass.OutBoundCreateOrUpdateKycDocument
Message
{ "outboundAdapterCallContext":{ "correlationId":"string", "sessionId":"string", "consumerId":"string", "generalContext":[{ "key":"string", "value":"string" }], "outboundAdapterAuthInfo":{ "userId":"string", "username":"string", "linkedCustomers":[{ "customerId":"string", "customerNumber":"string", "legalName":"string" }], "userAuthContext":[{ "key":"string", "value":"string" }], "authViews":[{ "view":{ "id":"string", "name":"string", "description":"string" }, "account":{ "id":"string", "accountRoutings":[{ "scheme":"string", "address":"string" }], "customerOwners":[{ "bankId":"string", "customerId":"string", "customerNumber":"string", "legalName":"string", "dateOfBirth":"2020-09-29T20:36:32Z" }], "userOwners":[{ "userId":"string", "emailAddress":"string", "name":"string" }] } }] } }, "bankId":"string", "customerId":"string", "id":"string", "customerNumber":"string", "type":"string", "number":"string", "issueDate":"2020-09-29T20:36:32Z", "issuePlace":"string", "expiryDate":"2020-09-29T20:36:32Z" }
{ "inboundAdapterCallContext":{ "correlationId":"string", "sessionId":"string", "generalContext":[{ "key":"string", "value":"string" }] }, "status":{ "errorCode":"", "backendMessages":[{ "source":"string", "status":"string", "errorCode":"", "text":"string" }] }, "data":{ "bankId":"string", "customerId":"string", "idKycDocument":"string", "customerNumber":"string", "type":"string", "number":"string", "issueDate":"2020-09-29T20:36:32Z", "issuePlace":"string", "expiryDate":"2020-09-29T20:36:32Z" } }
Required
Fields
{ }
Dependent
Endpoints

obp.createOrUpdateKycMedia

                            
Create Or Update KYC Media
Kafka/Akka
Outbound
Inbound
Topic
from.obp.api.1.to.adapter.mf.caseclass.OutBoundCreateOrUpdateKycMedia
to.obp.api.1.caseclass.OutBoundCreateOrUpdateKycMedia
Message
{ "outboundAdapterCallContext":{ "correlationId":"string", "sessionId":"string", "consumerId":"string", "generalContext":[{ "key":"string", "value":"string" }], "outboundAdapterAuthInfo":{ "userId":"string", "username":"string", "linkedCustomers":[{ "customerId":"string", "customerNumber":"string", "legalName":"string" }], "userAuthContext":[{ "key":"string", "value":"string" }], "authViews":[{ "view":{ "id":"string", "name":"string", "description":"string" }, "account":{ "id":"string", "accountRoutings":[{ "scheme":"string", "address":"string" }], "customerOwners":[{ "bankId":"string", "customerId":"string", "customerNumber":"string", "legalName":"string", "dateOfBirth":"2020-09-29T20:36:32Z" }], "userOwners":[{ "userId":"string", "emailAddress":"string", "name":"string" }] } }] } }, "bankId":"string", "customerId":"string", "id":"string", "customerNumber":"string", "type":"string", "url":"string", "date":"2020-09-29T20:36:32Z", "relatesToKycDocumentId":"string", "relatesToKycCheckId":"string" }
{ "inboundAdapterCallContext":{ "correlationId":"string", "sessionId":"string", "generalContext":[{ "key":"string", "value":"string" }] }, "status":{ "errorCode":"", "backendMessages":[{ "source":"string", "status":"string", "errorCode":"", "text":"string" }] }, "data":{ "bankId":"string", "customerId":"string", "idKycMedia":"string", "customerNumber":"string", "type":"string", "url":"string", "date":"2020-09-29T20:36:32Z", "relatesToKycDocumentId":"string", "relatesToKycCheckId":"string" } }
Required
Fields
{ }
Dependent
Endpoints

obp.createOrUpdateKycStatus

                            
Create Or Update KYC Status
Kafka/Akka
Outbound
Inbound
Topic
from.obp.api.1.to.adapter.mf.caseclass.OutBoundCreateOrUpdateKycStatus
to.obp.api.1.caseclass.OutBoundCreateOrUpdateKycStatus
Message
{ "outboundAdapterCallContext":{ "correlationId":"string", "sessionId":"string", "consumerId":"string", "generalContext":[{ "key":"string", "value":"string" }], "outboundAdapterAuthInfo":{ "userId":"string", "username":"string", "linkedCustomers":[{ "customerId":"string", "customerNumber":"string", "legalName":"string" }], "userAuthContext":[{ "key":"string", "value":"string" }], "authViews":[{ "view":{ "id":"string", "name":"string", "description":"string" }, "account":{ "id":"string", "accountRoutings":[{ "scheme":"string", "address":"string" }], "customerOwners":[{ "bankId":"string", "customerId":"string", "customerNumber":"string", "legalName":"string", "dateOfBirth":"2020-09-29T20:36:32Z" }], "userOwners":[{ "userId":"string", "emailAddress":"string", "name":"string" }] } }] } }, "bankId":"string", "customerId":"string", "customerNumber":"string", "ok":true, "date":"2020-09-29T20:36:32Z" }
{ "inboundAdapterCallContext":{ "correlationId":"string", "sessionId":"string", "generalContext":[{ "key":"string", "value":"string" }] }, "status":{ "errorCode":"", "backendMessages":[{ "source":"string", "status":"string", "errorCode":"", "text":"string" }] }, "data":{ "bankId":"string", "customerId":"string", "customerNumber":"string", "ok":true, "date":"2020-09-29T20:36:32Z" } }
Required
Fields
{ }
Dependent
Endpoints

obp.getKycDocuments

                            
Get KYC Documents
Kafka/Akka
Outbound
Inbound
Topic
from.obp.api.1.to.adapter.mf.caseclass.OutBoundGetKycDocuments
to.obp.api.1.caseclass.OutBoundGetKycDocuments
Message
{ "outboundAdapterCallContext":{ "correlationId":"string", "sessionId":"string", "consumerId":"string", "generalContext":[{ "key":"string", "value":"string" }], "outboundAdapterAuthInfo":{ "userId":"string", "username":"string", "linkedCustomers":[{ "customerId":"string", "customerNumber":"string", "legalName":"string" }], "userAuthContext":[{ "key":"string", "value":"string" }], "authViews":[{ "view":{ "id":"string", "name":"string", "description":"string" }, "account":{ "id":"string", "accountRoutings":[{ "scheme":"string", "address":"string" }], "customerOwners":[{ "bankId":"string", "customerId":"string", "customerNumber":"string", "legalName":"string", "dateOfBirth":"2020-09-29T20:36:32Z" }], "userOwners":[{ "userId":"string", "emailAddress":"string", "name":"string" }] } }] } }, "customerId":"string" }
{ "inboundAdapterCallContext":{ "correlationId":"string", "sessionId":"string", "generalContext":[{ "key":"string", "value":"string" }] }, "status":{ "errorCode":"", "backendMessages":[{ "source":"string", "status":"string", "errorCode":"", "text":"string" }] }, "data":[{ "bankId":"string", "customerId":"string", "idKycDocument":"string", "customerNumber":"string", "type":"string", "number":"string", "issueDate":"2020-09-29T20:36:32Z", "issuePlace":"string", "expiryDate":"2020-09-29T20:36:32Z" }] }
Required
Fields
{ }
Dependent
Endpoints

obp.getKycMedias

                            
Get KYC Medias
Kafka/Akka
Outbound
Inbound
Topic
from.obp.api.1.to.adapter.mf.caseclass.OutBoundGetKycMedias
to.obp.api.1.caseclass.OutBoundGetKycMedias
Message
{ "outboundAdapterCallContext":{ "correlationId":"string", "sessionId":"string", "consumerId":"string", "generalContext":[{ "key":"string", "value":"string" }], "outboundAdapterAuthInfo":{ "userId":"string", "username":"string", "linkedCustomers":[{ "customerId":"string", "customerNumber":"string", "legalName":"string" }], "userAuthContext":[{ "key":"string", "value":"string" }], "authViews":[{ "view":{ "id":"string", "name":"string", "description":"string" }, "account":{ "id":"string", "accountRoutings":[{ "scheme":"string", "address":"string" }], "customerOwners":[{ "bankId":"string", "customerId":"string", "customerNumber":"string", "legalName":"string", "dateOfBirth":"2020-09-29T20:36:32Z" }], "userOwners":[{ "userId":"string", "emailAddress":"string", "name":"string" }] } }] } }, "customerId":"string" }
{ "inboundAdapterCallContext":{ "correlationId":"string", "sessionId":"string", "generalContext":[{ "key":"string", "value":"string" }] }, "status":{ "errorCode":"", "backendMessages":[{ "source":"string", "status":"string", "errorCode":"", "text":"string" }] }, "data":[{ "bankId":"string", "customerId":"string", "idKycMedia":"string", "customerNumber":"string", "type":"string", "url":"string", "date":"2020-09-29T20:36:32Z", "relatesToKycDocumentId":"string", "relatesToKycCheckId":"string" }] }
Required
Fields
{ }
Dependent
Endpoints

obp.getKycStatuses

                            
Get KYC Statuses
Kafka/Akka
Outbound
Inbound
Topic
from.obp.api.1.to.adapter.mf.caseclass.OutBoundGetKycStatuses
to.obp.api.1.caseclass.OutBoundGetKycStatuses
Message
{ "outboundAdapterCallContext":{ "correlationId":"string", "sessionId":"string", "consumerId":"string", "generalContext":[{ "key":"string", "value":"string" }], "outboundAdapterAuthInfo":{ "userId":"string", "username":"string", "linkedCustomers":[{ "customerId":"string", "customerNumber":"string", "legalName":"string" }], "userAuthContext":[{ "key":"string", "value":"string" }], "authViews":[{ "view":{ "id":"string", "name":"string", "description":"string" }, "account":{ "id":"string", "accountRoutings":[{ "scheme":"string", "address":"string" }], "customerOwners":[{ "bankId":"string", "customerId":"string", "customerNumber":"string", "legalName":"string", "dateOfBirth":"2020-09-29T20:36:32Z" }], "userOwners":[{ "userId":"string", "emailAddress":"string", "name":"string" }] } }] } }, "customerId":"string" }
{ "inboundAdapterCallContext":{ "correlationId":"string", "sessionId":"string", "generalContext":[{ "key":"string", "value":"string" }] }, "status":{ "errorCode":"", "backendMessages":[{ "source":"string", "status":"string", "errorCode":"", "text":"string" }] }, "data":[{ "bankId":"string", "customerId":"string", "customerNumber":"string", "ok":true, "date":"2020-09-29T20:36:32Z" }] }
Required
Fields
{ }
Dependent
Endpoints

obp.getKycChecks

                            
Get KYC Checks
Kafka/Akka
Outbound
Inbound
Topic
from.obp.api.1.to.adapter.mf.caseclass.OutBoundGetKycChecks
to.obp.api.1.caseclass.OutBoundGetKycChecks
Message
{ "outboundAdapterCallContext":{ "correlationId":"string", "sessionId":"string", "consumerId":"string", "generalContext":[{ "key":"string", "value":"string" }], "outboundAdapterAuthInfo":{ "userId":"string", "username":"string", "linkedCustomers":[{ "customerId":"string", "customerNumber":"string", "legalName":"string" }], "userAuthContext":[{ "key":"string", "value":"string" }], "authViews":[{ "view":{ "id":"string", "name":"string", "description":"string" }, "account":{ "id":"string", "accountRoutings":[{ "scheme":"string", "address":"string" }], "customerOwners":[{ "bankId":"string", "customerId":"string", "customerNumber":"string", "legalName":"string", "dateOfBirth":"2020-09-29T20:36:32Z" }], "userOwners":[{ "userId":"string", "emailAddress":"string", "name":"string" }] } }] } }, "customerId":"string" }
{ "inboundAdapterCallContext":{ "correlationId":"string", "sessionId":"string", "generalContext":[{ "key":"string", "value":"string" }] }, "status":{ "errorCode":"", "backendMessages":[{ "source":"string", "status":"string", "errorCode":"", "text":"string" }] }, "data":[{ "bankId":"string", "customerId":"string", "idKycCheck":"string", "customerNumber":"string", "date":"2020-09-29T20:36:32Z", "how":"string", "staffUserId":"string", "staffName":"string", "satisfied":true, "comments":"string" }] }
Required
Fields
{ }
Dependent
Endpoints

obp.createMeeting

                            
Create Meeting
Kafka/Akka
Outbound
Inbound
Topic
from.obp.api.1.to.adapter.mf.caseclass.OutBoundCreateMeeting
from.obp.api.1.to.adapter.mf.caseclass.OutBoundCreateMeeting
Message
{ "outboundAdapterCallContext":{ "correlationId":"string", "sessionId":"string", "consumerId":"string", "generalContext":[{ "key":"string", "value":"string" }], "outboundAdapterAuthInfo":{ "userId":"string", "username":"string", "linkedCustomers":[{ "customerId":"string", "customerNumber":"string", "legalName":"string" }], "userAuthContext":[{ "key":"string", "value":"string" }], "authViews":[{ "view":{ "id":"string", "name":"string", "description":"string" }, "account":{ "id":"string", "accountRoutings":[{ "scheme":"string", "address":"string" }], "customerOwners":[{ "bankId":"string", "customerId":"string", "customerNumber":"string", "legalName":"string", "dateOfBirth":"2020-09-29T20:36:32Z" }], "userOwners":[{ "userId":"string", "emailAddress":"string", "name":"string" }] } }] } }, "bankId":{ "value":"string" }, "staffUser":{ "userPrimaryKey":{ "value":123 }, "userId":"string", "idGivenByProvider":"string", "provider":"string", "emailAddress":"string", "name":"string" }, "customerUser":{ "userPrimaryKey":{ "value":123 }, "userId":"string", "idGivenByProvider":"string", "provider":"string", "emailAddress":"string", "name":"string" }, "providerId":"string", "purposeId":"string", "when":"2020-09-29T20:36:32Z", "sessionId":"string", "customerToken":"string", "staffToken":"string", "creator":{ "name":"string", "phone":"string", "email":"string" }, "invitees":[{ "contactDetails":{ "name":"string", "phone":"string", "email":"string" }, "status":"string" }] }
{ "inboundAdapterCallContext":{ "correlationId":"string", "sessionId":"string", "generalContext":[{ "key":"string", "value":"string" }] }, "status":{ "errorCode":"", "backendMessages":[{ "source":"string", "status":"string", "errorCode":"", "text":"string" }] }, "data":{ "meetingId":"string", "providerId":"string", "purposeId":"string", "bankId":"string", "present":{ "staffUserId":"string", "customerUserId":"string" }, "keys":{ "sessionId":"string", "customerToken":"string", "staffToken":"string" }, "when":"2020-09-29T20:36:32Z", "creator":{ "name":"string", "phone":"string", "email":"string" }, "invitees":[{ "contactDetails":{ "name":"string", "phone":"string", "email":"string" }, "status":"string" }] } }
Required
Fields
{ }
Dependent
Endpoints

obp.createBankAccount

                            
Create Bank Account
Kafka/Akka
Outbound
Inbound
Topic
from.obp.api.1.to.adapter.mf.caseclass.OutBoundCreateBankAccount
to.obp.api.1.caseclass.OutBoundCreateBankAccount
Message
{ "outboundAdapterCallContext":{ "correlationId":"string", "sessionId":"string", "consumerId":"string", "generalContext":[{ "key":"string", "value":"string" }], "outboundAdapterAuthInfo":{ "userId":"string", "username":"string", "linkedCustomers":[{ "customerId":"string", "customerNumber":"string", "legalName":"string" }], "userAuthContext":[{ "key":"string", "value":"string" }], "authViews":[{ "view":{ "id":"string", "name":"string", "description":"string" }, "account":{ "id":"string", "accountRoutings":[{ "scheme":"string", "address":"string" }], "customerOwners":[{ "bankId":"string", "customerId":"string", "customerNumber":"string", "legalName":"string", "dateOfBirth":"2020-09-29T20:36:32Z" }], "userOwners":[{ "userId":"string", "emailAddress":"string", "name":"string" }] } }] } }, "bankId":{ "value":"string" }, "accountId":{ "value":"string" }, "accountType":"string", "accountLabel":"string", "currency":"string", "initialBalance":"123.321", "accountHolderName":"string", "branchId":"string", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }] }
{ "inboundAdapterCallContext":{ "correlationId":"string", "sessionId":"string", "generalContext":[{ "key":"string", "value":"string" }] }, "status":{ "errorCode":"", "backendMessages":[{ "source":"string", "status":"string", "errorCode":"", "text":"string" }] }, "data":{ "accountId":{ "value":"string" }, "accountType":"string", "balance":"123.321", "currency":"string", "name":"string", "number":"string", "bankId":{ "value":"string" }, "lastUpdate":"2020-09-29T20:36:32Z", "branchId":"string", "accountRoutings":[{ "scheme":"string", "address":"string" }] } }
Required
Fields
{ }
Dependent
Endpoints

obp.getBankAccountsHeld

                            
Get Accounts held by the current User if even the User has not been assigned the owner View yet.
Kafka/Akka
Outbound
Inbound
Topic
from.obp.api.1.to.adapter.mf.caseclass.OutboundGetBankAccountsHeld
to.obp.api.1.caseclass.OutboundGetBankAccountsHeld
Message
{ "authInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "cbsToken":"FYIUYF6SUYFSD", "isFirst":true, "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContexts":[{ "key":"CUSTOMER_NUMBER", "value":"5987953" },{ "key":"TOKEN", "value":"qieuriopwoir987ASYDUFISUYDF678u" }], "authViews":[{ "view":{ "id":"owner", "name":"Owner", "description":"This is the owner view" }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"AccountNumber", "address":"546387432" },{ "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":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"Eveline Tripman" }] } }] }, "bankIdAccountIds":[{ "bankId":{ "value":"gh.29.uk" }, "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" } }] }
{ "inboundAuthInfo":{ "cbsToken":"FYIUYF6SUYFSD", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50" }, "status":{ "errorCode":"", "backendMessages":[{ "source":"ESB", "status":"Success", "errorCode":"0", "text":"OK" }] }, "data":[{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "bankId":"gh.29.uk", "number":"546387432", "accountRoutings":[{ "scheme":"AccountNumber", "address":"546387432" }] }] }
Required
Fields
{ }
Dependent
Endpoints

obp.getCoreBankAccounts

                            
Get bank Accounts available to the User (without Metadata)
Kafka/Akka
Outbound
Inbound
Topic
from.obp.api.1.to.adapter.mf.caseclass.OutboundGetCoreBankAccounts
to.obp.api.1.caseclass.OutboundGetCoreBankAccounts
Message
{ "authInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "cbsToken":"FYIUYF6SUYFSD", "isFirst":true, "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContexts":[{ "key":"CUSTOMER_NUMBER", "value":"5987953" },{ "key":"TOKEN", "value":"qieuriopwoir987ASYDUFISUYDF678u" }], "authViews":[{ "view":{ "id":"owner", "name":"Owner", "description":"This is the owner view" }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"AccountNumber", "address":"546387432" },{ "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":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"Eveline Tripman" }] } }] }, "bankIdAccountIds":[{ "bankId":{ "value":"gh.29.uk" }, "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" } }] }
{ "inboundAuthInfo":{ "cbsToken":"FYIUYF6SUYFSD", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50" }, "data":[{ "errorCode":"", "backendMessages":[{ "source":"ESB", "status":"Success", "errorCode":"0", "text":"OK" }], "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "label":"My Account", "bankId":"gh.29.uk", "accountType":"AC", "accountRoutings":[{ "scheme":"AccountNumber", "address":"546387432" }] }] }
Required
Fields
{ }
Dependent
Endpoints

obp.checkBankAccountExists

                            
Check a bank Account exists - as specified by bankId and accountId.
Kafka/Akka
Outbound
Inbound
Topic
from.obp.api.1.to.adapter.mf.caseclass.OutboundCheckBankAccountExists
to.obp.api.1.caseclass.OutboundCheckBankAccountExists
Message
{ "authInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "cbsToken":"FYIUYF6SUYFSD", "isFirst":true, "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContexts":[{ "key":"CUSTOMER_NUMBER", "value":"5987953" },{ "key":"TOKEN", "value":"qieuriopwoir987ASYDUFISUYDF678u" }], "authViews":[{ "view":{ "id":"owner", "name":"Owner", "description":"This is the owner view" }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"AccountNumber", "address":"546387432" },{ "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":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"Eveline Tripman" }] } }] }, "bankId":"gh.29.uk", "accountId":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }
{ "inboundAuthInfo":{ "cbsToken":"FYIUYF6SUYFSD", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50" }, "status":{ "errorCode":"", "backendMessages":[{ "source":"ESB", "status":"Success", "errorCode":"0", "text":"OK" }] }, "data":{ "errorCode":"500-OFFLINE", "cbsToken":"FYIUYF6SUYFSD", "bankId":"gh.29.uk", "branchId":"DERBY6", "accountId":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountNumber":"546387432", "accountType":"AC", "balanceAmount":"50.89", "balanceCurrency":"EUR", "owners":["SusanSmith","SusanSmith"], "viewsToGenerate":["_Public","Accountant","Auditor"], "bankRoutingScheme":"BIC", "bankRoutingAddress":"GENODEM1GLS", "branchRoutingScheme":"BRANCH-CODE", "branchRoutingAddress":"DERBY6", "accountRoutingScheme":"IBAN", "accountRoutingAddress":"DE91 1000 0000 0123 4567 89", "accountRouting":[], "accountRules":[] } }
Required
Fields
{ }
Dependent
Endpoints

obp.getBankAccountsForUser

                            
Gets the list of accounts available to the User. This call sends authInfo including username.
Kafka/Akka
Outbound
Inbound
Topic
from.obp.api.1.to.adapter.mf.caseclass.OutboundGetAccounts
to.obp.api.1.caseclass.InboundGetAccounts
Message
{ "authInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "cbsToken":"FYIUYF6SUYFSD", "isFirst":true, "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContexts":[{ "key":"CUSTOMER_NUMBER", "value":"5987953" },{ "key":"TOKEN", "value":"qieuriopwoir987ASYDUFISUYDF678u" }], "authViews":[{ "view":{ "id":"owner", "name":"Owner", "description":"This is the owner view" }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"AccountNumber", "address":"546387432" },{ "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":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"Eveline Tripman" }] } }] }, "customers":{ "customers":[{ "bankId":"gh.29.uk", "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman", "dateOfBirth":"2017-09-19T00:00:00Z" }] } }
{ "inboundAuthInfo":{ "cbsToken":"FYIUYF6SUYFSD", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50" }, "status":{ "errorCode":"", "backendMessages":[{ "source":"ESB", "status":"Success", "errorCode":"0", "text":"OK" }] }, "data":[{ "errorCode":"500-OFFLINE", "cbsToken":"FYIUYF6SUYFSD", "bankId":"gh.29.uk", "branchId":"DERBY6", "accountId":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountNumber":"546387432", "accountType":"AC", "balanceAmount":"50.89", "balanceCurrency":"EUR", "owners":["SusanSmith","SusanSmith"], "viewsToGenerate":["_Public","Accountant","Auditor"], "bankRoutingScheme":"BIC", "bankRoutingAddress":"GENODEM1GLS", "branchRoutingScheme":"BRANCH-CODE", "branchRoutingAddress":"DERBY6", "accountRoutingScheme":"IBAN", "accountRoutingAddress":"DE91 1000 0000 0123 4567 89", "accountRouting":[], "accountRules":[] }] }
Required
Fields
{ }
Dependent
Endpoints

obp.getBankAccount

                            
Get a single Account as specified by the bankId and accountId.
Kafka/Akka
Outbound
Inbound
Topic
from.obp.api.1.to.adapter.mf.caseclass.OutboundGetAccountbyAccountID
to.obp.api.1.caseclass.OutboundGetAccountbyAccountID
Message
{ "authInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "cbsToken":"FYIUYF6SUYFSD", "isFirst":true, "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContexts":[{ "key":"CUSTOMER_NUMBER", "value":"5987953" },{ "key":"TOKEN", "value":"qieuriopwoir987ASYDUFISUYDF678u" }], "authViews":[{ "view":{ "id":"owner", "name":"Owner", "description":"This is the owner view" }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"AccountNumber", "address":"546387432" },{ "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":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"Eveline Tripman" }] } }] }, "bankId":"bankId", "accountId":"accountId" }
{ "inboundAuthInfo":{ "cbsToken":"FYIUYF6SUYFSD", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50" }, "status":{ "errorCode":"", "backendMessages":[{ "source":"ESB", "status":"Success", "errorCode":"0", "text":"OK" }] }, "data":{ "errorCode":"500-OFFLINE", "cbsToken":"FYIUYF6SUYFSD", "bankId":"gh.29.uk", "branchId":"DERBY6", "accountId":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountNumber":"546387432", "accountType":"AC", "balanceAmount":"50.89", "balanceCurrency":"EUR", "owners":["SusanSmith","SusanSmith"], "viewsToGenerate":["_Public","Accountant","Auditor"], "bankRoutingScheme":"BIC", "bankRoutingAddress":"GENODEM1GLS", "branchRoutingScheme":"BRANCH-CODE", "branchRoutingAddress":"DERBY6", "accountRoutingScheme":"IBAN", "accountRoutingAddress":"DE91 1000 0000 0123 4567 89", "accountRouting":[], "accountRules":[] } }
Required
Fields
{ }
Dependent
Endpoints

    obp.getCustomersByUserIdFuture

                                
    Get Customers represented by the User.
    Kafka/Akka
    Outbound
    Inbound
    Topic
    from.obp.api.1.to.adapter.mf.caseclass.OutboundGetCustomersByUserId
    to.obp.api.1.caseclass.OutboundGetCustomersByUserId
    Message
    { "authInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "cbsToken":"FYIUYF6SUYFSD", "isFirst":true, "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContexts":[{ "key":"CUSTOMER_NUMBER", "value":"5987953" },{ "key":"TOKEN", "value":"qieuriopwoir987ASYDUFISUYDF678u" }], "authViews":[{ "view":{ "id":"owner", "name":"Owner", "description":"This is the owner view" }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"AccountNumber", "address":"546387432" },{ "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":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"Eveline Tripman" }] } }] } }
    { "inboundAuthInfo":{ "cbsToken":"FYIUYF6SUYFSD", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50" }, "status":{ "errorCode":"", "backendMessages":[{ "source":"ESB", "status":"Success", "errorCode":"0", "text":"OK" }] }, "data":[{ "customerId":"String", "bankId":"gh.29.uk", "number":"String", "legalName":"String", "mobileNumber":"String", "email":"String", "faceImage":{ "date":"2017-09-19T00:00:00Z", "url":"String" }, "dateOfBirth":"2017-09-19T00:00:00Z", "relationshipStatus":"String", "dependents":1, "dobOfDependents":["2017-09-19T00:00:00Z"], "highestEducationAttained":"String", "employmentStatus":"String", "creditRating":{ "rating":"String", "source":"String" }, "creditLimit":{ "currency":"String", "amount":"String" }, "kycStatus":false, "lastOkDate":"2017-09-19T00:00:00Z" }] }
    Required
    Fields
    { }
    Dependent
    Endpoints

      obp.createCustomer

                                  
      Create Customer
      Kafka/Akka
      Outbound
      Inbound
      Topic
      from.obp.api.1.to.adapter.mf.caseclass.OutBoundCreateCustomer
      to.obp.api.1.caseclass.OutBoundCreateCustomer
      Message
      { "outboundAdapterCallContext":{ "correlationId":"string", "sessionId":"string", "consumerId":"string", "generalContext":[{ "key":"string", "value":"string" }], "outboundAdapterAuthInfo":{ "userId":"string", "username":"string", "linkedCustomers":[{ "customerId":"string", "customerNumber":"string", "legalName":"string" }], "userAuthContext":[{ "key":"string", "value":"string" }], "authViews":[{ "view":{ "id":"string", "name":"string", "description":"string" }, "account":{ "id":"string", "accountRoutings":[{ "scheme":"string", "address":"string" }], "customerOwners":[{ "bankId":"string", "customerId":"string", "customerNumber":"string", "legalName":"string", "dateOfBirth":"2020-09-29T20:36:32Z" }], "userOwners":[{ "userId":"string", "emailAddress":"string", "name":"string" }] } }] } }, "bankId":{ "value":"string" }, "legalName":"string", "mobileNumber":"string", "email":"string", "faceImage":{ "date":"2020-09-29T20:36:32Z", "url":"string" }, "dateOfBirth":"2020-09-29T20:36:32Z", "relationshipStatus":"string", "dependents":123, "dobOfDependents":["2020-09-29T20:36:32Z"], "highestEducationAttained":"string", "employmentStatus":"string", "kycStatus":true, "lastOkDate":"2020-09-29T20:36:32Z", "creditRating":{ "rating":"string", "source":"string" }, "creditLimit":{ "currency":"string", "amount":"string" }, "title":"string", "branchId":"string", "nameSuffix":"string" }
      { "inboundAdapterCallContext":{ "correlationId":"string", "sessionId":"string", "generalContext":[{ "key":"string", "value":"string" }] }, "status":{ "errorCode":"", "backendMessages":[{ "source":"string", "status":"string", "errorCode":"", "text":"string" }] }, "data":{ "customerId":"string", "bankId":"string", "number":"string", "legalName":"string", "mobileNumber":"string", "email":"string", "faceImage":{ "date":"2020-09-29T20:36:32Z", "url":"string" }, "dateOfBirth":"2020-09-29T20:36:32Z", "relationshipStatus":"string", "dependents":123, "dobOfDependents":["2020-09-29T20:36:32Z"], "highestEducationAttained":"string", "employmentStatus":"string", "creditRating":{ "rating":"string", "source":"string" }, "creditLimit":{ "currency":"string", "amount":"string" }, "kycStatus":true, "lastOkDate":"2020-09-29T20:36:32Z", "title":"string", "branchId":"string", "nameSuffix":"string" } }
      Required
      Fields
      { }
      Dependent
      Endpoints

      obp.createOrUpdateKycCheck

                                  
      Create Or Update Kyc Check
      Kafka/Akka
      Outbound
      Inbound
      Topic
      from.obp.api.1.to.adapter.mf.caseclass.OutBoundCreateOrUpdateKycCheck
      to.obp.api.1.caseclass.OutBoundCreateOrUpdateKycCheck
      Message
      { "outboundAdapterCallContext":{ "correlationId":"string", "sessionId":"string", "consumerId":"string", "generalContext":[{ "key":"string", "value":"string" }], "outboundAdapterAuthInfo":{ "userId":"string", "username":"string", "linkedCustomers":[{ "customerId":"string", "customerNumber":"string", "legalName":"string" }], "userAuthContext":[{ "key":"string", "value":"string" }], "authViews":[{ "view":{ "id":"string", "name":"string", "description":"string" }, "account":{ "id":"string", "accountRoutings":[{ "scheme":"string", "address":"string" }], "customerOwners":[{ "bankId":"string", "customerId":"string", "customerNumber":"string", "legalName":"string", "dateOfBirth":"2020-09-29T20:36:32Z" }], "userOwners":[{ "userId":"string", "emailAddress":"string", "name":"string" }] } }] } }, "bankId":"string", "customerId":"string", "id":"string", "customerNumber":"string", "date":"2020-09-29T20:36:32Z", "how":"string", "staffUserId":"string", "mStaffName":"string", "mSatisfied":true, "comments":"string" }
      { "inboundAdapterCallContext":{ "correlationId":"string", "sessionId":"string", "generalContext":[{ "key":"string", "value":"string" }] }, "status":{ "errorCode":"", "backendMessages":[{ "source":"string", "status":"string", "errorCode":"", "text":"string" }] }, "data":{ "bankId":"string", "customerId":"string", "idKycCheck":"string", "customerNumber":"string", "date":"2020-09-29T20:36:32Z", "how":"string", "staffUserId":"string", "staffName":"string", "satisfied":true, "comments":"string" } }
      Required
      Fields
      { }
      Dependent
      Endpoints

      obp.createOrUpdateKycDocument

                                  
      Create Or Update Kyc Document
      Kafka/Akka
      Outbound
      Inbound
      Topic
      from.obp.api.1.to.adapter.mf.caseclass.OutBoundCreateOrUpdateKycDocument
      to.obp.api.1.caseclass.OutBoundCreateOrUpdateKycDocument
      Message
      { "outboundAdapterCallContext":{ "correlationId":"string", "sessionId":"string", "consumerId":"string", "generalContext":[{ "key":"string", "value":"string" }], "outboundAdapterAuthInfo":{ "userId":"string", "username":"string", "linkedCustomers":[{ "customerId":"string", "customerNumber":"string", "legalName":"string" }], "userAuthContext":[{ "key":"string", "value":"string" }], "authViews":[{ "view":{ "id":"string", "name":"string", "description":"string" }, "account":{ "id":"string", "accountRoutings":[{ "scheme":"string", "address":"string" }], "customerOwners":[{ "bankId":"string", "customerId":"string", "customerNumber":"string", "legalName":"string", "dateOfBirth":"2020-09-29T20:36:32Z" }], "userOwners":[{ "userId":"string", "emailAddress":"string", "name":"string" }] } }] } }, "bankId":"string", "customerId":"string", "id":"string", "customerNumber":"string", "type":"string", "number":"string", "issueDate":"2020-09-29T20:36:32Z", "issuePlace":"string", "expiryDate":"2020-09-29T20:36:32Z" }
      { "inboundAdapterCallContext":{ "correlationId":"string", "sessionId":"string", "generalContext":[{ "key":"string", "value":"string" }] }, "status":{ "errorCode":"", "backendMessages":[{ "source":"string", "status":"string", "errorCode":"", "text":"string" }] }, "data":{ "bankId":"string", "customerId":"string", "idKycDocument":"string", "customerNumber":"string", "type":"string", "number":"string", "issueDate":"2020-09-29T20:36:32Z", "issuePlace":"string", "expiryDate":"2020-09-29T20:36:32Z" } }
      Required
      Fields
      { }
      Dependent
      Endpoints

      obp.createOrUpdateKycMedia

                                  
      Create Or Update Kyc Media
      Kafka/Akka
      Outbound
      Inbound
      Topic
      from.obp.api.1.to.adapter.mf.caseclass.OutBoundCreateOrUpdateKycMedia
      to.obp.api.1.caseclass.OutBoundCreateOrUpdateKycMedia
      Message
      { "outboundAdapterCallContext":{ "correlationId":"string", "sessionId":"string", "consumerId":"string", "generalContext":[{ "key":"string", "value":"string" }], "outboundAdapterAuthInfo":{ "userId":"string", "username":"string", "linkedCustomers":[{ "customerId":"string", "customerNumber":"string", "legalName":"string" }], "userAuthContext":[{ "key":"string", "value":"string" }], "authViews":[{ "view":{ "id":"string", "name":"string", "description":"string" }, "account":{ "id":"string", "accountRoutings":[{ "scheme":"string", "address":"string" }], "customerOwners":[{ "bankId":"string", "customerId":"string", "customerNumber":"string", "legalName":"string", "dateOfBirth":"2020-09-29T20:36:32Z" }], "userOwners":[{ "userId":"string", "emailAddress":"string", "name":"string" }] } }] } }, "bankId":"string", "customerId":"string", "id":"string", "customerNumber":"string", "type":"string", "url":"string", "date":"2020-09-29T20:36:32Z", "relatesToKycDocumentId":"string", "relatesToKycCheckId":"string" }
      { "inboundAdapterCallContext":{ "correlationId":"string", "sessionId":"string", "generalContext":[{ "key":"string", "value":"string" }] }, "status":{ "errorCode":"", "backendMessages":[{ "source":"string", "status":"string", "errorCode":"", "text":"string" }] }, "data":{ "bankId":"string", "customerId":"string", "idKycMedia":"string", "customerNumber":"string", "type":"string", "url":"string", "date":"2020-09-29T20:36:32Z", "relatesToKycDocumentId":"string", "relatesToKycCheckId":"string" } }
      Required
      Fields
      { }
      Dependent
      Endpoints

      obp.createOrUpdateKycStatus

                                  
      Create Or Update Kyc Status
      Kafka/Akka
      Outbound
      Inbound
      Topic
      from.obp.api.1.to.adapter.mf.caseclass.OutBoundCreateOrUpdateKycStatus
      to.obp.api.1.caseclass.OutBoundCreateOrUpdateKycStatus
      Message
      { "outboundAdapterCallContext":{ "correlationId":"string", "sessionId":"string", "consumerId":"string", "generalContext":[{ "key":"string", "value":"string" }], "outboundAdapterAuthInfo":{ "userId":"string", "username":"string", "linkedCustomers":[{ "customerId":"string", "customerNumber":"string", "legalName":"string" }], "userAuthContext":[{ "key":"string", "value":"string" }], "authViews":[{ "view":{ "id":"string", "name":"string", "description":"string" }, "account":{ "id":"string", "accountRoutings":[{ "scheme":"string", "address":"string" }], "customerOwners":[{ "bankId":"string", "customerId":"string", "customerNumber":"string", "legalName":"string", "dateOfBirth":"2020-09-29T20:36:32Z" }], "userOwners":[{ "userId":"string", "emailAddress":"string", "name":"string" }] } }] } }, "bankId":"string", "customerId":"string", "customerNumber":"string", "ok":true, "date":"2020-09-29T20:36:32Z" }
      { "inboundAdapterCallContext":{ "correlationId":"string", "sessionId":"string", "generalContext":[{ "key":"string", "value":"string" }] }, "status":{ "errorCode":"", "backendMessages":[{ "source":"string", "status":"string", "errorCode":"", "text":"string" }] }, "data":{ "bankId":"string", "customerId":"string", "customerNumber":"string", "ok":true, "date":"2020-09-29T20:36:32Z" } }
      Required
      Fields
      { }
      Dependent
      Endpoints

      obp.getKycChecks

                                  
      Get Kyc Checks
      Kafka/Akka
      Outbound
      Inbound
      Topic
      from.obp.api.1.to.adapter.mf.caseclass.OutBoundGetKycChecks
      to.obp.api.1.caseclass.OutBoundGetKycChecks
      Message
      { "outboundAdapterCallContext":{ "correlationId":"string", "sessionId":"string", "consumerId":"string", "generalContext":[{ "key":"string", "value":"string" }], "outboundAdapterAuthInfo":{ "userId":"string", "username":"string", "linkedCustomers":[{ "customerId":"string", "customerNumber":"string", "legalName":"string" }], "userAuthContext":[{ "key":"string", "value":"string" }], "authViews":[{ "view":{ "id":"string", "name":"string", "description":"string" }, "account":{ "id":"string", "accountRoutings":[{ "scheme":"string", "address":"string" }], "customerOwners":[{ "bankId":"string", "customerId":"string", "customerNumber":"string", "legalName":"string", "dateOfBirth":"2020-09-29T20:36:32Z" }], "userOwners":[{ "userId":"string", "emailAddress":"string", "name":"string" }] } }] } }, "customerId":"string" }
      { "inboundAdapterCallContext":{ "correlationId":"string", "sessionId":"string", "generalContext":[{ "key":"string", "value":"string" }] }, "status":{ "errorCode":"", "backendMessages":[{ "source":"string", "status":"string", "errorCode":"", "text":"string" }] }, "data":[{ "bankId":"string", "customerId":"string", "idKycCheck":"string", "customerNumber":"string", "date":"2020-09-29T20:36:32Z", "how":"string", "staffUserId":"string", "staffName":"string", "satisfied":true, "comments":"string" }] }
      Required
      Fields
      { }
      Dependent
      Endpoints

      obp.getKycDocuments

                                  
      Get Kyc Documents
      Kafka/Akka
      Outbound
      Inbound
      Topic
      from.obp.api.1.to.adapter.mf.caseclass.OutBoundGetKycDocuments
      to.obp.api.1.caseclass.OutBoundGetKycDocuments
      Message
      { "outboundAdapterCallContext":{ "correlationId":"string", "sessionId":"string", "consumerId":"string", "generalContext":[{ "key":"string", "value":"string" }], "outboundAdapterAuthInfo":{ "userId":"string", "username":"string", "linkedCustomers":[{ "customerId":"string", "customerNumber":"string", "legalName":"string" }], "userAuthContext":[{ "key":"string", "value":"string" }], "authViews":[{ "view":{ "id":"string", "name":"string", "description":"string" }, "account":{ "id":"string", "accountRoutings":[{ "scheme":"string", "address":"string" }], "customerOwners":[{ "bankId":"string", "customerId":"string", "customerNumber":"string", "legalName":"string", "dateOfBirth":"2020-09-29T20:36:32Z" }], "userOwners":[{ "userId":"string", "emailAddress":"string", "name":"string" }] } }] } }, "customerId":"string" }
      { "inboundAdapterCallContext":{ "correlationId":"string", "sessionId":"string", "generalContext":[{ "key":"string", "value":"string" }] }, "status":{ "errorCode":"", "backendMessages":[{ "source":"string", "status":"string", "errorCode":"", "text":"string" }] }, "data":[{ "bankId":"string", "customerId":"string", "idKycDocument":"string", "customerNumber":"string", "type":"string", "number":"string", "issueDate":"2020-09-29T20:36:32Z", "issuePlace":"string", "expiryDate":"2020-09-29T20:36:32Z" }] }
      Required
      Fields
      { }
      Dependent
      Endpoints

      obp.getKycMedias

                                  
      Get Kyc Medias
      Kafka/Akka
      Outbound
      Inbound
      Topic
      from.obp.api.1.to.adapter.mf.caseclass.OutBoundGetKycMedias
      to.obp.api.1.caseclass.OutBoundGetKycMedias
      Message
      { "outboundAdapterCallContext":{ "correlationId":"string", "sessionId":"string", "consumerId":"string", "generalContext":[{ "key":"string", "value":"string" }], "outboundAdapterAuthInfo":{ "userId":"string", "username":"string", "linkedCustomers":[{ "customerId":"string", "customerNumber":"string", "legalName":"string" }], "userAuthContext":[{ "key":"string", "value":"string" }], "authViews":[{ "view":{ "id":"string", "name":"string", "description":"string" }, "account":{ "id":"string", "accountRoutings":[{ "scheme":"string", "address":"string" }], "customerOwners":[{ "bankId":"string", "customerId":"string", "customerNumber":"string", "legalName":"string", "dateOfBirth":"2020-09-29T20:36:32Z" }], "userOwners":[{ "userId":"string", "emailAddress":"string", "name":"string" }] } }] } }, "customerId":"string" }
      { "inboundAdapterCallContext":{ "correlationId":"string", "sessionId":"string", "generalContext":[{ "key":"string", "value":"string" }] }, "status":{ "errorCode":"", "backendMessages":[{ "source":"string", "status":"string", "errorCode":"", "text":"string" }] }, "data":[{ "bankId":"string", "customerId":"string", "idKycMedia":"string", "customerNumber":"string", "type":"string", "url":"string", "date":"2020-09-29T20:36:32Z", "relatesToKycDocumentId":"string", "relatesToKycCheckId":"string" }] }
      Required
      Fields
      { }
      Dependent
      Endpoints

      obp.getKycStatuses

                                  
      Get Kyc Statuses
      Kafka/Akka
      Outbound
      Inbound
      Topic
      from.obp.api.1.to.adapter.mf.caseclass.OutBoundGetKycStatuses
      to.obp.api.1.caseclass.OutBoundGetKycStatuses
      Message
      { "outboundAdapterCallContext":{ "correlationId":"string", "sessionId":"string", "consumerId":"string", "generalContext":[{ "key":"string", "value":"string" }], "outboundAdapterAuthInfo":{ "userId":"string", "username":"string", "linkedCustomers":[{ "customerId":"string", "customerNumber":"string", "legalName":"string" }], "userAuthContext":[{ "key":"string", "value":"string" }], "authViews":[{ "view":{ "id":"string", "name":"string", "description":"string" }, "account":{ "id":"string", "accountRoutings":[{ "scheme":"string", "address":"string" }], "customerOwners":[{ "bankId":"string", "customerId":"string", "customerNumber":"string", "legalName":"string", "dateOfBirth":"2020-09-29T20:36:32Z" }], "userOwners":[{ "userId":"string", "emailAddress":"string", "name":"string" }] } }] } }, "customerId":"string" }
      { "inboundAdapterCallContext":{ "correlationId":"string", "sessionId":"string", "generalContext":[{ "key":"string", "value":"string" }] }, "status":{ "errorCode":"", "backendMessages":[{ "source":"string", "status":"string", "errorCode":"", "text":"string" }] }, "data":[{ "bankId":"string", "customerId":"string", "customerNumber":"string", "ok":true, "date":"2020-09-29T20:36:32Z" }] }
      Required
      Fields
      { }
      Dependent
      Endpoints

      obp.getCheckbookOrdersFuture

                                  
      Get the status of CheckbookOrders for an Account.
      Kafka/Akka
      Outbound
      Inbound
      Topic
      from.obp.api.1.to.adapter.mf.caseclass.OutboundGetCheckbookOrderStatus
      to.obp.api.1.caseclass.OutboundGetCheckbookOrderStatus
      Message
      { "authInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "cbsToken":"FYIUYF6SUYFSD", "isFirst":true, "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContexts":[{ "key":"CUSTOMER_NUMBER", "value":"5987953" },{ "key":"TOKEN", "value":"qieuriopwoir987ASYDUFISUYDF678u" }], "authViews":[{ "view":{ "id":"owner", "name":"Owner", "description":"This is the owner view" }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"AccountNumber", "address":"546387432" },{ "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":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"Eveline Tripman" }] } }] }, "bankId":"gh.29.uk", "accountId":"accountId", "originatorApplication":"String", "originatorStationIP":"String", "primaryAccount":"" }
      { "inboundAuthInfo":{ "cbsToken":"FYIUYF6SUYFSD", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50" }, "status":{ "errorCode":"", "backendMessages":[{ "source":"ESB", "status":"Success", "errorCode":"0", "text":"OK" }] }, "data":{ "account":{ "bank_id":"gh.29.uk", "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "account_type":"330", "account_routings":[{ "scheme":"AccountNumber", "address":"4930396" }], "branch_routings":[{ "scheme":"BranchNumber", "address":"678" }] }, "orders":[{ "order":{ "order_id":"xjksajfkj", "order_date":"07082013", "number_of_checkbooks":"4", "distribution_channel":"1201", "status":"2", "first_check_number":"5165276", "shipping_code":"1" } }] } }
      Required
      Fields
      { }
      Dependent
      Endpoints

        obp.getStatusOfCreditCardOrderFuture

                                    
        Get the status of CreditCardOrders
        Kafka/Akka
        Outbound
        Inbound
        Topic
        from.obp.api.1.to.adapter.mf.caseclass.OutboundGetCreditCardOrderStatus
        to.obp.api.1.caseclass.OutboundGetCreditCardOrderStatus
        Message
        { "authInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "cbsToken":"FYIUYF6SUYFSD", "isFirst":true, "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContexts":[{ "key":"CUSTOMER_NUMBER", "value":"5987953" },{ "key":"TOKEN", "value":"qieuriopwoir987ASYDUFISUYDF678u" }], "authViews":[{ "view":{ "id":"owner", "name":"Owner", "description":"This is the owner view" }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"AccountNumber", "address":"546387432" },{ "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":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"Eveline Tripman" }] } }] }, "bankId":"gh.29.uk", "accountId":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "originatorApplication":"String", "originatorStationIP":"String", "primaryAccount":"" }
        { "inboundAuthInfo":{ "cbsToken":"FYIUYF6SUYFSD", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50" }, "status":{ "errorCode":"", "backendMessages":[{ "source":"ESB", "status":"Success", "errorCode":"0", "text":"OK" }] }, "data":[{ "orderId":"OrderId", "creditCardType":"CreditCardType", "cardDescription":"CardDescription", "useType":"UseType", "orderDate":"OrderDate", "deliveryStatus":"DeliveryStatus", "statusDate":"StatusDate", "branch":"Branch" }] }
        Required
        Fields
        { }
        Dependent
        Endpoints

          obp.getBranches

                                      
          Get Branches fora Bank specified by bankId
          Kafka/Akka
          Outbound
          Inbound
          Topic
          from.obp.api.1.to.adapter.mf.caseclass.OutboundGetBranches
          to.obp.api.1.caseclass.OutboundGetBranches
          Message
          { "authInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "cbsToken":"FYIUYF6SUYFSD", "isFirst":true, "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContexts":[{ "key":"CUSTOMER_NUMBER", "value":"5987953" },{ "key":"TOKEN", "value":"qieuriopwoir987ASYDUFISUYDF678u" }], "authViews":[{ "view":{ "id":"owner", "name":"Owner", "description":"This is the owner view" }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"AccountNumber", "address":"546387432" },{ "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":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"Eveline Tripman" }] } }] }, "bankId":"bankid" }
          { "inboundAuthInfo":{ "cbsToken":"FYIUYF6SUYFSD", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50" }, "status":{ "errorCode":"", "backendMessages":[{ "source":"ESB", "status":"Success", "errorCode":"0", "text":"OK" }] }, "data":[{ "branchId":{ "value":"" }, "bankId":{ "value":"gh.29.uk" }, "name":"", "address":{ "line1":"", "line2":"", "line3":"", "city":"", "county":"", "state":"", "postCode":"", "countryCode":"" }, "location":{ "latitude":11.0, "longitude":11.0 }, "meta":{ "license":{ "id":"", "name":"" } }, "lobby":{ "monday":[{ "openingTime":"", "closingTime":"" }], "tuesday":[{ "openingTime":"", "closingTime":"" }], "wednesday":[{ "openingTime":"", "closingTime":"" }], "thursday":[{ "openingTime":"", "closingTime":"" }], "friday":[{ "openingTime":"", "closingTime":"" }], "saturday":[{ "openingTime":"", "closingTime":"" }], "sunday":[{ "openingTime":"", "closingTime":"" }] }, "isAccessible":true, "branchType":"", "moreInfo":"", "phoneNumber":"", "isDeleted":false }] }
          Required
          Fields
          { }
          Dependent
          Endpoints

          obp.getBranch

                                      
          Get a Branch as specified by bankId and branchId
          Kafka/Akka
          Outbound
          Inbound
          Topic
          from.obp.api.1.to.adapter.mf.caseclass.OutboundGetBranch
          to.obp.api.1.caseclass.OutboundGetBranch
          Message
          { "authInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "cbsToken":"FYIUYF6SUYFSD", "isFirst":true, "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContexts":[{ "key":"CUSTOMER_NUMBER", "value":"5987953" },{ "key":"TOKEN", "value":"qieuriopwoir987ASYDUFISUYDF678u" }], "authViews":[{ "view":{ "id":"owner", "name":"Owner", "description":"This is the owner view" }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"AccountNumber", "address":"546387432" },{ "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":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"Eveline Tripman" }] } }] }, "bankId":"bankid", "branchId":"branchid" }
          { "inboundAuthInfo":{ "cbsToken":"FYIUYF6SUYFSD", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50" }, "status":{ "errorCode":"", "backendMessages":[{ "source":"ESB", "status":"Success", "errorCode":"0", "text":"OK" }] }, "data":{ "branchId":{ "value":"" }, "bankId":{ "value":"gh.29.uk" }, "name":"", "address":{ "line1":"", "line2":"", "line3":"", "city":"", "county":"", "state":"", "postCode":"", "countryCode":"" }, "location":{ "latitude":11.0, "longitude":11.0 }, "meta":{ "license":{ "id":"", "name":"" } }, "lobby":{ "monday":[{ "openingTime":"", "closingTime":"" }], "tuesday":[{ "openingTime":"", "closingTime":"" }], "wednesday":[{ "openingTime":"", "closingTime":"" }], "thursday":[{ "openingTime":"", "closingTime":"" }], "friday":[{ "openingTime":"", "closingTime":"" }], "saturday":[{ "openingTime":"", "closingTime":"" }], "sunday":[{ "openingTime":"", "closingTime":"" }] }, "isAccessible":true, "branchType":"", "moreInfo":"", "phoneNumber":"", "isDeleted":false } }
          Required
          Fields
          { }
          Dependent
          Endpoints

          obp.getAtms

                                      
          Get ATMs for a bank specified by bankId
          Kafka/Akka
          Outbound
          Inbound
          Topic
          from.obp.api.1.to.adapter.mf.caseclass.OutboundGetAtms
          to.obp.api.1.caseclass.OutboundGetAtms
          Message
          { "authInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "cbsToken":"FYIUYF6SUYFSD", "isFirst":true, "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContexts":[{ "key":"CUSTOMER_NUMBER", "value":"5987953" },{ "key":"TOKEN", "value":"qieuriopwoir987ASYDUFISUYDF678u" }], "authViews":[{ "view":{ "id":"owner", "name":"Owner", "description":"This is the owner view" }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"AccountNumber", "address":"546387432" },{ "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":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"Eveline Tripman" }] } }] }, "bankId":"bankid" }
          { "inboundAuthInfo":{ "cbsToken":"FYIUYF6SUYFSD", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50" }, "status":{ "errorCode":"", "backendMessages":[{ "source":"ESB", "status":"Success", "errorCode":"0", "text":"OK" }] }, "data":[{ "atmId":{ "value":"333" }, "bankId":{ "value":"gh.29.uk" }, "name":"", "address":{ "line1":"", "line2":"", "line3":"", "city":"", "county":"", "state":"", "postCode":"", "countryCode":"" }, "location":{ "latitude":11.0, "longitude":11.0 }, "meta":{ "license":{ "id":"pddl", "name":"Open Data Commons Public Domain Dedication and License (PDDL)" } }, "OpeningTimeOnMonday":"", "ClosingTimeOnMonday":"", "OpeningTimeOnTuesday":"", "ClosingTimeOnTuesday":"", "OpeningTimeOnWednesday":"", "ClosingTimeOnWednesday":"", "OpeningTimeOnThursday":"", "ClosingTimeOnThursday":"", "OpeningTimeOnFriday":"", "ClosingTimeOnFriday":"", "OpeningTimeOnSaturday":"", "ClosingTimeOnSaturday":"", "OpeningTimeOnSunday":"", "ClosingTimeOnSunday":"", "isAccessible":true, "locatedAt":"", "moreInfo":"", "hasDepositCapability":true }] }
          Required
          Fields
          { }
          Dependent
          Endpoints

          obp.getAtm

                                      
          Get an ATM as specified by bankId and atmId.
          Kafka/Akka
          Outbound
          Inbound
          Topic
          from.obp.api.1.to.adapter.mf.caseclass.OutboundGetAtm
          to.obp.api.1.caseclass.OutboundGetAtm
          Message
          { "authInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "cbsToken":"FYIUYF6SUYFSD", "isFirst":true, "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContexts":[{ "key":"CUSTOMER_NUMBER", "value":"5987953" },{ "key":"TOKEN", "value":"qieuriopwoir987ASYDUFISUYDF678u" }], "authViews":[{ "view":{ "id":"owner", "name":"Owner", "description":"This is the owner view" }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"AccountNumber", "address":"546387432" },{ "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":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"Eveline Tripman" }] } }] }, "bankId":"bankId", "atmId":"atmId" }
          { "inboundAuthInfo":{ "cbsToken":"FYIUYF6SUYFSD", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50" }, "status":{ "errorCode":"", "backendMessages":[{ "source":"ESB", "status":"Success", "errorCode":"0", "text":"OK" }] }, "data":{ "atmId":{ "value":"333" }, "bankId":{ "value":"gh.29.uk" }, "name":"", "address":{ "line1":"", "line2":"", "line3":"", "city":"", "county":"", "state":"", "postCode":"", "countryCode":"" }, "location":{ "latitude":11.0, "longitude":11.0 }, "meta":{ "license":{ "id":"pddl", "name":"Open Data Commons Public Domain Dedication and License (PDDL)" } }, "OpeningTimeOnMonday":"", "ClosingTimeOnMonday":"", "OpeningTimeOnTuesday":"", "ClosingTimeOnTuesday":"", "OpeningTimeOnWednesday":"", "ClosingTimeOnWednesday":"", "OpeningTimeOnThursday":"", "ClosingTimeOnThursday":"", "OpeningTimeOnFriday":"", "ClosingTimeOnFriday":"", "OpeningTimeOnSaturday":"", "ClosingTimeOnSaturday":"", "OpeningTimeOnSunday":"", "ClosingTimeOnSunday":"", "isAccessible":true, "locatedAt":"", "moreInfo":"", "hasDepositCapability":true } }
          Required
          Fields
          { }
          Dependent
          Endpoints

          obp.getCounterparties

                                      
          Get Counterparties available to the View on the Account specified by thisBankId, thisAccountId and viewId.
          Kafka/Akka
          Outbound
          Inbound
          Topic
          from.obp.api.1.to.adapter.mf.caseclass.OutboundGetCounterparties
          to.obp.api.1.caseclass.OutboundGetCounterparties
          Message
          { "authInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "cbsToken":"FYIUYF6SUYFSD", "isFirst":true, "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContexts":[{ "key":"CUSTOMER_NUMBER", "value":"5987953" },{ "key":"TOKEN", "value":"qieuriopwoir987ASYDUFISUYDF678u" }], "authViews":[{ "view":{ "id":"owner", "name":"Owner", "description":"This is the owner view" }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"AccountNumber", "address":"546387432" },{ "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":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"Eveline Tripman" }] } }] }, "counterparty":{ "thisBankId":"String", "thisAccountId":"String", "viewId":"String" } }
          { "inboundAuthInfo":{ "cbsToken":"FYIUYF6SUYFSD", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50" }, "status":{ "errorCode":"", "backendMessages":[{ "source":"ESB", "status":"Success", "errorCode":"0", "text":"OK" }] }, "data":[{ "createdByUserId":"", "name":"", "thisBankId":"", "thisAccountId":"", "thisViewId":"", "counterpartyId":"", "otherAccountRoutingScheme":"", "otherAccountRoutingAddress":"", "otherBankRoutingScheme":"", "otherBankRoutingAddress":"", "otherBranchRoutingScheme":"", "otherBranchRoutingAddress":"", "isBeneficiary":true, "description":"", "otherAccountSecondaryRoutingScheme":"", "otherAccountSecondaryRoutingAddress":"", "bespoke":[{ "key":"key", "value":"value" }] }] }
          Required
          Fields
          { }
          Dependent
          Endpoints

          obp.getCounterpartyByCounterpartyId

                                      
          Get a Counterparty by its counterpartyId.
          Kafka/Akka
          Outbound
          Inbound
          Topic
          from.obp.api.1.to.adapter.mf.caseclass.OutboundGetCounterpartyByCounterpartyId
          to.obp.api.1.caseclass.OutboundGetCounterpartyByCounterpartyId
          Message
          { "authInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "cbsToken":"FYIUYF6SUYFSD", "isFirst":true, "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContexts":[{ "key":"CUSTOMER_NUMBER", "value":"5987953" },{ "key":"TOKEN", "value":"qieuriopwoir987ASYDUFISUYDF678u" }], "authViews":[{ "view":{ "id":"owner", "name":"Owner", "description":"This is the owner view" }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"AccountNumber", "address":"546387432" },{ "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":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"Eveline Tripman" }] } }] }, "counterparty":{ "counterpartyId":"String" } }
          { "inboundAuthInfo":{ "cbsToken":"FYIUYF6SUYFSD", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50" }, "status":{ "errorCode":"", "backendMessages":[{ "source":"ESB", "status":"Success", "errorCode":"0", "text":"OK" }] }, "data":{ "createdByUserId":"String", "name":"String", "thisBankId":"String", "thisAccountId":"String", "thisViewId":"String", "counterpartyId":"String", "otherAccountRoutingScheme":"String", "otherAccountRoutingAddress":"String", "otherBankRoutingScheme":"String", "otherBankRoutingAddress":"String", "otherBranchRoutingScheme":"String", "otherBranchRoutingAddress":"String", "isBeneficiary":true, "description":"String", "otherAccountSecondaryRoutingScheme":"String", "otherAccountSecondaryRoutingAddress":"String", "bespoke":[] } }
          Required
          Fields
          { }
          Dependent
          Endpoints

          obp.getCounterpartyTrait

                                      
          Get a Counterparty by its bankId, accountId and counterpartyId
          Kafka/Akka
          Outbound
          Inbound
          Topic
          from.obp.api.1.to.adapter.mf.caseclass.OutboundGetCounterparty
          to.obp.api.1.caseclass.OutboundGetCounterparty
          Message
          { "authInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "cbsToken":"FYIUYF6SUYFSD", "isFirst":true, "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContexts":[{ "key":"CUSTOMER_NUMBER", "value":"5987953" },{ "key":"TOKEN", "value":"qieuriopwoir987ASYDUFISUYDF678u" }], "authViews":[{ "view":{ "id":"owner", "name":"Owner", "description":"This is the owner view" }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"AccountNumber", "address":"546387432" },{ "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":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"Eveline Tripman" }] } }] }, "thisBankId":"BankId", "thisAccountId":"AccountId", "counterpartyId":"counterpartyId" }
          { "inboundAuthInfo":{ "cbsToken":"FYIUYF6SUYFSD", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50" }, "status":{ "errorCode":"", "backendMessages":[{ "source":"ESB", "status":"Success", "errorCode":"0", "text":"OK" }] }, "data":{ "createdByUserId":"String", "name":"String", "thisBankId":"String", "thisAccountId":"String", "thisViewId":"String", "counterpartyId":"String", "otherAccountRoutingScheme":"String", "otherAccountRoutingAddress":"String", "otherBankRoutingScheme":"String", "otherBankRoutingAddress":"String", "otherBranchRoutingScheme":"String", "otherBranchRoutingAddress":"String", "isBeneficiary":true, "description":"String", "otherAccountSecondaryRoutingScheme":"String", "otherAccountSecondaryRoutingAddress":"String", "bespoke":[] } }
          Required
          Fields
          { }
          Dependent
          Endpoints

          obp.getChallengeThreshold

                                      
          Get Challenge Threshold
          Kafka/Akka
          Outbound
          Inbound
          Topic
          from.obp.api.1.to.adapter.mf.caseclass.OutboundGetChallengeThreshold
          to.obp.api.1.caseclass.OutboundGetChallengeThreshold
          Message
          { "authInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "cbsToken":"FYIUYF6SUYFSD", "isFirst":true, "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContexts":[{ "key":"CUSTOMER_NUMBER", "value":"5987953" },{ "key":"TOKEN", "value":"qieuriopwoir987ASYDUFISUYDF678u" }], "authViews":[{ "view":{ "id":"owner", "name":"Owner", "description":"This is the owner view" }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"AccountNumber", "address":"546387432" },{ "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":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"Eveline Tripman" }] } }] }, "bankId":"gh.29.uk", "accountId":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "viewId":"owner", "transactionRequestType":"SEPA", "currency":"EUR", "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "userName":"felixsmith" }
          { "inboundAuthInfo":{ "cbsToken":"FYIUYF6SUYFSD", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50" }, "status":{ "errorCode":"", "backendMessages":[{ "source":"ESB", "status":"Success", "errorCode":"0", "text":"OK" }] }, "data":{ "currency":"EUR", "amount":"19.64" } }
          Required
          Fields
          { }
          Dependent
          Endpoints

            obp.makePaymentv210

                                        
            Make payment (create transaction).
            Kafka/Akka
            Outbound
            Inbound
            Topic
            from.obp.api.1.to.adapter.mf.caseclass.OutboundCreateTransaction
            to.obp.api.1.caseclass.OutboundCreateTransaction
            Message
            { "authInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "cbsToken":"FYIUYF6SUYFSD", "isFirst":true, "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContexts":[{ "key":"CUSTOMER_NUMBER", "value":"5987953" },{ "key":"TOKEN", "value":"qieuriopwoir987ASYDUFISUYDF678u" }], "authViews":[{ "view":{ "id":"owner", "name":"Owner", "description":"This is the owner view" }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"AccountNumber", "address":"546387432" },{ "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":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"Eveline Tripman" }] } }] }, "fromAccountBankId":"gh.29.uk", "fromAccountId":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "transactionRequestType":"SEPA", "transactionChargePolicy":"SHARE", "transactionRequestCommonBody":{ "value":{ "currency":"EUR", "amount":"19.64" }, "description":"For the piano lesson in June 2018 - Invoice No: 68" }, "toCounterpartyId":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh", "toCounterpartyName":"John Smith Ltd.", "toCounterpartyCurrency":"EUR", "toCounterpartyRoutingAddress":"DE91 1000 0000 0123 4567 89", "toCounterpartyRoutingScheme":"IBAN", "toCounterpartyBankRoutingAddress":"BIC", "toCounterpartyBankRoutingScheme":"GENODEM1GLS" }
            { "inboundAuthInfo":{ "cbsToken":"FYIUYF6SUYFSD", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50" }, "status":{ "errorCode":"", "backendMessages":[{ "source":"ESB", "status":"Success", "errorCode":"0", "text":"OK" }] }, "data":{ "id":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub" } }
            Required
            Fields
            { }
            Dependent
            Endpoints

              obp.createCounterparty

                                          
              Create Counterparty
              Kafka/Akka
              Outbound
              Inbound
              Topic
              from.obp.api.1.to.adapter.mf.caseclass.OutboundCreateCounterparty
              to.obp.api.1.caseclass.OutboundCreateCounterparty
              Message
              { "authInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "cbsToken":"FYIUYF6SUYFSD", "isFirst":true, "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContexts":[{ "key":"CUSTOMER_NUMBER", "value":"5987953" },{ "key":"TOKEN", "value":"qieuriopwoir987ASYDUFISUYDF678u" }], "authViews":[{ "view":{ "id":"owner", "name":"Owner", "description":"This is the owner view" }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"AccountNumber", "address":"546387432" },{ "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":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"Eveline Tripman" }] } }] }, "counterparty":{ "name":"name", "description":"description", "createdByUserId":"createdByUserId", "thisBankId":"thisBankId", "thisAccountId":"thisAccountId", "thisViewId":"thisViewId", "otherAccountRoutingScheme":"otherAccountRoutingScheme", "otherAccountRoutingAddress":"otherAccountRoutingAddress", "otherAccountSecondaryRoutingScheme":"otherAccountSecondaryRoutingScheme", "otherAccountSecondaryRoutingAddress":"otherAccountSecondaryRoutingAddress", "otherBankRoutingScheme":"otherBankRoutingScheme", "otherBankRoutingAddress":"otherBankRoutingAddress", "otherBranchRoutingScheme":"otherBranchRoutingScheme", "otherBranchRoutingAddress":"otherBranchRoutingAddress", "isBeneficiary":true, "bespoke":[{ "key":"key", "value":"value" }] } }
              { "inboundAuthInfo":{ "cbsToken":"FYIUYF6SUYFSD", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50" }, "status":{ "errorCode":"", "backendMessages":[{ "source":"ESB", "status":"Success", "errorCode":"0", "text":"OK" }] }, "data":{ "createdByUserId":"String", "name":"String", "thisBankId":"String", "thisAccountId":"String", "thisViewId":"String", "counterpartyId":"String", "otherAccountRoutingScheme":"String", "otherAccountRoutingAddress":"String", "otherBankRoutingScheme":"String", "otherBankRoutingAddress":"String", "otherBranchRoutingScheme":"String", "otherBranchRoutingAddress":"String", "isBeneficiary":false, "description":"String", "otherAccountSecondaryRoutingScheme":"String", "otherAccountSecondaryRoutingAddress":"String", "bespoke":[{ "key":"String", "value":"String" }] } }
              Required
              Fields
              { }
              Dependent
              Endpoints

                obp.getTransactionRequests210

                                            
                Get Transaction Requests
                Kafka/Akka
                Outbound
                Inbound
                Topic
                from.obp.api.1.to.adapter.mf.caseclass.OutboundGetTransactionRequests210
                to.obp.api.1.caseclass.OutboundGetTransactionRequests210
                Message
                { "authInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "cbsToken":"FYIUYF6SUYFSD", "isFirst":true, "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContexts":[{ "key":"CUSTOMER_NUMBER", "value":"5987953" },{ "key":"TOKEN", "value":"qieuriopwoir987ASYDUFISUYDF678u" }], "authViews":[{ "view":{ "id":"owner", "name":"Owner", "description":"This is the owner view" }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"AccountNumber", "address":"546387432" },{ "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":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"Eveline Tripman" }] } }] }, "counterparty":{ "accountId":"accountId: String", "accountType":"accountType: String", "currency":"currency: String", "iban":"iban: String", "number":"number: String", "bankId":"bankId: BankId", "branchId":"branchId: String", "accountRoutingScheme":"accountRoutingScheme: String", "accountRoutingAddress":"accountRoutingAddress: String" } }
                { "inboundAuthInfo":{ "cbsToken":"FYIUYF6SUYFSD", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50" }, "status":{ "errorCode":"", "backendMessages":[{ "source":"ESB", "status":"Success", "errorCode":"0", "text":"OK" }] }, "data":[{ "id":{ "value":"id" }, "type":"String", "from":{ "bank_id":"10", "account_id":"12" }, "body":{ "to_sandbox_tan":{ "bank_id":"String", "account_id":"String" }, "to_sepa":{ "iban":"String" }, "to_counterparty":{ "counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh" }, "to_transfer_to_phone":{ "value":{ "currency":"EUR", "amount":"0" }, "description":"String", "message":"String", "from":{ "mobile_phone_number":"+44 07972 444 876", "nickname":"String" }, "to":{ "mobile_phone_number":"+44 07972 444 876" } }, "to_transfer_to_atm":{ "value":{ "currency":"EUR", "amount":"0" }, "description":"String", "message":"String", "from":{ "mobile_phone_number":"+44 07972 444 876", "nickname":"String" }, "to":{ "legal_name":"Eveline Tripman", "date_of_birth":"20181230", "mobile_phone_number":"+44 07972 444 876", "kyc_document":{ "type":"String", "number":"String" } } }, "to_transfer_to_account":{ "value":{ "currency":"EUR", "amount":"0" }, "description":"String", "transfer_type":"String", "future_date":"20181230", "to":{ "name":"String", "bank_code":"String", "branch_number":"String", "account":{ "number":"String", "iban":"String" } } }, "to_sepa_credit_transfers":{ "debtorAccount":{ "iban":"12345" }, "instructedAmount":{ "currency":"EUR", "amount":"0" }, "creditorAccount":{ "iban":"54321" }, "creditorName":"John Miles" }, "value":{ "currency":"EUR", "amount":"100" }, "description":"String" }, "transaction_ids":"", "status":"COMPLETED", "start_date":"2017-09-19T00:00:00Z", "end_date":"2017-09-19T00:00:00Z", "challenge":{ "id":"", "allowed_attempts":0, "challenge_type":"" }, "charge":{ "summary":"", "value":{ "currency":"EUR", "amount":"19.64" } }, "charge_policy":"", "counterparty_id":{ "value":"" }, "name":"name", "this_bank_id":{ "value":"10" }, "this_account_id":{ "value":"1" }, "this_view_id":{ "value":"" }, "other_account_routing_scheme":"", "other_account_routing_address":"", "other_bank_routing_scheme":"", "other_bank_routing_address":"", "is_beneficiary":false }] }
                Required
                Fields
                { }
                Dependent
                Endpoints

                obp.createChallenge

                                            
                Create a Security Challenge that may be used to complete a Transaction Request.
                Kafka/Akka
                Outbound
                Inbound
                Topic
                from.obp.api.1.to.adapter.mf.caseclass.OutboundCreateChallengeSept2018
                to.obp.api.1.caseclass.OutboundCreateChallengeSept2018
                Message
                { "authInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "cbsToken":"FYIUYF6SUYFSD", "isFirst":true, "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContexts":[{ "key":"CUSTOMER_NUMBER", "value":"5987953" },{ "key":"TOKEN", "value":"qieuriopwoir987ASYDUFISUYDF678u" }], "authViews":[{ "view":{ "id":"owner", "name":"Owner", "description":"This is the owner view" }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"AccountNumber", "address":"546387432" },{ "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":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"Eveline Tripman" }] } }] }, "bankId":"gh.29.uk", "accountId":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "transactionRequestType":"SANDBOX_TAN", "transactionRequestId":"1234567" }
                { "inboundAuthInfo":{ "cbsToken":"FYIUYF6SUYFSD", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50" }, "data":{ "errorCode":"", "backendMessages":[{ "source":"ESB", "status":"Success", "errorCode":"0", "text":"OK" }], "answer":"1234" } }
                Required
                Fields
                { }
                Dependent
                Endpoints

                  obp.getTransactions

                                              
                  Get Transactions for an Account specified by bankId and accountId. Pagination is achieved with limit, fromDate and toDate.
                  Kafka/Akka
                  Outbound
                  Inbound
                  Topic
                  from.obp.api.1.to.adapter.mf.caseclass.OutboundGetTransactions
                  to.obp.api.1.caseclass.OutboundGetTransactions
                  Message
                  { "authInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "cbsToken":"FYIUYF6SUYFSD", "isFirst":true, "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContexts":[{ "key":"CUSTOMER_NUMBER", "value":"5987953" },{ "key":"TOKEN", "value":"qieuriopwoir987ASYDUFISUYDF678u" }], "authViews":[{ "view":{ "id":"owner", "name":"Owner", "description":"This is the owner view" }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"AccountNumber", "address":"546387432" },{ "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":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"Eveline Tripman" }] } }] }, "bankId":"gh.29.uk", "accountId":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "limit":100, "fromDate":"DateWithSecondsExampleObject", "toDate":"DateWithSecondsExampleObject" }
                  { "inboundAuthInfo":{ "cbsToken":"FYIUYF6SUYFSD", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50" }, "status":{ "errorCode":"", "backendMessages":[{ "source":"ESB", "status":"Success", "errorCode":"0", "text":"OK" }] }, "data":[{ "transactionId":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub", "accountId":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "amount":"19.64", "bankId":"gh.29.uk", "completedDate":"2018-01-28", "counterpartyId":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh", "counterpartyName":"John Smith Ltd.", "currency":"EUR", "description":"For the piano lesson in June 2018 - Invoice No: 68", "newBalanceAmount":"50.89", "newBalanceCurrency":"EUR", "postedDate":"2018-01-27", "type":"DEBIT", "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1" }] }
                  Required
                  Fields
                  { }
                  Dependent
                  Endpoints

                  obp.getTransaction

                                              
                  Get a single Transaction specified by bankId, accountId and transactionId
                  Kafka/Akka
                  Outbound
                  Inbound
                  Topic
                  from.obp.api.1.to.adapter.mf.caseclass.OutboundGetTransaction
                  to.obp.api.1.caseclass.OutboundGetTransaction
                  Message
                  { "authInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "cbsToken":"FYIUYF6SUYFSD", "isFirst":true, "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContexts":[{ "key":"CUSTOMER_NUMBER", "value":"5987953" },{ "key":"TOKEN", "value":"qieuriopwoir987ASYDUFISUYDF678u" }], "authViews":[{ "view":{ "id":"owner", "name":"Owner", "description":"This is the owner view" }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"AccountNumber", "address":"546387432" },{ "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":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"Eveline Tripman" }] } }] }, "bankId":"bankId", "accountId":"accountId", "transactionId":"transactionId" }
                  { "inboundAuthInfo":{ "cbsToken":"FYIUYF6SUYFSD", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50" }, "status":{ "errorCode":"", "backendMessages":[{ "source":"ESB", "status":"Success", "errorCode":"0", "text":"OK" }] }, "data":{ "transactionId":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub", "accountId":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "amount":"19.64", "bankId":"gh.29.uk", "completedDate":"2018-01-28", "counterpartyId":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh", "counterpartyName":"John Smith Ltd.", "currency":"EUR", "description":"For the piano lesson in June 2018 - Invoice No: 68", "newBalanceAmount":"50.89", "newBalanceCurrency":"EUR", "postedDate":"2018-01-27", "type":"DEBIT", "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1" } }
                  Required
                  Fields
                  { }
                  Dependent
                  Endpoints

                  obp.getUser

                                              
                  Gets the User as identifiedgetAdapterInfo by the the credentials (username and password) supplied.
                  Kafka/Akka
                  Outbound
                  Inbound
                  Topic
                  from.obp.api.1.to.adapter.mf.caseclass.OutboundGetUserByUsernamePassword
                  to.obp.api.1.caseclass.OutboundGetUserByUsernamePassword
                  Message
                  { "authInfo":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "username":"felixsmith", "cbsToken":"FYIUYF6SUYFSD", "isFirst":true, "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "linkedCustomers":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customerNumber":"5987953", "legalName":"Eveline Tripman" }], "userAuthContexts":[{ "key":"CUSTOMER_NUMBER", "value":"5987953" },{ "key":"TOKEN", "value":"qieuriopwoir987ASYDUFISUYDF678u" }], "authViews":[{ "view":{ "id":"owner", "name":"Owner", "description":"This is the owner view" }, "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "accountRoutings":[{ "scheme":"AccountNumber", "address":"546387432" },{ "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":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"Eveline Tripman" }] } }] }, "password":"2b78e8" }
                  { "inboundAuthInfo":{ "cbsToken":"FYIUYF6SUYFSD", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50" }, "data":{ "errorCode":"", "backendMessages":[{ "source":"ESB", "status":"Success", "errorCode":"0", "text":"OK" }], "email":"susan.uk.29@example.com", "displayName":"susan" } }
                  Required
                  Fields
                  { }
                  Dependent
                  Endpoints