API Explorer

Message Docs for Connector: akka_vDec2018

obp.get.AdapterInfo

                            
Gets information about the active general (non bank specific) Adapter that is responding to messages sent by OBP.
Kafka/Akka
Outbound
Inbound
Topic
OutboundGetAdapterInfo
InboundAdapterInfo
Message
{ "date":"2019-04-06T11:59:22.194Z", "callContext":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "consumerId":"9ddb6507-9cec-4e5e-b09a-ef1cb203825a", "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50" } }
{ "name":"The south side of Akka connector", "version":"Dec2018", "git_commit":"59623811dd8a41f6ffe67be46954eee11913dc28", "date":"2019-04-06T11:59:22.201Z", "callContext":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "consumerId":"9ddb6507-9cec-4e5e-b09a-ef1cb203825a", "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50" } }

obp.get.Banks

                            
Gets the banks list on this OBP installation.
Kafka/Akka
Outbound
Inbound
Topic
OutboundGetBanks
InboundGetBanks
Message
{ "callContext":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "consumerId":"9ddb6507-9cec-4e5e-b09a-ef1cb203825a", "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50" } }
{ "payload":[{ "bankId":"GENODEM1GLS", "shortName":"The Royal Bank of Scotland", "fullName":"The Royal Bank of Scotland", "logoUrl":"http://www.red-bank-shoreditch.com/logo.gif", "websiteUrl":"http://www.red-bank-shoreditch.com", "bankRoutingScheme":"OBP", "bankRoutingAddress":"rbs" }], "callContext":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "consumerId":"9ddb6507-9cec-4e5e-b09a-ef1cb203825a", "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50" } }

obp.get.Bank

                            
Get a specific Bank as specified by bankId
Kafka/Akka
Outbound
Inbound
Topic
OutboundGetBank
InboundGetBank
Message
{ "bankId":"GENODEM1GLS", "callContext":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "consumerId":"9ddb6507-9cec-4e5e-b09a-ef1cb203825a", "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50" } }
{ "payload":{ "bankId":"GENODEM1GLS", "shortName":"The Royal Bank of Scotland", "fullName":"The Royal Bank of Scotland", "logoUrl":"http://www.red-bank-shoreditch.com/logo.gif", "websiteUrl":"http://www.red-bank-shoreditch.com", "bankRoutingScheme":"OBP", "bankRoutingAddress":"rbs" }, "callContext":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "consumerId":"9ddb6507-9cec-4e5e-b09a-ef1cb203825a", "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50" } }

obp.get.CustomersByUserId

                            
Get Customers represented by the User.
Kafka/Akka
Outbound
Inbound
Topic
OutboundGetCustomersByUserId
InboundGetCustomersByUserId
Message
{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "callContext":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "consumerId":"9ddb6507-9cec-4e5e-b09a-ef1cb203825a", "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50" } }
{ "payload":[{ "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "bankId":"GENODEM1GLS", "number":"5987953", "legalName":"Eveline Tripman", "mobileNumber":"String", "email":"String", "faceImage":{ "date":"2017-09-19T00:00:00Z", "url":"String" }, "dateOfBirth":"2017-09-19T00:00:00Z", "relationshipStatus":"String", "dependents":1, "dobOfDependents":["2017-09-19T00:00:00Z"], "highestEducationAttained":"String", "employmentStatus":"String", "creditRating":{ "rating":"String", "source":"String" }, "creditLimit":{ "currency":"EUR", "amount":"1000.00" }, "kycStatus":false, "lastOkDate":"2017-09-19T00:00:00Z" }], "callContext":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "consumerId":"9ddb6507-9cec-4e5e-b09a-ef1cb203825a", "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50" } }

obp.get.coreBankAccounts

                            
Get bank Accounts available to the User (without Metadata)
Kafka/Akka
Outbound
Inbound
Topic
OutboundGetCoreBankAccounts
InboundGetCoreBankAccounts
Message
{ "bankIdAccountIds":[{ "bankId":{ "value":"GENODEM1GLS" }, "accountId":{ "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" } }], "callContext":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "consumerId":"9ddb6507-9cec-4e5e-b09a-ef1cb203825a", "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50" } }
{ "payload":[{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "label":"My private account for Uber", "bankId":"GENODEM1GLS", "accountType":"AC", "accountRoutings":[{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }] }], "callContext":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "consumerId":"9ddb6507-9cec-4e5e-b09a-ef1cb203825a", "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50" } }

obp.check.BankAccountExists

                            
Check a bank Account exists - as specified by bankId and accountId.
Kafka/Akka
Outbound
Inbound
Topic
OutboundCheckBankAccountExists
InboundCheckBankAccountExists
Message
{ "bankId":"GENODEM1GLS", "ccountId":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "callContext":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "consumerId":"9ddb6507-9cec-4e5e-b09a-ef1cb203825a", "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50" } }
{ "payload":{ "bankId":"GENODEM1GLS", "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":[] }, "callContext":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "consumerId":"9ddb6507-9cec-4e5e-b09a-ef1cb203825a", "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50" } }

obp.get.Account

                            
Get a single Account as specified by the bankId and accountId.
Kafka/Akka
Outbound
Inbound
Topic
OutboundGetAccount
InboundGetAccount
Message
{ "bankId":"GENODEM1GLS", "accountId":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "callContext":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "consumerId":"9ddb6507-9cec-4e5e-b09a-ef1cb203825a", "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50" } }
{ "payload":{ "bankId":"GENODEM1GLS", "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":[] }, "callContext":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "consumerId":"9ddb6507-9cec-4e5e-b09a-ef1cb203825a", "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50" } }

obp.get.counterparties

                            
Get Counterparties available to the View on the Account specified by thisBankId, thisAccountId and viewId.
Kafka/Akka
Outbound
Inbound
Topic
OutboundGetCounterparties
InboundGetCounterparties
Message
{ "thisBankId":"GENODEM1GLS", "thisAccountId":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "viewId":"Auditor", "callContext":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "consumerId":"9ddb6507-9cec-4e5e-b09a-ef1cb203825a", "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50" } }
{ "payload":[{ "createdByUserId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "name":"", "thisBankId":"GENODEM1GLS", "thisAccountId":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "thisViewId":"Auditor", "counterpartyId":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh", "otherAccountRoutingScheme":"IBAN", "otherAccountRoutingAddress":"DE91 1000 0000 0123 4567 89", "otherBankRoutingScheme":"BIC", "otherBankRoutingAddress":"GENODEM1GLS", "otherBranchRoutingScheme":"IBAN", "otherBranchRoutingAddress":"DE91 1000 0000 0123 4567 89", "isBeneficiary":true, "description":"", "otherAccountSecondaryRoutingScheme":"IBAN", "otherAccountSecondaryRoutingAddress":"DE91 1000 0000 0123 4567 89", "bespoke":[{ "key":"key", "value":"value" }] }], "callContext":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "consumerId":"9ddb6507-9cec-4e5e-b09a-ef1cb203825a", "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50" } }

obp.get.Transactions

                            
Get Transactions for an Account specified by bankId and accountId. Pagination is achieved with limit, fromDate and toDate.
Kafka/Akka
Outbound
Inbound
Topic
OutboundGetTransactions
InboundGetTransactions
Message
{ "bankId":"GENODEM1GLS", "accountId":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "limit":100, "fromDate":"2017-09-19T02:31:05Z", "toDate":"2017-09-19T02:31:05Z", "callContext":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "consumerId":"9ddb6507-9cec-4e5e-b09a-ef1cb203825a", "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50" } }
{ "payload":[], "callContext":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "consumerId":"9ddb6507-9cec-4e5e-b09a-ef1cb203825a", "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50" } }

obp.get.Transaction

                            
Get a single Transaction specified by bankId, accountId and transactionId
Kafka/Akka
Outbound
Inbound
Topic
OutboundGetTransaction
InboundGetTransaction
Message
{ "bankId":"GENODEM1GLS", "accountId":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "transactionId":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub", "callContext":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "consumerId":"9ddb6507-9cec-4e5e-b09a-ef1cb203825a", "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50" } }
{ "callContext":{ "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "consumerId":"9ddb6507-9cec-4e5e-b09a-ef1cb203825a", "correlationId":"1flssoftxq0cr1nssr68u0mioj", "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50" } }