- API Explorer
- Glossary Message Docs for:
- Kafka
- Akka
- Rest
- Stored Procedure Introduction to:
- Kafka
- Akka
- Stored Procedure
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/AkkaOutboundInboundTopicfrom.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.to.adapter.mf.caseclass.OutboundGetAdapterInfoto.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.caseclass.OutboundGetAdapterInfoMessage{ "date":"1100-01-01T01:01:01Z" }{ "data":{ "errorCode":"", "backendMessages":[{ "source":"ESB", "status":"Success", "errorCode":"0", "text":"OK" }], "name":"Obp-Kafka-South", "version":"Sept2018", "git_commit":"59623811dd8a41f6ffe67be46954eee11913dc28", "date":"1100-01-01T01:01:01Z" } }Required
Fields{ }Dependent
Endpoints
obp.getBanks
Gets the banks list on this OBP installation.Kafka/AkkaOutboundInboundTopicfrom.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.to.adapter.mf.caseclass.OutboundGetBanksto.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.caseclass.OutboundGetBanksMessage{ "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":"1100-01-01T01:01:01Z" }], "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 bankIdKafka/AkkaOutboundInboundTopicfrom.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.to.adapter.mf.caseclass.OutboundGetBankto.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.caseclass.OutboundGetBankMessage{ "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":"1100-01-01T01:01:01Z" }], "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 MessageKafka/AkkaOutboundInboundTopicfrom.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.to.adapter.mf.caseclass.OutBoundCreateMessageto.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.caseclass.OutBoundCreateMessageMessage{ "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":"2024-09-12T13:08: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":"2024-09-12T13:08:32Z", "message":"string", "fromDepartment":"string", "fromPerson":"string" } }Required
Fields{ }Dependent
Endpoints
obp.createOrUpdateKycCheck
Create Or Update Kyc CheckKafka/AkkaOutboundInboundTopicfrom.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.to.adapter.mf.caseclass.OutBoundCreateOrUpdateKycCheckto.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.caseclass.OutBoundCreateOrUpdateKycCheckMessage{ "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":"2024-09-12T13:08:32Z" }], "userOwners":[{ "userId":"string", "emailAddress":"string", "name":"string" }] } }] } }, "bankId":"string", "customerId":"string", "id":"string", "customerNumber":"string", "date":"2024-09-12T13:08: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":"2024-09-12T13:08:32Z", "how":"string", "staffUserId":"string", "staffName":"string", "satisfied":true, "comments":"string" } }Required
Fields{ }Dependent
Endpoints
obp.createOrUpdateKycDocument
Create Or Update KYC DocumentKafka/AkkaOutboundInboundTopicfrom.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.to.adapter.mf.caseclass.OutBoundCreateOrUpdateKycDocumentto.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.caseclass.OutBoundCreateOrUpdateKycDocumentMessage{ "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":"2024-09-12T13:08:32Z" }], "userOwners":[{ "userId":"string", "emailAddress":"string", "name":"string" }] } }] } }, "bankId":"string", "customerId":"string", "id":"string", "customerNumber":"string", "type":"string", "number":"string", "issueDate":"2024-09-12T13:08:32Z", "issuePlace":"string", "expiryDate":"2024-09-12T13:08: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":"2024-09-12T13:08:32Z", "issuePlace":"string", "expiryDate":"2024-09-12T13:08:32Z" } }Required
Fields{ }Dependent
Endpoints
obp.createOrUpdateKycMedia
Create Or Update KYC MediaKafka/AkkaOutboundInboundTopicfrom.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.to.adapter.mf.caseclass.OutBoundCreateOrUpdateKycMediato.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.caseclass.OutBoundCreateOrUpdateKycMediaMessage{ "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":"2024-09-12T13:08:32Z" }], "userOwners":[{ "userId":"string", "emailAddress":"string", "name":"string" }] } }] } }, "bankId":"string", "customerId":"string", "id":"string", "customerNumber":"string", "type":"string", "url":"string", "date":"2024-09-12T13:08: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":"2024-09-12T13:08:32Z", "relatesToKycDocumentId":"string", "relatesToKycCheckId":"string" } }Required
Fields{ }Dependent
Endpoints
obp.createOrUpdateKycStatus
Create Or Update KYC StatusKafka/AkkaOutboundInboundTopicfrom.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.to.adapter.mf.caseclass.OutBoundCreateOrUpdateKycStatusto.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.caseclass.OutBoundCreateOrUpdateKycStatusMessage{ "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":"2024-09-12T13:08:32Z" }], "userOwners":[{ "userId":"string", "emailAddress":"string", "name":"string" }] } }] } }, "bankId":"string", "customerId":"string", "customerNumber":"string", "ok":true, "date":"2024-09-12T13:08: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":"2024-09-12T13:08:32Z" } }Required
Fields{ }Dependent
Endpoints
obp.getKycDocuments
Get KYC DocumentsKafka/AkkaOutboundInboundTopicfrom.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.to.adapter.mf.caseclass.OutBoundGetKycDocumentsto.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.caseclass.OutBoundGetKycDocumentsMessage{ "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":"2024-09-12T13:08: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":"2024-09-12T13:08:32Z", "issuePlace":"string", "expiryDate":"2024-09-12T13:08:32Z" }] }Required
Fields{ }Dependent
Endpoints
obp.getKycMedias
Get KYC MediasKafka/AkkaOutboundInboundTopicfrom.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.to.adapter.mf.caseclass.OutBoundGetKycMediasto.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.caseclass.OutBoundGetKycMediasMessage{ "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":"2024-09-12T13:08: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":"2024-09-12T13:08:32Z", "relatesToKycDocumentId":"string", "relatesToKycCheckId":"string" }] }Required
Fields{ }Dependent
Endpoints
obp.getKycStatuses
Get KYC StatusesKafka/AkkaOutboundInboundTopicfrom.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.to.adapter.mf.caseclass.OutBoundGetKycStatusesto.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.caseclass.OutBoundGetKycStatusesMessage{ "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":"2024-09-12T13:08: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":"2024-09-12T13:08:32Z" }] }Required
Fields{ }Dependent
Endpoints
obp.getKycChecks
Get KYC ChecksKafka/AkkaOutboundInboundTopicfrom.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.to.adapter.mf.caseclass.OutBoundGetKycChecksto.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.caseclass.OutBoundGetKycChecksMessage{ "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":"2024-09-12T13:08: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":"2024-09-12T13:08:32Z", "how":"string", "staffUserId":"string", "staffName":"string", "satisfied":true, "comments":"string" }] }Required
Fields{ }Dependent
Endpoints
obp.createMeeting
Create MeetingKafka/AkkaOutboundInboundTopicfrom.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.to.adapter.mf.caseclass.OutBoundCreateMeetingfrom.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.to.adapter.mf.caseclass.OutBoundCreateMeetingMessage{ "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":"2024-09-12T13:08: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":"2024-09-12T13:08: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":"2024-09-12T13:08: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 AccountKafka/AkkaOutboundInboundTopicfrom.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.to.adapter.mf.caseclass.OutBoundCreateBankAccountto.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.caseclass.OutBoundCreateBankAccountMessage{ "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":"2024-09-12T13:08: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":"2024-09-12T13:08: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/AkkaOutboundInboundTopicfrom.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.to.adapter.mf.caseclass.OutboundGetBankAccountsHeldto.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.caseclass.OutboundGetBankAccountsHeldMessage{ "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":"1100-01-01T01:01:01Z" }], "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", "label":"My Account", "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/AkkaOutboundInboundTopicfrom.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.to.adapter.mf.caseclass.OutboundGetCoreBankAccountsto.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.caseclass.OutboundGetCoreBankAccountsMessage{ "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":"1100-01-01T01:01:01Z" }], "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/AkkaOutboundInboundTopicfrom.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.to.adapter.mf.caseclass.OutboundCheckBankAccountExiststo.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.caseclass.OutboundCheckBankAccountExistsMessage{ "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":"1100-01-01T01:01:01Z" }], "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/AkkaOutboundInboundTopicfrom.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.to.adapter.mf.caseclass.OutboundGetAccountsto.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.caseclass.InboundGetAccountsMessage{ "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":"1100-01-01T01:01:01Z" }], "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":"1100-01-01T01:01:01Z" }] } }{ "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/AkkaOutboundInboundTopicfrom.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.to.adapter.mf.caseclass.OutboundGetAccountbyAccountIDto.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.caseclass.OutboundGetAccountbyAccountIDMessage{ "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":"1100-01-01T01:01:01Z" }], "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/AkkaOutboundInboundTopicfrom.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.to.adapter.mf.caseclass.OutboundGetCustomersByUserIdto.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.caseclass.OutboundGetCustomersByUserIdMessage{ "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":"1100-01-01T01:01:01Z" }], "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":"1100-01-01T01:01:01Z", "url":"String" }, "dateOfBirth":"1100-01-01T01:01:01Z", "relationshipStatus":"String", "dependents":1, "dobOfDependents":["1100-01-01T01:01:01Z"], "highestEducationAttained":"String", "employmentStatus":"String", "creditRating":{ "rating":"String", "source":"String" }, "creditLimit":{ "currency":"String", "amount":"String" }, "kycStatus":false, "lastOkDate":"1100-01-01T01:01:01Z" }] }Required
Fields{ }Dependent
Endpoints
obp.createCustomer
Create CustomerKafka/AkkaOutboundInboundTopicfrom.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.to.adapter.mf.caseclass.OutBoundCreateCustomerto.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.caseclass.OutBoundCreateCustomerMessage{ "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":"2024-09-12T13:08:32Z" }], "userOwners":[{ "userId":"string", "emailAddress":"string", "name":"string" }] } }] } }, "bankId":{ "value":"string" }, "legalName":"string", "mobileNumber":"string", "email":"string", "faceImage":{ "date":"2024-09-12T13:08:32Z", "url":"string" }, "dateOfBirth":"2024-09-12T13:08:32Z", "relationshipStatus":"string", "dependents":123, "dobOfDependents":["2024-09-12T13:08:32Z"], "highestEducationAttained":"string", "employmentStatus":"string", "kycStatus":true, "lastOkDate":"2024-09-12T13:08: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":"2024-09-12T13:08:32Z", "url":"string" }, "dateOfBirth":"2024-09-12T13:08:32Z", "relationshipStatus":"string", "dependents":123, "dobOfDependents":["2024-09-12T13:08:32Z"], "highestEducationAttained":"string", "employmentStatus":"string", "creditRating":{ "rating":"string", "source":"string" }, "creditLimit":{ "currency":"string", "amount":"string" }, "kycStatus":true, "lastOkDate":"2024-09-12T13:08:32Z", "title":"string", "branchId":"string", "nameSuffix":"string" } }Required
Fields{ }Dependent
Endpoints
obp.createOrUpdateKycCheck
Create Or Update Kyc CheckKafka/AkkaOutboundInboundTopicfrom.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.to.adapter.mf.caseclass.OutBoundCreateOrUpdateKycCheckto.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.caseclass.OutBoundCreateOrUpdateKycCheckMessage{ "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":"2024-09-12T13:08:32Z" }], "userOwners":[{ "userId":"string", "emailAddress":"string", "name":"string" }] } }] } }, "bankId":"string", "customerId":"string", "id":"string", "customerNumber":"string", "date":"2024-09-12T13:08: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":"2024-09-12T13:08:32Z", "how":"string", "staffUserId":"string", "staffName":"string", "satisfied":true, "comments":"string" } }Required
Fields{ }Dependent
Endpoints
obp.createOrUpdateKycDocument
Create Or Update Kyc DocumentKafka/AkkaOutboundInboundTopicfrom.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.to.adapter.mf.caseclass.OutBoundCreateOrUpdateKycDocumentto.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.caseclass.OutBoundCreateOrUpdateKycDocumentMessage{ "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":"2024-09-12T13:08:32Z" }], "userOwners":[{ "userId":"string", "emailAddress":"string", "name":"string" }] } }] } }, "bankId":"string", "customerId":"string", "id":"string", "customerNumber":"string", "type":"string", "number":"string", "issueDate":"2024-09-12T13:08:32Z", "issuePlace":"string", "expiryDate":"2024-09-12T13:08: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":"2024-09-12T13:08:32Z", "issuePlace":"string", "expiryDate":"2024-09-12T13:08:32Z" } }Required
Fields{ }Dependent
Endpoints
obp.createOrUpdateKycMedia
Create Or Update Kyc MediaKafka/AkkaOutboundInboundTopicfrom.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.to.adapter.mf.caseclass.OutBoundCreateOrUpdateKycMediato.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.caseclass.OutBoundCreateOrUpdateKycMediaMessage{ "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":"2024-09-12T13:08:32Z" }], "userOwners":[{ "userId":"string", "emailAddress":"string", "name":"string" }] } }] } }, "bankId":"string", "customerId":"string", "id":"string", "customerNumber":"string", "type":"string", "url":"string", "date":"2024-09-12T13:08: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":"2024-09-12T13:08:32Z", "relatesToKycDocumentId":"string", "relatesToKycCheckId":"string" } }Required
Fields{ }Dependent
Endpoints
obp.createOrUpdateKycStatus
Create Or Update Kyc StatusKafka/AkkaOutboundInboundTopicfrom.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.to.adapter.mf.caseclass.OutBoundCreateOrUpdateKycStatusto.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.caseclass.OutBoundCreateOrUpdateKycStatusMessage{ "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":"2024-09-12T13:08:32Z" }], "userOwners":[{ "userId":"string", "emailAddress":"string", "name":"string" }] } }] } }, "bankId":"string", "customerId":"string", "customerNumber":"string", "ok":true, "date":"2024-09-12T13:08: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":"2024-09-12T13:08:32Z" } }Required
Fields{ }Dependent
Endpoints
obp.getKycChecks
Get Kyc ChecksKafka/AkkaOutboundInboundTopicfrom.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.to.adapter.mf.caseclass.OutBoundGetKycChecksto.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.caseclass.OutBoundGetKycChecksMessage{ "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":"2024-09-12T13:08: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":"2024-09-12T13:08:32Z", "how":"string", "staffUserId":"string", "staffName":"string", "satisfied":true, "comments":"string" }] }Required
Fields{ }Dependent
Endpoints
obp.getKycDocuments
Get Kyc DocumentsKafka/AkkaOutboundInboundTopicfrom.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.to.adapter.mf.caseclass.OutBoundGetKycDocumentsto.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.caseclass.OutBoundGetKycDocumentsMessage{ "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":"2024-09-12T13:08: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":"2024-09-12T13:08:32Z", "issuePlace":"string", "expiryDate":"2024-09-12T13:08:32Z" }] }Required
Fields{ }Dependent
Endpoints
obp.getKycMedias
Get Kyc MediasKafka/AkkaOutboundInboundTopicfrom.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.to.adapter.mf.caseclass.OutBoundGetKycMediasto.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.caseclass.OutBoundGetKycMediasMessage{ "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":"2024-09-12T13:08: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":"2024-09-12T13:08:32Z", "relatesToKycDocumentId":"string", "relatesToKycCheckId":"string" }] }Required
Fields{ }Dependent
Endpoints
obp.getKycStatuses
Get Kyc StatusesKafka/AkkaOutboundInboundTopicfrom.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.to.adapter.mf.caseclass.OutBoundGetKycStatusesto.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.caseclass.OutBoundGetKycStatusesMessage{ "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":"2024-09-12T13:08: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":"2024-09-12T13:08:32Z" }] }Required
Fields{ }Dependent
Endpoints
obp.getCheckbookOrdersFuture
Get the status of CheckbookOrders for an Account.Kafka/AkkaOutboundInboundTopicfrom.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.to.adapter.mf.caseclass.OutboundGetCheckbookOrderStatusto.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.caseclass.OutboundGetCheckbookOrderStatusMessage{ "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":"1100-01-01T01:01:01Z" }], "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 CreditCardOrdersKafka/AkkaOutboundInboundTopicfrom.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.to.adapter.mf.caseclass.OutboundGetCreditCardOrderStatusto.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.caseclass.OutboundGetCreditCardOrderStatusMessage{ "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":"1100-01-01T01:01:01Z" }], "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 bankIdKafka/AkkaOutboundInboundTopicfrom.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.to.adapter.mf.caseclass.OutboundGetBranchesto.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.caseclass.OutboundGetBranchesMessage{ "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":"1100-01-01T01:01:01Z" }], "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 branchIdKafka/AkkaOutboundInboundTopicfrom.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.to.adapter.mf.caseclass.OutboundGetBranchto.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.caseclass.OutboundGetBranchMessage{ "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":"1100-01-01T01:01:01Z" }], "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 bankIdKafka/AkkaOutboundInboundTopicfrom.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.to.adapter.mf.caseclass.OutboundGetAtmsto.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.caseclass.OutboundGetAtmsMessage{ "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":"1100-01-01T01:01:01Z" }], "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/AkkaOutboundInboundTopicfrom.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.to.adapter.mf.caseclass.OutboundGetAtmto.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.caseclass.OutboundGetAtmMessage{ "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":"1100-01-01T01:01:01Z" }], "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/AkkaOutboundInboundTopicfrom.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.to.adapter.mf.caseclass.OutboundGetCounterpartiesto.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.caseclass.OutboundGetCounterpartiesMessage{ "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":"1100-01-01T01:01:01Z" }], "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":"", "currency":"", "otherAccountSecondaryRoutingScheme":"", "otherAccountSecondaryRoutingAddress":"", "bespoke":[{ "key":"key", "value":"value" }] }] }Required
Fields{ }Dependent
Endpoints
obp.getCounterpartyByCounterpartyId
Get a Counterparty by its counterpartyId.Kafka/AkkaOutboundInboundTopicfrom.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.to.adapter.mf.caseclass.OutboundGetCounterpartyByCounterpartyIdto.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.caseclass.OutboundGetCounterpartyByCounterpartyIdMessage{ "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":"1100-01-01T01:01:01Z" }], "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", "currency":"String", "otherAccountSecondaryRoutingScheme":"String", "otherAccountSecondaryRoutingAddress":"String", "bespoke":[] } }Required
Fields{ }Dependent
Endpoints
obp.getCounterpartyTrait
Get a Counterparty by its bankId, accountId and counterpartyIdKafka/AkkaOutboundInboundTopicfrom.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.to.adapter.mf.caseclass.OutboundGetCounterpartyto.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.caseclass.OutboundGetCounterpartyMessage{ "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":"1100-01-01T01:01:01Z" }], "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", "currency":"String", "otherAccountSecondaryRoutingScheme":"String", "otherAccountSecondaryRoutingAddress":"String", "bespoke":[] } }Required
Fields{ }Dependent
Endpoints
obp.getChallengeThreshold
Get Challenge ThresholdKafka/AkkaOutboundInboundTopicfrom.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.to.adapter.mf.caseclass.OutboundGetChallengeThresholdto.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.caseclass.OutboundGetChallengeThresholdMessage{ "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":"1100-01-01T01:01:01Z" }], "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/AkkaOutboundInboundTopicfrom.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.to.adapter.mf.caseclass.OutboundCreateTransactionto.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.caseclass.OutboundCreateTransactionMessage{ "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":"1100-01-01T01:01:01Z" }], "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":"The piano lession-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 CounterpartyKafka/AkkaOutboundInboundTopicfrom.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.to.adapter.mf.caseclass.OutboundCreateCounterpartyto.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.caseclass.OutboundCreateCounterpartyMessage{ "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":"1100-01-01T01:01:01Z" }], "userOwners":[{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "emailAddress":"felixsmith@example.com", "name":"Eveline Tripman" }] } }] }, "counterparty":{ "name":"name", "description":"description", "currency":"currency", "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", "currency":"String", "otherAccountSecondaryRoutingScheme":"String", "otherAccountSecondaryRoutingAddress":"String", "bespoke":[{ "key":"String", "value":"String" }] } }Required
Fields{ }Dependent
Endpoints
obp.getTransactionRequests210
Get Transaction RequestsKafka/AkkaOutboundInboundTopicfrom.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.to.adapter.mf.caseclass.OutboundGetTransactionRequests210to.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.caseclass.OutboundGetTransactionRequests210Message{ "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":"1100-01-01T01:01:01Z" }], "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_simple":{ "otherBankRoutingScheme":"BIC", "otherBankRoutingAddress":"GENODEM1GLS", "otherBranchRoutingScheme":"BRANCH-CODE", "otherBranchRoutingAddress":"DERBY6", "otherAccountRoutingScheme":"IBAN", "otherAccountRoutingAddress":"DE91 1000 0000 0123 4567 89", "otherAccountSecondaryRoutingScheme":"IBAN", "otherAccountSecondaryRoutingAddress":"DE91 1000 0000 0123 4567 89" }, "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":"This an optional field. Maximum length is 2000. It can be any characters here." }, "transaction_ids":"", "status":"COMPLETED", "start_date":"1100-01-01T01:01:01Z", "end_date":"1100-01-01T01:01:01Z", "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/AkkaOutboundInboundTopicfrom.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.to.adapter.mf.caseclass.OutboundCreateChallengeSept2018to.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.caseclass.OutboundCreateChallengeSept2018Message{ "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":"1100-01-01T01:01:01Z" }], "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/AkkaOutboundInboundTopicfrom.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.to.adapter.mf.caseclass.OutboundGetTransactionsto.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.caseclass.OutboundGetTransactionsMessage{ "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":"1100-01-01T01:01:01Z" }], "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":"The piano lession-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 transactionIdKafka/AkkaOutboundInboundTopicfrom.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.to.adapter.mf.caseclass.OutboundGetTransactionto.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.caseclass.OutboundGetTransactionMessage{ "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":"1100-01-01T01:01:01Z" }], "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":"The piano lession-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/AkkaOutboundInboundTopicfrom.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.to.adapter.mf.caseclass.OutboundGetUserByUsernamePasswordto.obp.api.ecad5a0e-14f5-4408-a71c-71938426d7e8.caseclass.OutboundGetUserByUsernamePasswordMessage{ "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":"1100-01-01T01:01:01Z" }], "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