API Explorer

Message Docs for Connector: kafka_vSept2018

obp.get.AdapterInfo

Get's information about the active general (non bank specific) Adapter that is responding to messages sent by OBP.
Kafka
Outbound
Inbound
Topic
from.obp.api.{api_instance_id}.to.adapter.mf.caseclass.OutboundGetAdapterInfo
to.obp.api.{api_instance_id}.caseclass.OutboundGetAdapterInfo
Message
{ "date":"2017-09-19T02:31:05Z" }
{ "data":{ "errorCode":"INTERNAL-OBP-ADAPTER-6001: ...", "backendMessages":[{ "source":"ESB", "status":"Success", "errorCode":"0", "text":"OK" }], "name":"Obp-Kafka-South", "version":"Sept2018", "git_commit":"...", "date":"2017-09-19T02:31:05Z" } }

obp.get.User

Gets the User as identified by the the credentials (username and password) supplied.
Kafka
Outbound
Inbound
Topic
from.obp.api.{api_instance_id}.to.adapter.mf.caseclass.OutboundGetUserByUsernamePassword
to.obp.api.{api_instance_id}.caseclass.OutboundGetUserByUsernamePassword
Message
{ "authInfo":{ "userId":"userId", "username":"username", "cbsToken":"cbsToken", "isFirst":true, "correlationId":"correlationId", "linkedCustomers":[{ "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName" }], "authViews":[{ "view":{ "id":"owner", "short_name":"Owner", "description":"This is the owner view" }, "account":{ "id":"123123", "accountRoutings":[{ "scheme":"AccountNumber", "address":"2345 6789 1234" },{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"bankId", "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName", "dateOfBirth":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"userId", "emailAddress":"emailAddress", "name":"name" }] } }] }, "password":"2b78e8" }
{ "authInfo":{ "userId":"userId", "username":"username", "cbsToken":"cbsToken", "isFirst":true, "correlationId":"correlationId", "linkedCustomers":[{ "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName" }], "authViews":[{ "view":{ "id":"owner", "short_name":"Owner", "description":"This is the owner view" }, "account":{ "id":"123123", "accountRoutings":[{ "scheme":"AccountNumber", "address":"2345 6789 1234" },{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"bankId", "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName", "dateOfBirth":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"userId", "emailAddress":"emailAddress", "name":"name" }] } }] }, "data":{ "errorCode":"INTERNAL-OBP-ADAPTER-6001: ...", "backendMessages":[{ "source":"ESB", "status":"Success", "errorCode":"0", "text":"OK" }], "email":"susan.uk.29@example.com", "displayName":"susan" } }

obp.get.Banks

Gets the banks list on this OBP installation.
Kafka
Outbound
Inbound
Topic
from.obp.api.{api_instance_id}.to.adapter.mf.caseclass.OutboundGetBanks
to.obp.api.{api_instance_id}.caseclass.OutboundGetBanks
Message
{ "authInfo":{ "userId":"userId", "username":"username", "cbsToken":"cbsToken", "isFirst":true, "correlationId":"correlationId", "linkedCustomers":[{ "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName" }], "authViews":[{ "view":{ "id":"owner", "short_name":"Owner", "description":"This is the owner view" }, "account":{ "id":"123123", "accountRoutings":[{ "scheme":"AccountNumber", "address":"2345 6789 1234" },{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"bankId", "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName", "dateOfBirth":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"userId", "emailAddress":"emailAddress", "name":"name" }] } }] } }
{ "authInfo":{ "userId":"userId", "username":"username", "cbsToken":"cbsToken", "isFirst":true, "correlationId":"correlationId", "linkedCustomers":[{ "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName" }], "authViews":[{ "view":{ "id":"owner", "short_name":"Owner", "description":"This is the owner view" }, "account":{ "id":"123123", "accountRoutings":[{ "scheme":"AccountNumber", "address":"2345 6789 1234" },{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"bankId", "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName", "dateOfBirth":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"userId", "emailAddress":"emailAddress", "name":"name" }] } }] }, "status":{ "errorCode":"INTERNAL-OBP-ADAPTER-6001: ...", "backendMessages":[{ "source":"ESB", "status":"Success", "errorCode":"0", "text":"OK" }] }, "data":[{ "bankId":"gh.29.uk", "name":"sushan", "logo":"TESOBE", "url":"https://tesobe.com/" }] }

obp.get.Bank

Get a specific Bank as specified by bankId
Kafka
Outbound
Inbound
Topic
from.obp.api.{api_instance_id}.to.adapter.mf.caseclass.OutboundGetBank
to.obp.api.{api_instance_id}.caseclass.OutboundGetBank
Message
{ "authInfo":{ "userId":"userId", "username":"username", "cbsToken":"cbsToken", "isFirst":true, "correlationId":"correlationId", "linkedCustomers":[{ "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName" }], "authViews":[{ "view":{ "id":"owner", "short_name":"Owner", "description":"This is the owner view" }, "account":{ "id":"123123", "accountRoutings":[{ "scheme":"AccountNumber", "address":"2345 6789 1234" },{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"bankId", "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName", "dateOfBirth":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"userId", "emailAddress":"emailAddress", "name":"name" }] } }] }, "bankId":"bankId" }
{ "authInfo":{ "userId":"userId", "username":"username", "cbsToken":"cbsToken", "isFirst":true, "correlationId":"correlationId", "linkedCustomers":[{ "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName" }], "authViews":[{ "view":{ "id":"owner", "short_name":"Owner", "description":"This is the owner view" }, "account":{ "id":"123123", "accountRoutings":[{ "scheme":"AccountNumber", "address":"2345 6789 1234" },{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"bankId", "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName", "dateOfBirth":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"userId", "emailAddress":"emailAddress", "name":"name" }] } }] }, "status":{ "errorCode":"INTERNAL-OBP-ADAPTER-6001: ...", "backendMessages":[{ "source":"ESB", "status":"Success", "errorCode":"0", "text":"OK" }] }, "data":{ "bankId":"gh.29.uk", "name":"sushan", "logo":"TESOBE", "url":"https://tesobe.com/" } }

obp.get.Accounts

Gets the list of accounts available to the User. This call sends authInfo including username.
Kafka
Outbound
Inbound
Topic
from.obp.api.{api_instance_id}.to.adapter.mf.caseclass.OutboundGetAccounts
to.obp.api.{api_instance_id}.caseclass.OutboundGetAccounts
Message
{ "authInfo":{ "userId":"userId", "username":"username", "cbsToken":"cbsToken", "isFirst":true, "correlationId":"correlationId", "linkedCustomers":[{ "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName" }], "authViews":[{ "view":{ "id":"owner", "short_name":"Owner", "description":"This is the owner view" }, "account":{ "id":"123123", "accountRoutings":[{ "scheme":"AccountNumber", "address":"2345 6789 1234" },{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"bankId", "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName", "dateOfBirth":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"userId", "emailAddress":"emailAddress", "name":"name" }] } }] }, "customers":{ "customers":[{ "bankId":"bankId", "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName", "dateOfBirth":"2017-09-19T00:00:00Z" }] } }
{ "authInfo":{ "userId":"userId", "username":"username", "cbsToken":"cbsToken", "isFirst":true, "correlationId":"correlationId", "linkedCustomers":[{ "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName" }], "authViews":[{ "view":{ "id":"owner", "short_name":"Owner", "description":"This is the owner view" }, "account":{ "id":"123123", "accountRoutings":[{ "scheme":"AccountNumber", "address":"2345 6789 1234" },{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"bankId", "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName", "dateOfBirth":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"userId", "emailAddress":"emailAddress", "name":"name" }] } }] }, "status":{ "errorCode":"INTERNAL-OBP-ADAPTER-6001: ...", "backendMessages":[{ "source":"ESB", "status":"Success", "errorCode":"0", "text":"OK" }] }, "data":[{ "errorCode":"", "cbsToken":"cbsToken", "bankId":"gh.29.uk", "branchId":"222", "accountId":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0", "accountNumber":"123", "accountType":"AC", "balanceAmount":"50", "balanceCurrency":"EUR", "owners":["Susan"," Frank"], "viewsToGenerate":["Public","Accountant","Auditor"], "bankRoutingScheme":"iban", "bankRoutingAddress":"bankRoutingAddress", "branchRoutingScheme":"branchRoutingScheme", "branchRoutingAddress":" branchRoutingAddress", "accountRoutingScheme":"accountRoutingScheme", "accountRoutingAddress":"accountRoutingAddress", "accountRouting":[], "accountRules":[] }] }

obp.get.Account

Get a single Account as specified by the bankId and accountId.
Kafka
Outbound
Inbound
Topic
from.obp.api.{api_instance_id}.to.adapter.mf.caseclass.OutboundGetAccountbyAccountID
to.obp.api.{api_instance_id}.caseclass.OutboundGetAccountbyAccountID
Message
{ "authInfo":{ "userId":"userId", "username":"username", "cbsToken":"cbsToken", "isFirst":true, "correlationId":"correlationId", "linkedCustomers":[{ "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName" }], "authViews":[{ "view":{ "id":"owner", "short_name":"Owner", "description":"This is the owner view" }, "account":{ "id":"123123", "accountRoutings":[{ "scheme":"AccountNumber", "address":"2345 6789 1234" },{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"bankId", "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName", "dateOfBirth":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"userId", "emailAddress":"emailAddress", "name":"name" }] } }] }, "bankId":"bankId", "accountId":"accountId" }
{ "authInfo":{ "userId":"userId", "username":"username", "cbsToken":"cbsToken", "isFirst":true, "correlationId":"correlationId", "linkedCustomers":[{ "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName" }], "authViews":[{ "view":{ "id":"owner", "short_name":"Owner", "description":"This is the owner view" }, "account":{ "id":"123123", "accountRoutings":[{ "scheme":"AccountNumber", "address":"2345 6789 1234" },{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"bankId", "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName", "dateOfBirth":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"userId", "emailAddress":"emailAddress", "name":"name" }] } }] }, "status":{ "errorCode":"INTERNAL-OBP-ADAPTER-6001: ...", "backendMessages":[{ "source":"ESB", "status":"Success", "errorCode":"0", "text":"OK" }] }, "data":{ "errorCode":"", "cbsToken":"cbsToken", "bankId":"gh.29.uk", "branchId":"222", "accountId":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0", "accountNumber":"123", "accountType":"AC", "balanceAmount":"50", "balanceCurrency":"EUR", "owners":["Susan"," Frank"], "viewsToGenerate":["Public","Accountant","Auditor"], "bankRoutingScheme":"iban", "bankRoutingAddress":"bankRoutingAddress", "branchRoutingScheme":"branchRoutingScheme", "branchRoutingAddress":" branchRoutingAddress", "accountRoutingScheme":"accountRoutingScheme", "accountRoutingAddress":"accountRoutingAddress", "accountRouting":[], "accountRules":[] } }

obp.check.BankAccountExists

Check a bank Account exists - as specified by bankId and accountId.
Kafka
Outbound
Inbound
Topic
from.obp.api.{api_instance_id}.to.adapter.mf.caseclass.OutboundCheckBankAccountExists
to.obp.api.{api_instance_id}.caseclass.OutboundCheckBankAccountExists
Message
{ "authInfo":{ "userId":"userId", "username":"username", "cbsToken":"cbsToken", "isFirst":true, "correlationId":"correlationId", "linkedCustomers":[{ "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName" }], "authViews":[{ "view":{ "id":"owner", "short_name":"Owner", "description":"This is the owner view" }, "account":{ "id":"123123", "accountRoutings":[{ "scheme":"AccountNumber", "address":"2345 6789 1234" },{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"bankId", "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName", "dateOfBirth":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"userId", "emailAddress":"emailAddress", "name":"name" }] } }] }, "bankId":"bankId1 : A string that MUST uniquely identify the bank on this OBP instance. It COULD be a UUID but is generally a short string that easily identifies the bank / brand it represents.", "accountId":"accountId" }
{ "authInfo":{ "userId":"userId", "username":"username", "cbsToken":"cbsToken", "isFirst":true, "correlationId":"correlationId", "linkedCustomers":[{ "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName" }], "authViews":[{ "view":{ "id":"owner", "short_name":"Owner", "description":"This is the owner view" }, "account":{ "id":"123123", "accountRoutings":[{ "scheme":"AccountNumber", "address":"2345 6789 1234" },{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"bankId", "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName", "dateOfBirth":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"userId", "emailAddress":"emailAddress", "name":"name" }] } }] }, "status":{ "errorCode":"INTERNAL-OBP-ADAPTER-6001: ...", "backendMessages":[{ "source":"ESB", "status":"Success", "errorCode":"0", "text":"OK" }] }, "data":{ "errorCode":"", "cbsToken":"cbsToken", "bankId":"bankId1 : A string that MUST uniquely identify the bank on this OBP instance. It COULD be a UUID but is generally a short string that easily identifies the bank / brand it represents.", "branchId":"222", "accountId":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0", "accountNumber":"123", "accountType":"AC", "balanceAmount":"50", "balanceCurrency":"EUR", "owners":["Susan"," Frank"], "viewsToGenerate":["Public","Accountant","Auditor"], "bankRoutingScheme":"iban", "bankRoutingAddress":"bankRoutingAddress", "branchRoutingScheme":"branchRoutingScheme", "branchRoutingAddress":" branchRoutingAddress", "accountRoutingScheme":"accountRoutingScheme", "accountRoutingAddress":"accountRoutingAddress", "accountRouting":[], "accountRules":[] } }

obp.get.coreBankAccounts

Get bank Accounts available to the User (without Metadata)
Kafka
Outbound
Inbound
Topic
from.obp.api.{api_instance_id}.to.adapter.mf.caseclass.OutboundGetAccountbyAccountID
to.obp.api.{api_instance_id}.caseclass.OutboundGetAccountbyAccountID
Message
{ "authInfo":{ "userId":"userId", "username":"username", "cbsToken":"cbsToken", "isFirst":true, "correlationId":"correlationId", "linkedCustomers":[{ "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName" }], "authViews":[{ "view":{ "id":"owner", "short_name":"Owner", "description":"This is the owner view" }, "account":{ "id":"123123", "accountRoutings":[{ "scheme":"AccountNumber", "address":"2345 6789 1234" },{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"bankId", "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName", "dateOfBirth":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"userId", "emailAddress":"emailAddress", "name":"name" }] } }] }, "bankId":"bankId1 : A string that MUST uniquely identify the bank on this OBP instance. It COULD be a UUID but is generally a short string that easily identifies the bank / brand it represents.", "accountId":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0 : A string that MUST uniquely identify the account on this OBP instance. A non reversible hash of the human readable account number." }
{ "authInfo":{ "userId":"userId", "username":"username", "cbsToken":"cbsToken", "isFirst":true, "correlationId":"correlationId", "linkedCustomers":[{ "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName" }], "authViews":[{ "view":{ "id":"owner", "short_name":"Owner", "description":"This is the owner view" }, "account":{ "id":"123123", "accountRoutings":[{ "scheme":"AccountNumber", "address":"2345 6789 1234" },{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"bankId", "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName", "dateOfBirth":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"userId", "emailAddress":"emailAddress", "name":"name" }] } }] }, "status":{ "errorCode":"INTERNAL-OBP-ADAPTER-6001: ...", "backendMessages":[{ "source":"ESB", "status":"Success", "errorCode":"0", "text":"OK" }] }, "data":{ "errorCode":"", "cbsToken":"cbsToken", "bankId":"gh.29.uk", "branchId":"222", "accountId":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0", "accountNumber":"123", "accountType":"AC", "balanceAmount":"50", "balanceCurrency":"EUR", "owners":["Susan"," Frank"], "viewsToGenerate":["Public","Accountant","Auditor"], "bankRoutingScheme":"iban", "bankRoutingAddress":"bankRoutingAddress", "branchRoutingScheme":"branchRoutingScheme", "branchRoutingAddress":" branchRoutingAddress", "accountRoutingScheme":"accountRoutingScheme", "accountRoutingAddress":"accountRoutingAddress", "accountRouting":[], "accountRules":[] } }

obp.get.Transactions

Get Transactions for an Account specified by bankId and accountId. Pagination is achieved with limit, fromDate and toDate.
Kafka
Outbound
Inbound
Topic
from.obp.api.{api_instance_id}.to.adapter.mf.caseclass.OutboundGetTransactions
to.obp.api.{api_instance_id}.caseclass.OutboundGetTransactions
Message
{ "authInfo":{ "userId":"userId", "username":"username", "cbsToken":"cbsToken", "isFirst":true, "correlationId":"correlationId", "linkedCustomers":[{ "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName" }], "authViews":[{ "view":{ "id":"owner", "short_name":"Owner", "description":"This is the owner view" }, "account":{ "id":"123123", "accountRoutings":[{ "scheme":"AccountNumber", "address":"2345 6789 1234" },{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"bankId", "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName", "dateOfBirth":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"userId", "emailAddress":"emailAddress", "name":"name" }] } }] }, "bankId":"bankId", "accountId":"accountId", "limit":100, "fromDate":"DateWithSecondsExampleObject", "toDate":"DateWithSecondsExampleObject" }
{ "authInfo":{ "userId":"userId", "username":"username", "cbsToken":"cbsToken", "isFirst":true, "correlationId":"correlationId", "linkedCustomers":[{ "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName" }], "authViews":[{ "view":{ "id":"owner", "short_name":"Owner", "description":"This is the owner view" }, "account":{ "id":"123123", "accountRoutings":[{ "scheme":"AccountNumber", "address":"2345 6789 1234" },{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"bankId", "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName", "dateOfBirth":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"userId", "emailAddress":"emailAddress", "name":"name" }] } }] }, "status":{ "errorCode":"INTERNAL-OBP-ADAPTER-6001: ...", "backendMessages":[{ "source":"ESB", "status":"Success", "errorCode":"0", "text":"OK" }] }, "data":[{ "transactionId":"String", "accountId":"String", "amount":"String", "bankId":"String", "completedDate":"String", "counterpartyId":"String", "counterpartyName":"String", "currency":"String", "description":"String", "newBalanceAmount":"String", "newBalanceCurrency":"String", "postedDate":"String", "type":"String", "userId":"String" }] }

obp.get.Transaction

Get a single Transaction specified by bankId, accountId and transactionId
Kafka
Outbound
Inbound
Topic
from.obp.api.{api_instance_id}.to.adapter.mf.caseclass.OutboundGetTransaction
to.obp.api.{api_instance_id}.caseclass.OutboundGetTransaction
Message
{ "authInfo":{ "userId":"userId", "username":"username", "cbsToken":"cbsToken", "isFirst":true, "correlationId":"correlationId", "linkedCustomers":[{ "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName" }], "authViews":[{ "view":{ "id":"owner", "short_name":"Owner", "description":"This is the owner view" }, "account":{ "id":"123123", "accountRoutings":[{ "scheme":"AccountNumber", "address":"2345 6789 1234" },{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"bankId", "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName", "dateOfBirth":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"userId", "emailAddress":"emailAddress", "name":"name" }] } }] }, "bankId":"bankId", "accountId":"accountId", "transactionId":"transactionId" }
{ "authInfo":{ "userId":"userId", "username":"username", "cbsToken":"cbsToken", "isFirst":true, "correlationId":"correlationId", "linkedCustomers":[{ "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName" }], "authViews":[{ "view":{ "id":"owner", "short_name":"Owner", "description":"This is the owner view" }, "account":{ "id":"123123", "accountRoutings":[{ "scheme":"AccountNumber", "address":"2345 6789 1234" },{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"bankId", "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName", "dateOfBirth":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"userId", "emailAddress":"emailAddress", "name":"name" }] } }] }, "status":{ "errorCode":"INTERNAL-OBP-ADAPTER-6001: ...", "backendMessages":[{ "source":"ESB", "status":"Success", "errorCode":"0", "text":"OK" }] }, "data":{ "transactionId":"String", "accountId":"String", "amount":"String", "bankId":"String", "completedDate":"2018-10-19T21:17:03Z", "counterpartyId":"String", "counterpartyName":"String", "currency":"String", "description":"String", "newBalanceAmount":"String", "newBalanceCurrency":"String", "postedDate":"2018-10-19T21:17:03Z", "type":"String", "userId":"String" } }

obp.create.Challenge

Create a Security Challenge that may be used to complete a Transaction Request.
Kafka
Outbound
Inbound
Topic
from.obp.api.{api_instance_id}.to.adapter.mf.caseclass.OutboundChallengeBase
to.obp.api.{api_instance_id}.caseclass.OutboundChallengeBase
Message
{ "messageFormat":"Sept2018", "action":"obp.create.Challenge", "bankId":"gh.29.uk", "accountId":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0", "userId":"c7b6cb47-cb96-4441-8801-35b57456753a", "username":"susan.uk.29@example.com", "transactionRequestType":"SANDBOX_TAN", "transactionRequestId":"1234567" }
{ "authInfo":{ "userId":"userId", "username":"username", "cbsToken":"cbsToken", "isFirst":true, "correlationId":"correlationId", "linkedCustomers":[{ "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName" }], "authViews":[{ "view":{ "id":"owner", "short_name":"Owner", "description":"This is the owner view" }, "account":{ "id":"123123", "accountRoutings":[{ "scheme":"AccountNumber", "address":"2345 6789 1234" },{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"bankId", "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName", "dateOfBirth":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"userId", "emailAddress":"emailAddress", "name":"name" }] } }] }, "data":{ "errorCode":"INTERNAL-OBP-ADAPTER-6001: ...", "backendMessages":[{ "source":"ESB", "status":"Success", "errorCode":"0", "text":"OK" }], "answer":"1234" } }

obp.create.Counterparty

Create Counterparty
Kafka
Outbound
Inbound
Topic
from.obp.api.{api_instance_id}.to.adapter.mf.caseclass.OutboundCreateCounterparty
to.obp.api.{api_instance_id}.caseclass.OutboundCreateCounterparty
Message
{ "authInfo":{ "userId":"userId", "username":"username", "cbsToken":"cbsToken", "isFirst":true, "correlationId":"correlationId", "linkedCustomers":[{ "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName" }], "authViews":[{ "view":{ "id":"owner", "short_name":"Owner", "description":"This is the owner view" }, "account":{ "id":"123123", "accountRoutings":[{ "scheme":"AccountNumber", "address":"2345 6789 1234" },{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"bankId", "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName", "dateOfBirth":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"userId", "emailAddress":"emailAddress", "name":"name" }] } }] }, "counterparty":{ "name":"name", "description":"description", "createdByUserId":"createdByUserId", "thisBankId":"thisBankId", "thisAccountId":"thisAccountId", "thisViewId":"thisViewId", "otherAccountRoutingScheme":"otherAccountRoutingScheme", "otherAccountRoutingAddress":"otherAccountRoutingAddress", "otherAccountSecondaryRoutingScheme":"otherAccountSecondaryRoutingScheme", "otherAccountSecondaryRoutingAddress":"otherAccountSecondaryRoutingAddress", "otherBankRoutingScheme":"otherBankRoutingScheme", "otherBankRoutingAddress":"otherBankRoutingAddress", "otherBranchRoutingScheme":"otherBranchRoutingScheme", "otherBranchRoutingAddress":"otherBranchRoutingAddress", "isBeneficiary":true, "bespoke":[{ "key":"key", "value":"value" }] } }
{ "authInfo":{ "userId":"userId", "username":"username", "cbsToken":"cbsToken", "isFirst":true, "correlationId":"correlationId", "linkedCustomers":[{ "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName" }], "authViews":[{ "view":{ "id":"owner", "short_name":"Owner", "description":"This is the owner view" }, "account":{ "id":"123123", "accountRoutings":[{ "scheme":"AccountNumber", "address":"2345 6789 1234" },{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"bankId", "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName", "dateOfBirth":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"userId", "emailAddress":"emailAddress", "name":"name" }] } }] }, "status":{ "errorCode":"INTERNAL-OBP-ADAPTER-6001: ...", "backendMessages":[{ "source":"ESB", "status":"Success", "errorCode":"0", "text":"OK" }] }, "data":{ "createdByUserId":"String", "name":"String", "thisBankId":"String", "thisAccountId":"String", "thisViewId":"String", "counterpartyId":"String", "otherAccountRoutingScheme":"String", "otherAccountRoutingAddress":"String", "otherBankRoutingScheme":"String", "otherBankRoutingAddress":"String", "otherBranchRoutingScheme":"String", "otherBranchRoutingAddress":"String", "isBeneficiary":false, "description":"String", "otherAccountSecondaryRoutingScheme":"String", "otherAccountSecondaryRoutingAddress":"String", "bespoke":[{ "key":"String", "value":"String" }] } }

obp.get.transactionRequests210

Get Transaction Requests
Kafka
Outbound
Inbound
Topic
from.obp.api.{api_instance_id}.to.adapter.mf.caseclass.OutboundGetTransactionRequests210
to.obp.api.{api_instance_id}.caseclass.OutboundGetTransactionRequests210
Message
{ "authInfo":{ "userId":"userId", "username":"username", "cbsToken":"cbsToken", "isFirst":true, "correlationId":"correlationId", "linkedCustomers":[{ "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName" }], "authViews":[{ "view":{ "id":"owner", "short_name":"Owner", "description":"This is the owner view" }, "account":{ "id":"123123", "accountRoutings":[{ "scheme":"AccountNumber", "address":"2345 6789 1234" },{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"bankId", "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName", "dateOfBirth":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"userId", "emailAddress":"emailAddress", "name":"name" }] } }] }, "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" } }
{ "authInfo":{ "userId":"userId", "username":"username", "cbsToken":"cbsToken", "isFirst":true, "correlationId":"correlationId", "linkedCustomers":[{ "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName" }], "authViews":[{ "view":{ "id":"owner", "short_name":"Owner", "description":"This is the owner view" }, "account":{ "id":"123123", "accountRoutings":[{ "scheme":"AccountNumber", "address":"2345 6789 1234" },{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"bankId", "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName", "dateOfBirth":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"userId", "emailAddress":"emailAddress", "name":"name" }] } }] }, "status":{ "errorCode":"INTERNAL-OBP-ADAPTER-6001: ...", "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":"String" }, "to_transfer_to_phone":{ "value":{ "currency":"EUR", "amount":"10" }, "description":"String", "message":"String", "from":{ "mobile_phone_number":"String", "nickname":"String" }, "to":{ "mobile_phone_number":"String" } }, "to_transfer_to_atm":{ "value":{ "currency":"EUR", "amount":"10" }, "description":"String", "message":"String", "from":{ "mobile_phone_number":"String", "nickname":"String" }, "to":{ "legal_name":"String", "date_of_birth":"20181230", "mobile_phone_number":"String", "kyc_document":{ "type":"String", "number":"String" } } }, "to_transfer_to_account":{ "value":{ "currency":"EUR", "amount":"10" }, "description":"String", "transfer_type":"String", "future_date":"20181230", "to":{ "name":"String", "bank_code":"String", "branch_number":"String", "account":{ "number":"String", "iban":"String" } } }, "value":{ "currency":"EUR", "amount":"100" }, "description":"String" }, "transaction_ids":"", "status":"COMPLETED", "start_date":"2017-09-19T00:00:00Z", "end_date":"2017-09-19T00:00:00Z", "challenge":{ "id":"", "allowed_attempts":0, "challenge_type":"" }, "charge":{ "summary":"", "value":{ "currency":"ILS", "amount":"0" } }, "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 }] }

obp.get.counterparties

Get Counterparties available to the View on the Account specified by thisBankId, thisAccountId and viewId.
Kafka
Outbound
Inbound
Topic
from.obp.api.{api_instance_id}.to.adapter.mf.caseclass.OutboundGetCounterparties
to.obp.api.{api_instance_id}.caseclass.OutboundGetCounterparties
Message
{ "authInfo":{ "userId":"userId", "username":"username", "cbsToken":"cbsToken", "isFirst":true, "correlationId":"correlationId", "linkedCustomers":[{ "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName" }], "authViews":[{ "view":{ "id":"owner", "short_name":"Owner", "description":"This is the owner view" }, "account":{ "id":"123123", "accountRoutings":[{ "scheme":"AccountNumber", "address":"2345 6789 1234" },{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"bankId", "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName", "dateOfBirth":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"userId", "emailAddress":"emailAddress", "name":"name" }] } }] }, "counterparty":{ "thisBankId":"String", "thisAccountId":"String", "viewId":"String" } }
{ "authInfo":{ "userId":"userId", "username":"username", "cbsToken":"cbsToken", "isFirst":true, "correlationId":"correlationId", "linkedCustomers":[{ "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName" }], "authViews":[{ "view":{ "id":"owner", "short_name":"Owner", "description":"This is the owner view" }, "account":{ "id":"123123", "accountRoutings":[{ "scheme":"AccountNumber", "address":"2345 6789 1234" },{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"bankId", "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName", "dateOfBirth":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"userId", "emailAddress":"emailAddress", "name":"name" }] } }] }, "status":{ "errorCode":"INTERNAL-OBP-ADAPTER-6001: ...", "backendMessages":[{ "source":"ESB", "status":"Success", "errorCode":"0", "text":"OK" }] }, "data":[{ "createdByUserId":"", "name":"", "thisBankId":"", "thisAccountId":"", "thisViewId":"", "counterpartyId":"", "otherAccountRoutingScheme":"", "otherAccountRoutingAddress":"", "otherBankRoutingScheme":"", "otherBankRoutingAddress":"", "otherBranchRoutingScheme":"", "otherBranchRoutingAddress":"", "isBeneficiary":true, "description":"", "otherAccountSecondaryRoutingScheme":"", "otherAccountSecondaryRoutingAddress":"", "bespoke":[{ "key":"key", "value":"value" }] }] }

obp.get.CounterpartyByCounterpartyId

Get a Counterparty by its counterpartyId.
Kafka
Outbound
Inbound
Topic
from.obp.api.{api_instance_id}.to.adapter.mf.caseclass.OutboundGetCounterpartyByCounterpartyId
to.obp.api.{api_instance_id}.caseclass.OutboundGetCounterpartyByCounterpartyId
Message
{ "authInfo":{ "userId":"userId", "username":"username", "cbsToken":"cbsToken", "isFirst":true, "correlationId":"correlationId", "linkedCustomers":[{ "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName" }], "authViews":[{ "view":{ "id":"owner", "short_name":"Owner", "description":"This is the owner view" }, "account":{ "id":"123123", "accountRoutings":[{ "scheme":"AccountNumber", "address":"2345 6789 1234" },{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"bankId", "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName", "dateOfBirth":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"userId", "emailAddress":"emailAddress", "name":"name" }] } }] }, "counterparty":{ "counterpartyId":"String" } }
{ "authInfo":{ "userId":"userId", "username":"username", "cbsToken":"cbsToken", "isFirst":true, "correlationId":"correlationId", "linkedCustomers":[{ "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName" }], "authViews":[{ "view":{ "id":"owner", "short_name":"Owner", "description":"This is the owner view" }, "account":{ "id":"123123", "accountRoutings":[{ "scheme":"AccountNumber", "address":"2345 6789 1234" },{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"bankId", "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName", "dateOfBirth":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"userId", "emailAddress":"emailAddress", "name":"name" }] } }] }, "status":{ "errorCode":"INTERNAL-OBP-ADAPTER-6001: ...", "backendMessages":[{ "source":"ESB", "status":"Success", "errorCode":"0", "text":"OK" }] }, "data":{ "createdByUserId":"String", "name":"String", "thisBankId":"String", "thisAccountId":"String", "thisViewId":"String", "counterpartyId":"String", "otherAccountRoutingScheme":"String", "otherAccountRoutingAddress":"String", "otherBankRoutingScheme":"String", "otherBankRoutingAddress":"String", "otherBranchRoutingScheme":"String", "otherBranchRoutingAddress":"String", "isBeneficiary":true, "description":"String", "otherAccountSecondaryRoutingScheme":"String", "otherAccountSecondaryRoutingAddress":"String", "bespoke":[] } }

obp.get.CustomersByUserIdBox

Get Customers represented by the User.
Kafka
Outbound
Inbound
Topic
from.obp.api.{api_instance_id}.to.adapter.mf.caseclass.OutboundGetCustomersByUserId
to.obp.api.{api_instance_id}.caseclass.OutboundGetCustomersByUserId
Message
{ "authInfo":{ "userId":"userId", "username":"username", "cbsToken":"cbsToken", "isFirst":true, "correlationId":"correlationId", "linkedCustomers":[{ "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName" }], "authViews":[{ "view":{ "id":"owner", "short_name":"Owner", "description":"This is the owner view" }, "account":{ "id":"123123", "accountRoutings":[{ "scheme":"AccountNumber", "address":"2345 6789 1234" },{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"bankId", "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName", "dateOfBirth":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"userId", "emailAddress":"emailAddress", "name":"name" }] } }] } }
{ "authInfo":{ "userId":"userId", "username":"username", "cbsToken":"cbsToken", "isFirst":true, "correlationId":"correlationId", "linkedCustomers":[{ "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName" }], "authViews":[{ "view":{ "id":"owner", "short_name":"Owner", "description":"This is the owner view" }, "account":{ "id":"123123", "accountRoutings":[{ "scheme":"AccountNumber", "address":"2345 6789 1234" },{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"bankId", "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName", "dateOfBirth":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"userId", "emailAddress":"emailAddress", "name":"name" }] } }] }, "status":{ "errorCode":"INTERNAL-OBP-ADAPTER-6001: ...", "backendMessages":[{ "source":"ESB", "status":"Success", "errorCode":"0", "text":"OK" }] }, "data":[{ "customerId":"String", "bankId":"String", "number":"String", "legalName":"String", "mobileNumber":"String", "email":"String", "faceImage":{ "date":"2017-09-19T00:00:00Z", "url":"String" }, "dateOfBirth":"2017-09-19T00:00:00Z", "relationshipStatus":"String", "dependents":1, "dobOfDependents":["2017-09-19T00:00:00Z"], "highestEducationAttained":"String", "employmentStatus":"String", "creditRating":{ "rating":"String", "source":"String" }, "creditLimit":{ "currency":"String", "amount":"String" }, "kycStatus":false, "lastOkDate":"2017-09-19T00:00:00Z" }] }

obp.get.getStatusOfCheckbookOrdersFuture

Get the status of CheckbookOrders for an Account.
Kafka
Outbound
Inbound
Topic
from.obp.api.{api_instance_id}.to.adapter.mf.caseclass.OutboundGetCheckbookOrderStatus
to.obp.api.{api_instance_id}.caseclass.OutboundGetCheckbookOrderStatus
Message
{ "authInfo":{ "userId":"userId", "username":"username", "cbsToken":"cbsToken", "isFirst":true, "correlationId":"correlationId", "linkedCustomers":[{ "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName" }], "authViews":[{ "view":{ "id":"owner", "short_name":"Owner", "description":"This is the owner view" }, "account":{ "id":"123123", "accountRoutings":[{ "scheme":"AccountNumber", "address":"2345 6789 1234" },{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"bankId", "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName", "dateOfBirth":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"userId", "emailAddress":"emailAddress", "name":"name" }] } }] }, "bankId":"bankId", "accountId":"accountId", "originatorApplication":"String", "originatorStationIP":"String", "primaryAccount":"" }
{ "authInfo":{ "userId":"userId", "username":"username", "cbsToken":"cbsToken", "isFirst":true, "correlationId":"correlationId", "linkedCustomers":[{ "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName" }], "authViews":[{ "view":{ "id":"owner", "short_name":"Owner", "description":"This is the owner view" }, "account":{ "id":"123123", "accountRoutings":[{ "scheme":"AccountNumber", "address":"2345 6789 1234" },{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"bankId", "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName", "dateOfBirth":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"userId", "emailAddress":"emailAddress", "name":"name" }] } }] }, "status":{ "errorCode":"INTERNAL-OBP-ADAPTER-6001: ...", "backendMessages":[{ "source":"ESB", "status":"Success", "errorCode":"0", "text":"OK" }] }, "data":{ "account":{ "bank_id":"10", "account_id":"xjfsafjj", "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" } }] } }

obp.get.getStatusOfCreditCardOrderFuture

Get the status of CreditCardOrders
Kafka
Outbound
Inbound
Topic
from.obp.api.{api_instance_id}.to.adapter.mf.caseclass.OutboundGetCreditCardOrderStatus
to.obp.api.{api_instance_id}.caseclass.OutboundGetCreditCardOrderStatus
Message
{ "authInfo":{ "userId":"userId", "username":"username", "cbsToken":"cbsToken", "isFirst":true, "correlationId":"correlationId", "linkedCustomers":[{ "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName" }], "authViews":[{ "view":{ "id":"owner", "short_name":"Owner", "description":"This is the owner view" }, "account":{ "id":"123123", "accountRoutings":[{ "scheme":"AccountNumber", "address":"2345 6789 1234" },{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"bankId", "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName", "dateOfBirth":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"userId", "emailAddress":"emailAddress", "name":"name" }] } }] }, "bankId":"bankId", "accountId":"accountId", "originatorApplication":"String", "originatorStationIP":"String", "primaryAccount":"" }
{ "authInfo":{ "userId":"userId", "username":"username", "cbsToken":"cbsToken", "isFirst":true, "correlationId":"correlationId", "linkedCustomers":[{ "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName" }], "authViews":[{ "view":{ "id":"owner", "short_name":"Owner", "description":"This is the owner view" }, "account":{ "id":"123123", "accountRoutings":[{ "scheme":"AccountNumber", "address":"2345 6789 1234" },{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"bankId", "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName", "dateOfBirth":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"userId", "emailAddress":"emailAddress", "name":"name" }] } }] }, "status":{ "errorCode":"INTERNAL-OBP-ADAPTER-6001: ...", "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" }] }

obp.get.Branches

Get Branches fora Bank specified by bankId
Kafka
Outbound
Inbound
Topic
from.obp.api.{api_instance_id}.to.adapter.mf.caseclass.OutboundGetBranches
to.obp.api.{api_instance_id}.caseclass.OutboundGetBranches
Message
{ "authInfo":{ "userId":"userId", "username":"username", "cbsToken":"cbsToken", "isFirst":true, "correlationId":"correlationId", "linkedCustomers":[{ "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName" }], "authViews":[{ "view":{ "id":"owner", "short_name":"Owner", "description":"This is the owner view" }, "account":{ "id":"123123", "accountRoutings":[{ "scheme":"AccountNumber", "address":"2345 6789 1234" },{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"bankId", "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName", "dateOfBirth":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"userId", "emailAddress":"emailAddress", "name":"name" }] } }] }, "bankId":"bankid" }
{ "authInfo":{ "userId":"userId", "username":"username", "cbsToken":"cbsToken", "isFirst":true, "correlationId":"correlationId", "linkedCustomers":[{ "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName" }], "authViews":[{ "view":{ "id":"owner", "short_name":"Owner", "description":"This is the owner view" }, "account":{ "id":"123123", "accountRoutings":[{ "scheme":"AccountNumber", "address":"2345 6789 1234" },{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"bankId", "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName", "dateOfBirth":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"userId", "emailAddress":"emailAddress", "name":"name" }] } }] }, "status":{ "errorCode":"", "backendMessages":[{ "source":"ESB", "status":"Success", "errorCode":"0", "text":"OK" }] }, "data":[{ "branchId":{ "value":"" }, "bankId":{ "value":"" }, "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":"" }] }

obp.get.Branch

Get a Branch as specified by bankId and branchId
Kafka
Outbound
Inbound
Topic
from.obp.api.{api_instance_id}.to.adapter.mf.caseclass.OutboundGetBranch
to.obp.api.{api_instance_id}.caseclass.OutboundGetBranch
Message
{ "authInfo":{ "userId":"userId", "username":"username", "cbsToken":"cbsToken", "isFirst":true, "correlationId":"correlationId", "linkedCustomers":[{ "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName" }], "authViews":[{ "view":{ "id":"owner", "short_name":"Owner", "description":"This is the owner view" }, "account":{ "id":"123123", "accountRoutings":[{ "scheme":"AccountNumber", "address":"2345 6789 1234" },{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"bankId", "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName", "dateOfBirth":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"userId", "emailAddress":"emailAddress", "name":"name" }] } }] }, "bankId":"bankid", "branchId":"branchid" }
{ "authInfo":{ "userId":"userId", "username":"username", "cbsToken":"cbsToken", "isFirst":true, "correlationId":"correlationId", "linkedCustomers":[{ "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName" }], "authViews":[{ "view":{ "id":"owner", "short_name":"Owner", "description":"This is the owner view" }, "account":{ "id":"123123", "accountRoutings":[{ "scheme":"AccountNumber", "address":"2345 6789 1234" },{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"bankId", "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName", "dateOfBirth":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"userId", "emailAddress":"emailAddress", "name":"name" }] } }] }, "status":{ "errorCode":"", "backendMessages":[{ "source":"ESB", "status":"Success", "errorCode":"0", "text":"OK" }] }, "data":{ "branchId":{ "value":"" }, "bankId":{ "value":"" }, "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":"" } }

obp.get.Atms

Get ATMs for a bank specified by bankId
Kafka
Outbound
Inbound
Topic
from.obp.api.{api_instance_id}.to.adapter.mf.caseclass.OutboundGetAtms
to.obp.api.{api_instance_id}.caseclass.OutboundGetAtms
Message
{ "authInfo":{ "userId":"userId", "username":"username", "cbsToken":"cbsToken", "isFirst":true, "correlationId":"correlationId", "linkedCustomers":[{ "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName" }], "authViews":[{ "view":{ "id":"owner", "short_name":"Owner", "description":"This is the owner view" }, "account":{ "id":"123123", "accountRoutings":[{ "scheme":"AccountNumber", "address":"2345 6789 1234" },{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"bankId", "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName", "dateOfBirth":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"userId", "emailAddress":"emailAddress", "name":"name" }] } }] }, "bankId":"bankid" }
{ "authInfo":{ "userId":"userId", "username":"username", "cbsToken":"cbsToken", "isFirst":true, "correlationId":"correlationId", "linkedCustomers":[{ "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName" }], "authViews":[{ "view":{ "id":"owner", "short_name":"Owner", "description":"This is the owner view" }, "account":{ "id":"123123", "accountRoutings":[{ "scheme":"AccountNumber", "address":"2345 6789 1234" },{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"bankId", "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName", "dateOfBirth":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"userId", "emailAddress":"emailAddress", "name":"name" }] } }] }, "status":{ "errorCode":"INTERNAL-OBP-ADAPTER-6001: ...", "backendMessages":[{ "source":"ESB", "status":"Success", "errorCode":"0", "text":"OK" }] }, "data":[{ "atmId":{ "value":"333" }, "bankId":{ "value":"10" }, "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 }] }

obp.get.Atm

Get an ATM as specified by bankId and atmId.
Kafka
Outbound
Inbound
Topic
from.obp.api.{api_instance_id}.to.adapter.mf.caseclass.OutboundGetAtm
to.obp.api.{api_instance_id}.caseclass.OutboundGetAtm
Message
{ "authInfo":{ "userId":"userId", "username":"username", "cbsToken":"cbsToken", "isFirst":true, "correlationId":"correlationId", "linkedCustomers":[{ "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName" }], "authViews":[{ "view":{ "id":"owner", "short_name":"Owner", "description":"This is the owner view" }, "account":{ "id":"123123", "accountRoutings":[{ "scheme":"AccountNumber", "address":"2345 6789 1234" },{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"bankId", "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName", "dateOfBirth":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"userId", "emailAddress":"emailAddress", "name":"name" }] } }] }, "bankId":"bankId", "atmId":"atmId" }
{ "authInfo":{ "userId":"userId", "username":"username", "cbsToken":"cbsToken", "isFirst":true, "correlationId":"correlationId", "linkedCustomers":[{ "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName" }], "authViews":[{ "view":{ "id":"owner", "short_name":"Owner", "description":"This is the owner view" }, "account":{ "id":"123123", "accountRoutings":[{ "scheme":"AccountNumber", "address":"2345 6789 1234" },{ "scheme":"IBAN", "address":"DE91 1000 0000 0123 4567 89" }], "customerOwners":[{ "bankId":"bankId", "customerId":"customerId", "customerNumber":"customerNumber", "legalName":"legalName", "dateOfBirth":"2017-09-19T00:00:00Z" }], "userOwners":[{ "userId":"userId", "emailAddress":"emailAddress", "name":"name" }] } }] }, "status":{ "errorCode":"INTERNAL-OBP-ADAPTER-6001: ...", "backendMessages":[{ "source":"ESB", "status":"Success", "errorCode":"0", "text":"OK" }] }, "data":{ "atmId":{ "value":"333" }, "bankId":{ "value":"10" }, "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 } }