API Explorer

⯆

Message Doc Index

Message Docs for Connector: kafka_vSept2018

obp.getAdapterInfo

                            
                                Gets information about the active general (non bank specific) Adapter that is responding to messages sent by OBP.
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.1.to.adapter.mf.caseclass.OutboundGetAdapterInfo
                                to.obp.api.1.caseclass.OutboundGetAdapterInfo

                                Message
                                {
  "date":"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
                                OBPv3.0.0: getAdapterInfoForBank
OBPv3.1.0: getAdapterInfo
OBPv5.0.0: getAdapterInfo

obp.getBanks

                            
                                Gets the banks list on this OBP installation.
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.1.to.adapter.mf.caseclass.OutboundGetBanks
                                to.obp.api.1.caseclass.OutboundGetBanks

                                Message
                                {
  "authInfo":{
    "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "username":"felixsmith",
    "cbsToken":"FYIUYF6SUYFSD",
    "isFirst":true,
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "linkedCustomers":[{
      "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
      "customerNumber":"5987953",
      "legalName":"Eveline Tripman"
    }],
    "userAuthContexts":[{
      "key":"CUSTOMER_NUMBER",
      "value":"5987953"
    },{
      "key":"TOKEN",
      "value":"qieuriopwoir987ASYDUFISUYDF678u"
    }],
    "authViews":[{
      "view":{
        "id":"owner",
        "name":"Owner",
        "description":"This is the owner view"
      },
      "account":{
        "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
        "accountRoutings":[{
          "scheme":"AccountNumber",
          "address":"546387432"
        },{
          "scheme":"IBAN",
          "address":"DE91 1000 0000 0123 4567 89"
        }],
        "customerOwners":[{
          "bankId":"gh.29.uk",
          "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
          "customerNumber":"5987953",
          "legalName":"Eveline Tripman",
          "dateOfBirth":"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
                                CNBV9v1.0.0: getMxAtms
MXOFv1.0.0: getMxAtms
OBPv3.0.0: getBanks
OBPv4.0.0: getBanks
OBPv5.0.0: createBank

obp.getBank

                            
                                Get a specific Bank as specified by bankId
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.1.to.adapter.mf.caseclass.OutboundGetBank
                                to.obp.api.1.caseclass.OutboundGetBank

                                Message
                                {
  "authInfo":{
    "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "username":"felixsmith",
    "cbsToken":"FYIUYF6SUYFSD",
    "isFirst":true,
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "linkedCustomers":[{
      "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
      "customerNumber":"5987953",
      "legalName":"Eveline Tripman"
    }],
    "userAuthContexts":[{
      "key":"CUSTOMER_NUMBER",
      "value":"5987953"
    },{
      "key":"TOKEN",
      "value":"qieuriopwoir987ASYDUFISUYDF678u"
    }],
    "authViews":[{
      "view":{
        "id":"owner",
        "name":"Owner",
        "description":"This is the owner view"
      },
      "account":{
        "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
        "accountRoutings":[{
          "scheme":"AccountNumber",
          "address":"546387432"
        },{
          "scheme":"IBAN",
          "address":"DE91 1000 0000 0123 4567 89"
        }],
        "customerOwners":[{
          "bankId":"gh.29.uk",
          "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
          "customerNumber":"5987953",
          "legalName":"Eveline Tripman",
          "dateOfBirth":"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
                                UKv2.0: getAccountTransactions
UKv3.1: getAccountsAccountIdTransactions
UKv3.1: getTransactions
STETv1.4: accountsBalancesGet
STETv1.4: accountsGet
STETv1.4: accountsTransactionsGet
BGv1: getAccountList
BGv1: getAccountBalances
BGv1: getTransactionList
BGv1.3: getCardAccountTransactionList
BGv1.3: getTransactionList
: getCardAccountTransactionList
: getTransactionList
OBPv1.2.1: deleteViewForBankAccount
OBPv1.2.1: addPermissionForUserForBankAccountForMultipleViews
OBPv1.2.1: addPermissionForUserForBankAccountForOneView
OBPv1.2.1: removePermissionForUserForBankAccountForOneView
OBPv1.2.1: removePermissionForUserForBankAccountForAllViews
OBPv1.2.1: addCounterpartyPublicAlias
OBPv1.2.1: updateCounterpartyPublicAlias
OBPv1.2.1: deleteCounterpartyPublicAlias
OBPv1.2.1: addOtherAccountPrivateAlias
OBPv1.2.1: updateCounterpartyPrivateAlias
OBPv1.2.1: deleteCounterpartyPrivateAlias
OBPv1.2.1: addCounterpartyMoreInfo
OBPv1.2.1: updateCounterpartyMoreInfo
OBPv1.2.1: deleteCounterpartyMoreInfo
OBPv1.2.1: addCounterpartyUrl
OBPv1.2.1: updateCounterpartyUrl
OBPv1.2.1: deleteCounterpartyUrl
OBPv1.2.1: addCounterpartyImageUrl
OBPv1.2.1: updateCounterpartyImageUrl
OBPv1.2.1: deleteCounterpartyImageUrl
OBPv1.2.1: addCounterpartyOpenCorporatesUrl
OBPv1.2.1: updateCounterpartyOpenCorporatesUrl
OBPv1.2.1: deleteCounterpartyOpenCorporatesUrl
OBPv1.2.1: deleteCounterpartyCorporateLocation
OBPv1.2.1: deleteCounterpartyPhysicalLocation
OBPv1.4.0: addCustomerMessage
OBPv1.4.0: getTransactionRequestTypes
OBPv2.0.0: getPrivateAccountsAtOneBank
OBPv2.0.0: corePrivateAccountsAtOneBank
OBPv2.0.0: privateAccountsAtOneBank
OBPv2.0.0: publicAccountsAtOneBank
OBPv2.0.0: addKycDocument
OBPv2.0.0: addKycMedia
OBPv2.0.0: addKycCheck
OBPv2.0.0: addKycStatus
OBPv2.0.0: getPermissionsForBankAccount
OBPv2.0.0: getTransactionTypes
OBPv2.1.0: getTransactionRequestTypesSupportedByBank
OBPv2.1.0: createTransactionRequestSandboxTan
OBPv2.1.0: createTransactionRequestCounterparty
OBPv2.1.0: createTransactionRequestSepa
OBPv2.1.0: createTransactionRequestFreeForm
OBPv2.1.0: answerTransactionRequestChallenge
OBPv2.1.0: getEntitlementsByBankAndUser
OBPv2.1.0: createTransactionType
OBPv2.1.0: getCustomersForCurrentUserAtBank
OBPv2.2.0: getCurrentFxRate
OBPv2.2.0: createAccount
OBPv2.2.0: createCounterparty
OBPv3.0.0: getPermissionForUserForBankAccount
OBPv3.0.0: getFirehoseAccountsAtOneBank
OBPv3.0.0: getFirehoseTransactionsForBankAccount
OBPv3.0.0: getCoreTransactionsForBankAccount
OBPv3.0.0: getTransactionsForBankAccount
OBPv3.0.0: getAdapterInfoForBank
OBPv3.0.0: getBranch
OBPv3.0.0: getBranches
OBPv3.0.0: getAtm
OBPv3.0.0: getAtms
OBPv3.0.0: privateAccountsAtOneBank
OBPv3.0.0: getPrivateAccountIdsbyBankId
OBPv3.0.0: addEntitlementRequest
OBPv3.0.0: getAccountsHeld
OBPv3.0.0: bankById
OBPv3.1.0: getCheckbookOrders
OBPv3.1.0: getStatusOfCreditCardOrder
OBPv3.1.0: getFirehoseCustomers
OBPv3.1.0: checkFundsAvailable
OBPv3.1.0: createAccountWebhook
OBPv3.1.0: enableDisableAccountWebhook
OBPv3.1.0: getAccountWebhooks
OBPv3.1.0: getTransactionByIdForBankAccount
OBPv3.1.0: getTransactionRequests
OBPv3.1.0: createCustomer
OBPv3.1.0: getCustomerByCustomerId
OBPv3.1.0: getCustomerByCustomerNumber
OBPv3.1.0: createTaxResidence
OBPv3.1.0: getTaxResidence
OBPv3.1.0: deleteTaxResidence
OBPv3.1.0: createCustomerAddress
OBPv3.1.0: updateCustomerAddress
OBPv3.1.0: getCustomerAddresses
OBPv3.1.0: deleteCustomerAddress
OBPv3.1.0: createProductAttribute
OBPv3.1.0: getProductAttribute
OBPv3.1.0: updateProductAttribute
OBPv3.1.0: deleteProductAttribute
OBPv3.1.0: createAccountApplication
OBPv3.1.0: getAccountApplications
OBPv3.1.0: getAccountApplication
OBPv3.1.0: updateAccountApplicationStatus
OBPv3.1.0: createProduct
OBPv3.1.0: getProduct
OBPv3.1.0: getProductTree
OBPv3.1.0: getProducts
OBPv3.1.0: createAccountAttribute
OBPv3.1.0: updateAccountAttribute
OBPv3.1.0: createProductCollection
OBPv3.1.0: getProductCollection
OBPv3.1.0: deleteBranch
OBPv3.1.0: createMeeting
OBPv3.1.0: getMeetings
OBPv3.1.0: getMeeting
OBPv3.1.0: createConsentEmail
OBPv3.1.0: createConsentSms
OBPv3.1.0: answerConsentChallenge
OBPv3.1.0: getConsents
OBPv3.1.0: revokeConsent
OBPv3.1.0: createUserAuthContextUpdateRequest
OBPv3.1.0: updateCustomerEmail
OBPv3.1.0: updateCustomerNumber
OBPv3.1.0: updateCustomerMobileNumber
OBPv3.1.0: updateCustomerIdentity
OBPv3.1.0: updateCustomerCreditLimit
OBPv3.1.0: updateCustomerCreditRatingAndSource
OBPv3.1.0: updateAccount
OBPv3.1.0: getCardsForBank
OBPv3.1.0: getCardForBank
OBPv3.1.0: deleteCardForBank
OBPv3.1.0: createCardAttribute
OBPv3.1.0: updateCardAttribute
OBPv3.1.0: updateCustomerBranch
OBPv3.1.0: updateCustomerData
OBPv3.1.0: createAccount
OBPv3.1.0: saveHistoricalTransaction
OBPv3.1.0: getBankAccountsBalances
OBPv4.0.0: getBank
OBPv4.0.0: createSettlementAccount
OBPv4.0.0: addAccount
OBPv4.0.0: createProductAttribute
OBPv4.0.0: updateProductAttribute
OBPv4.0.0: getProductAttribute
OBPv4.0.0: createBankAttribute
OBPv4.0.0: updateBankAttribute
OBPv4.0.0: deleteBankAttribute
OBPv4.0.0: createCounterparty
OBPv4.0.0: createCounterpartyForAnyAccount
OBPv4.0.0: getProducts
OBPv5.0.0: getBank
OBPv5.0.0: updateBank
OBPv5.0.0: createAccount
OBPv5.0.0: getMyCustomersAtBank
OBPv5.1.0: getCurrenciesAtBank
OBPv5.1.0: revokeConsentAtBank
OBPv5.1.0: getAtm
OBPv5.0.0: createUserAuthContextUpdateRequest
OBPv5.0.0: answerUserAuthContextUpdateChallenge
OBPv5.0.0: headAtms
OBPv5.0.0: createCustomer
OBPv5.0.0: createProduct
OBPv5.0.0: addCardForBank
OBPv5.0.0: createCustomerAccountLink
OBPv5.0.0: getCustomerAccountLinksByCustomerId
OBPv5.0.0: getCustomerAccountLinksByBankIdAccountId
OBPv5.0.0: getCustomerAccountLinkById
OBPv5.0.0: updateCustomerAccountLinkById
OBPv5.0.0: deleteCustomerAccountLinkById
OBPv4.0.0: getDoubleEntryTransaction
OBPv4.0.0: getSettlementAccounts
OBPv4.0.0: createTransactionRequestAccount
OBPv4.0.0: createTransactionRequestAccountOtp
OBPv4.0.0: createTransactionRequestCounterparty
OBPv4.0.0: createTransactionRequestSimple
OBPv4.0.0: createTransactionRequestSepa
OBPv4.0.0: createTransactionRequestRefund
OBPv4.0.0: createTransactionRequestFreeForm
OBPv4.0.0: answerTransactionRequestChallenge
OBPv4.0.0: createTransactionRequestAttribute
OBPv4.0.0: getTransactionRequestAttributeById
OBPv4.0.0: getTransactionRequestAttributes
OBPv4.0.0: updateTransactionRequestAttribute
OBPv4.0.0: createOrUpdateTransactionRequestAttributeDefinition
OBPv4.0.0: getTransactionRequestAttributeDefinition
OBPv4.0.0: deleteTransactionRequestAttributeDefinition
OBPv4.0.0: getBankLevelDynamicEntities
OBPv4.0.0: deleteBankLevelDynamicEntity
OBPv4.0.0: updateAccountLabel
OBPv4.0.0: addTagForViewOnAccount
OBPv4.0.0: deleteTagForViewOnAccount
OBPv4.0.0: getTagsForViewOnAccount
OBPv4.0.0: getPrivateAccountByIdFull
OBPv4.0.0: getBankAccountsBalances
OBPv4.0.0: getBankAccountBalances
OBPv4.0.0: getFirehoseAccountsAtOneBank
OBPv4.0.0: getFastFirehoseAccountsAtOneBank
OBPv4.0.0: createUserInvitation
OBPv4.0.0: getUserInvitationAnonymous
OBPv4.0.0: getUserInvitation
OBPv4.0.0: getUserInvitations
OBPv4.0.0: createDirectDebit
OBPv4.0.0: createDirectDebitManagement
OBPv4.0.0: createStandingOrder
OBPv4.0.0: createStandingOrderManagement
OBPv4.0.0: createCustomerAttribute
OBPv4.0.0: updateCustomerAttribute
OBPv4.0.0: getCustomerAttributes
OBPv4.0.0: getCustomerAttributeById
OBPv4.0.0: createTransactionAttribute
OBPv4.0.0: updateTransactionAttribute
OBPv4.0.0: getTransactionAttributes
OBPv4.0.0: getTransactionAttributeById
OBPv4.0.0: createHistoricalTransactionAtBank
OBPv4.0.0: getTransactionRequest
OBPv4.0.0: getPrivateAccountsAtOneBank
OBPv4.0.0: deleteCustomerAttribute
OBPv4.0.0: createBankLevelDynamicEndpoint
OBPv4.0.0: updateBankLevelDynamicEndpointHost
OBPv4.0.0: getBankLevelDynamicEndpoint
OBPv4.0.0: getBankLevelDynamicEndpoints
OBPv4.0.0: deleteBankLevelDynamicEndpoint
OBPv4.0.0: createOrUpdateCustomerAttributeAttributeDefinition
OBPv4.0.0: createOrUpdateAccountAttributeDefinition
OBPv4.0.0: createOrUpdateProductAttributeDefinition
OBPv4.0.0: createProductFee
OBPv4.0.0: updateProductFee
OBPv4.0.0: getProductFee
OBPv4.0.0: getProductFees
OBPv4.0.0: deleteProductFee
OBPv4.0.0: createOrUpdateBankAttributeDefinition
OBPv4.0.0: getBankAttributes
OBPv4.0.0: getBankAttribute
OBPv4.0.0: createOrUpdateTransactionAttributeDefinition
OBPv4.0.0: createOrUpdateCardAttributeDefinition
OBPv4.0.0: deleteTransactionAttributeDefinition
OBPv4.0.0: deleteCustomerAttributeDefinition
OBPv4.0.0: deleteAccountAttributeDefinition
OBPv4.0.0: deleteProductAttributeDefinition
OBPv4.0.0: deleteCardAttributeDefinition
OBPv4.0.0: getProductAttributeDefinition
OBPv4.0.0: getCustomerAttributeDefinition
OBPv4.0.0: getAccountAttributeDefinition
OBPv4.0.0: getTransactionAttributeDefinition
OBPv4.0.0: getCardAttributeDefinition
OBPv4.0.0: deleteUserCustomerLink
OBPv4.0.0: getUserCustomerLinksByUserId
OBPv4.0.0: createUserCustomerLinks
OBPv4.0.0: getUserCustomerLinksByCustomerId
OBPv4.0.0: getCorrelatedUsersInfoByCustomerId
OBPv4.0.0: deleteTransactionCascade
OBPv4.0.0: deleteAccountCascade
OBPv4.0.0: deleteBankCascade
OBPv4.0.0: deleteProductCascade
OBPv4.0.0: deleteCustomerCascade
OBPv4.0.0: deleteExplicitCounterparty
OBPv4.0.0: deleteCounterpartyForAnyAccount
OBPv4.0.0: getExplictCounterpartiesForAccount
OBPv4.0.0: getCounterpartiesForAnyAccount
OBPv4.0.0: getExplictCounterpartyById
OBPv4.0.0: getCounterpartyByNameForAnyAccount
OBPv4.0.0: getCounterpartyByIdForAnyAccount
OBPv4.0.0: addConsentUser
OBPv4.0.0: updateConsentStatus
OBPv4.0.0: getConsents
OBPv4.0.0: getConsentInfos
OBPv4.0.0: createBankLevelDynamicResourceDoc
OBPv4.0.0: updateBankLevelDynamicResourceDoc
OBPv4.0.0: deleteBankLevelDynamicResourceDoc
OBPv4.0.0: getBankLevelDynamicResourceDoc
OBPv4.0.0: getAllBankLevelDynamicResourceDocs
OBPv4.0.0: createBankLevelDynamicMessageDoc
OBPv4.0.0: updateBankLevelDynamicMessageDoc
OBPv4.0.0: getBankLevelDynamicMessageDoc
OBPv4.0.0: getAllBankLevelDynamicMessageDocs
OBPv4.0.0: deleteBankLevelDynamicMessageDoc
OBPv4.0.0: createBankLevelEndpointMapping
OBPv4.0.0: updateBankLevelEndpointMapping
OBPv4.0.0: getBankLevelEndpointMapping
OBPv4.0.0: getAllBankLevelEndpointMappings
OBPv4.0.0: deleteBankLevelEndpointMapping
OBPv4.0.0: getAtms
OBPv4.0.0: createBankLevelEndpointTag
OBPv4.0.0: updateBankLevelEndpointTag
OBPv4.0.0: getBankLevelEndpointTags
OBPv4.0.0: deleteBankLevelEndpointTag
OBPv4.0.0: getProduct
OBPv4.0.0: createCustomerMessage
OBPv4.0.0: getCustomerMessages
OBPv4.0.0: createBankAccountNotificationWebhook
OBPv4.0.0: createBankLevelDynamicEntity
OBPv4.0.0: updateBankLevelDynamicEntity
OBPv5.1.0: createAtmAttribute
OBPv5.1.0: getAtmAttributes
OBPv5.1.0: getAtmAttribute
OBPv5.1.0: updateAtmAttribute
OBPv5.1.0: deleteAtmAttribute
OBPv5.1.0: getAtms
OBPv4.0.0: getCustomersByAttributes
OBPv4.0.0: createCustomer
OBPv4.0.0: createProduct
OBPv1.4.0: getBankLevelDynamicResourceDocsObp

obp.createMessage

                            
                                Create Message
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.1.to.adapter.mf.caseclass.OutBoundCreateMessage
                                to.obp.api.1.caseclass.OutBoundCreateMessage

                                Message
                                {
  "outboundAdapterCallContext":{
    "correlationId":"string",
    "sessionId":"string",
    "consumerId":"string",
    "generalContext":[{
      "key":"string",
      "value":"string"
    }],
    "outboundAdapterAuthInfo":{
      "userId":"string",
      "username":"string",
      "linkedCustomers":[{
        "customerId":"string",
        "customerNumber":"string",
        "legalName":"string"
      }],
      "userAuthContext":[{
        "key":"string",
        "value":"string"
      }],
      "authViews":[{
        "view":{
          "id":"string",
          "name":"string",
          "description":"string"
        },
        "account":{
          "id":"string",
          "accountRoutings":[{
            "scheme":"string",
            "address":"string"
          }],
          "customerOwners":[{
            "bankId":"string",
            "customerId":"string",
            "customerNumber":"string",
            "legalName":"string",
            "dateOfBirth":"2024-11-21T03:33:33Z"
          }],
          "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-11-21T03:33:33Z",
    "message":"string",
    "fromDepartment":"string",
    "fromPerson":"string"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv1.4.0: addCustomerMessage

obp.createOrUpdateKycCheck

                            
                                Create Or Update Kyc Check
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.1.to.adapter.mf.caseclass.OutBoundCreateOrUpdateKycCheck
                                to.obp.api.1.caseclass.OutBoundCreateOrUpdateKycCheck

                                Message
                                {
  "outboundAdapterCallContext":{
    "correlationId":"string",
    "sessionId":"string",
    "consumerId":"string",
    "generalContext":[{
      "key":"string",
      "value":"string"
    }],
    "outboundAdapterAuthInfo":{
      "userId":"string",
      "username":"string",
      "linkedCustomers":[{
        "customerId":"string",
        "customerNumber":"string",
        "legalName":"string"
      }],
      "userAuthContext":[{
        "key":"string",
        "value":"string"
      }],
      "authViews":[{
        "view":{
          "id":"string",
          "name":"string",
          "description":"string"
        },
        "account":{
          "id":"string",
          "accountRoutings":[{
            "scheme":"string",
            "address":"string"
          }],
          "customerOwners":[{
            "bankId":"string",
            "customerId":"string",
            "customerNumber":"string",
            "legalName":"string",
            "dateOfBirth":"2024-11-21T03:33:33Z"
          }],
          "userOwners":[{
            "userId":"string",
            "emailAddress":"string",
            "name":"string"
          }]
        }
      }]
    }
  },
  "bankId":"string",
  "customerId":"string",
  "id":"string",
  "customerNumber":"string",
  "date":"2024-11-21T03:33:33Z",
  "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-11-21T03:33:33Z",
    "how":"string",
    "staffUserId":"string",
    "staffName":"string",
    "satisfied":true,
    "comments":"string"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv2.0.0: addKycCheck

obp.createOrUpdateKycDocument

                            
                                Create Or Update KYC Document
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.1.to.adapter.mf.caseclass.OutBoundCreateOrUpdateKycDocument
                                to.obp.api.1.caseclass.OutBoundCreateOrUpdateKycDocument

                                Message
                                {
  "outboundAdapterCallContext":{
    "correlationId":"string",
    "sessionId":"string",
    "consumerId":"string",
    "generalContext":[{
      "key":"string",
      "value":"string"
    }],
    "outboundAdapterAuthInfo":{
      "userId":"string",
      "username":"string",
      "linkedCustomers":[{
        "customerId":"string",
        "customerNumber":"string",
        "legalName":"string"
      }],
      "userAuthContext":[{
        "key":"string",
        "value":"string"
      }],
      "authViews":[{
        "view":{
          "id":"string",
          "name":"string",
          "description":"string"
        },
        "account":{
          "id":"string",
          "accountRoutings":[{
            "scheme":"string",
            "address":"string"
          }],
          "customerOwners":[{
            "bankId":"string",
            "customerId":"string",
            "customerNumber":"string",
            "legalName":"string",
            "dateOfBirth":"2024-11-21T03:33:33Z"
          }],
          "userOwners":[{
            "userId":"string",
            "emailAddress":"string",
            "name":"string"
          }]
        }
      }]
    }
  },
  "bankId":"string",
  "customerId":"string",
  "id":"string",
  "customerNumber":"string",
  "type":"string",
  "number":"string",
  "issueDate":"2024-11-21T03:33:33Z",
  "issuePlace":"string",
  "expiryDate":"2024-11-21T03:33:33Z"
}
                                {
  "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-11-21T03:33:33Z",
    "issuePlace":"string",
    "expiryDate":"2024-11-21T03:33:33Z"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv2.0.0: addKycDocument

obp.createOrUpdateKycMedia

                            
                                Create Or Update KYC Media
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.1.to.adapter.mf.caseclass.OutBoundCreateOrUpdateKycMedia
                                to.obp.api.1.caseclass.OutBoundCreateOrUpdateKycMedia

                                Message
                                {
  "outboundAdapterCallContext":{
    "correlationId":"string",
    "sessionId":"string",
    "consumerId":"string",
    "generalContext":[{
      "key":"string",
      "value":"string"
    }],
    "outboundAdapterAuthInfo":{
      "userId":"string",
      "username":"string",
      "linkedCustomers":[{
        "customerId":"string",
        "customerNumber":"string",
        "legalName":"string"
      }],
      "userAuthContext":[{
        "key":"string",
        "value":"string"
      }],
      "authViews":[{
        "view":{
          "id":"string",
          "name":"string",
          "description":"string"
        },
        "account":{
          "id":"string",
          "accountRoutings":[{
            "scheme":"string",
            "address":"string"
          }],
          "customerOwners":[{
            "bankId":"string",
            "customerId":"string",
            "customerNumber":"string",
            "legalName":"string",
            "dateOfBirth":"2024-11-21T03:33:33Z"
          }],
          "userOwners":[{
            "userId":"string",
            "emailAddress":"string",
            "name":"string"
          }]
        }
      }]
    }
  },
  "bankId":"string",
  "customerId":"string",
  "id":"string",
  "customerNumber":"string",
  "type":"string",
  "url":"string",
  "date":"2024-11-21T03:33:33Z",
  "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-11-21T03:33:33Z",
    "relatesToKycDocumentId":"string",
    "relatesToKycCheckId":"string"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv2.0.0: addKycMedia

obp.createOrUpdateKycStatus

                            
                                Create Or Update KYC Status
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.1.to.adapter.mf.caseclass.OutBoundCreateOrUpdateKycStatus
                                to.obp.api.1.caseclass.OutBoundCreateOrUpdateKycStatus

                                Message
                                {
  "outboundAdapterCallContext":{
    "correlationId":"string",
    "sessionId":"string",
    "consumerId":"string",
    "generalContext":[{
      "key":"string",
      "value":"string"
    }],
    "outboundAdapterAuthInfo":{
      "userId":"string",
      "username":"string",
      "linkedCustomers":[{
        "customerId":"string",
        "customerNumber":"string",
        "legalName":"string"
      }],
      "userAuthContext":[{
        "key":"string",
        "value":"string"
      }],
      "authViews":[{
        "view":{
          "id":"string",
          "name":"string",
          "description":"string"
        },
        "account":{
          "id":"string",
          "accountRoutings":[{
            "scheme":"string",
            "address":"string"
          }],
          "customerOwners":[{
            "bankId":"string",
            "customerId":"string",
            "customerNumber":"string",
            "legalName":"string",
            "dateOfBirth":"2024-11-21T03:33:33Z"
          }],
          "userOwners":[{
            "userId":"string",
            "emailAddress":"string",
            "name":"string"
          }]
        }
      }]
    }
  },
  "bankId":"string",
  "customerId":"string",
  "customerNumber":"string",
  "ok":true,
  "date":"2024-11-21T03:33:33Z"
}
                                {
  "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-11-21T03:33:33Z"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv2.0.0: addKycStatus

obp.getKycDocuments

                            
                                Get KYC Documents
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.1.to.adapter.mf.caseclass.OutBoundGetKycDocuments
                                to.obp.api.1.caseclass.OutBoundGetKycDocuments

                                Message
                                {
  "outboundAdapterCallContext":{
    "correlationId":"string",
    "sessionId":"string",
    "consumerId":"string",
    "generalContext":[{
      "key":"string",
      "value":"string"
    }],
    "outboundAdapterAuthInfo":{
      "userId":"string",
      "username":"string",
      "linkedCustomers":[{
        "customerId":"string",
        "customerNumber":"string",
        "legalName":"string"
      }],
      "userAuthContext":[{
        "key":"string",
        "value":"string"
      }],
      "authViews":[{
        "view":{
          "id":"string",
          "name":"string",
          "description":"string"
        },
        "account":{
          "id":"string",
          "accountRoutings":[{
            "scheme":"string",
            "address":"string"
          }],
          "customerOwners":[{
            "bankId":"string",
            "customerId":"string",
            "customerNumber":"string",
            "legalName":"string",
            "dateOfBirth":"2024-11-21T03:33:33Z"
          }],
          "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-11-21T03:33:33Z",
    "issuePlace":"string",
    "expiryDate":"2024-11-21T03:33:33Z"
  }]
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv2.0.0: getKycDocuments

obp.getKycMedias

                            
                                Get KYC Medias
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.1.to.adapter.mf.caseclass.OutBoundGetKycMedias
                                to.obp.api.1.caseclass.OutBoundGetKycMedias

                                Message
                                {
  "outboundAdapterCallContext":{
    "correlationId":"string",
    "sessionId":"string",
    "consumerId":"string",
    "generalContext":[{
      "key":"string",
      "value":"string"
    }],
    "outboundAdapterAuthInfo":{
      "userId":"string",
      "username":"string",
      "linkedCustomers":[{
        "customerId":"string",
        "customerNumber":"string",
        "legalName":"string"
      }],
      "userAuthContext":[{
        "key":"string",
        "value":"string"
      }],
      "authViews":[{
        "view":{
          "id":"string",
          "name":"string",
          "description":"string"
        },
        "account":{
          "id":"string",
          "accountRoutings":[{
            "scheme":"string",
            "address":"string"
          }],
          "customerOwners":[{
            "bankId":"string",
            "customerId":"string",
            "customerNumber":"string",
            "legalName":"string",
            "dateOfBirth":"2024-11-21T03:33:33Z"
          }],
          "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-11-21T03:33:33Z",
    "relatesToKycDocumentId":"string",
    "relatesToKycCheckId":"string"
  }]
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv2.0.0: getKycMedia

obp.getKycStatuses

                            
                                Get KYC Statuses
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.1.to.adapter.mf.caseclass.OutBoundGetKycStatuses
                                to.obp.api.1.caseclass.OutBoundGetKycStatuses

                                Message
                                {
  "outboundAdapterCallContext":{
    "correlationId":"string",
    "sessionId":"string",
    "consumerId":"string",
    "generalContext":[{
      "key":"string",
      "value":"string"
    }],
    "outboundAdapterAuthInfo":{
      "userId":"string",
      "username":"string",
      "linkedCustomers":[{
        "customerId":"string",
        "customerNumber":"string",
        "legalName":"string"
      }],
      "userAuthContext":[{
        "key":"string",
        "value":"string"
      }],
      "authViews":[{
        "view":{
          "id":"string",
          "name":"string",
          "description":"string"
        },
        "account":{
          "id":"string",
          "accountRoutings":[{
            "scheme":"string",
            "address":"string"
          }],
          "customerOwners":[{
            "bankId":"string",
            "customerId":"string",
            "customerNumber":"string",
            "legalName":"string",
            "dateOfBirth":"2024-11-21T03:33:33Z"
          }],
          "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-11-21T03:33:33Z"
  }]
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv2.0.0: getKycStatuses

obp.getKycChecks

                            
                                Get KYC Checks
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.1.to.adapter.mf.caseclass.OutBoundGetKycChecks
                                to.obp.api.1.caseclass.OutBoundGetKycChecks

                                Message
                                {
  "outboundAdapterCallContext":{
    "correlationId":"string",
    "sessionId":"string",
    "consumerId":"string",
    "generalContext":[{
      "key":"string",
      "value":"string"
    }],
    "outboundAdapterAuthInfo":{
      "userId":"string",
      "username":"string",
      "linkedCustomers":[{
        "customerId":"string",
        "customerNumber":"string",
        "legalName":"string"
      }],
      "userAuthContext":[{
        "key":"string",
        "value":"string"
      }],
      "authViews":[{
        "view":{
          "id":"string",
          "name":"string",
          "description":"string"
        },
        "account":{
          "id":"string",
          "accountRoutings":[{
            "scheme":"string",
            "address":"string"
          }],
          "customerOwners":[{
            "bankId":"string",
            "customerId":"string",
            "customerNumber":"string",
            "legalName":"string",
            "dateOfBirth":"2024-11-21T03:33:33Z"
          }],
          "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-11-21T03:33:33Z",
    "how":"string",
    "staffUserId":"string",
    "staffName":"string",
    "satisfied":true,
    "comments":"string"
  }]
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv2.0.0: getKycChecks

obp.createMeeting

                            
                                Create Meeting
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.1.to.adapter.mf.caseclass.OutBoundCreateMeeting
                                from.obp.api.1.to.adapter.mf.caseclass.OutBoundCreateMeeting

                                Message
                                {
  "outboundAdapterCallContext":{
    "correlationId":"string",
    "sessionId":"string",
    "consumerId":"string",
    "generalContext":[{
      "key":"string",
      "value":"string"
    }],
    "outboundAdapterAuthInfo":{
      "userId":"string",
      "username":"string",
      "linkedCustomers":[{
        "customerId":"string",
        "customerNumber":"string",
        "legalName":"string"
      }],
      "userAuthContext":[{
        "key":"string",
        "value":"string"
      }],
      "authViews":[{
        "view":{
          "id":"string",
          "name":"string",
          "description":"string"
        },
        "account":{
          "id":"string",
          "accountRoutings":[{
            "scheme":"string",
            "address":"string"
          }],
          "customerOwners":[{
            "bankId":"string",
            "customerId":"string",
            "customerNumber":"string",
            "legalName":"string",
            "dateOfBirth":"2024-11-21T03:33:33Z"
          }],
          "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-11-21T03:33:33Z",
  "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-11-21T03:33:33Z",
    "creator":{
      "name":"string",
      "phone":"string",
      "email":"string"
    },
    "invitees":[{
      "contactDetails":{
        "name":"string",
        "phone":"string",
        "email":"string"
      },
      "status":"string"
    }]
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.1.0: createMeeting

obp.createBankAccount

                            
                                Create Bank Account
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.1.to.adapter.mf.caseclass.OutBoundCreateBankAccount
                                to.obp.api.1.caseclass.OutBoundCreateBankAccount

                                Message
                                {
  "outboundAdapterCallContext":{
    "correlationId":"string",
    "sessionId":"string",
    "consumerId":"string",
    "generalContext":[{
      "key":"string",
      "value":"string"
    }],
    "outboundAdapterAuthInfo":{
      "userId":"string",
      "username":"string",
      "linkedCustomers":[{
        "customerId":"string",
        "customerNumber":"string",
        "legalName":"string"
      }],
      "userAuthContext":[{
        "key":"string",
        "value":"string"
      }],
      "authViews":[{
        "view":{
          "id":"string",
          "name":"string",
          "description":"string"
        },
        "account":{
          "id":"string",
          "accountRoutings":[{
            "scheme":"string",
            "address":"string"
          }],
          "customerOwners":[{
            "bankId":"string",
            "customerId":"string",
            "customerNumber":"string",
            "legalName":"string",
            "dateOfBirth":"2024-11-21T03:33:33Z"
          }],
          "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-11-21T03:33:33Z",
    "branchId":"string",
    "accountRoutings":[{
      "scheme":"string",
      "address":"string"
    }]
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv2.2.0: createAccount
OBPv3.1.0: updateAccountApplicationStatus
OBPv3.1.0: createAccount
OBPv4.0.0: createSettlementAccount
OBPv5.0.0: createAccount

obp.getBankAccountsHeld

                            
                                Get Accounts held by the current User if even the User has not been assigned the owner View yet.
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.1.to.adapter.mf.caseclass.OutboundGetBankAccountsHeld
                                to.obp.api.1.caseclass.OutboundGetBankAccountsHeld

                                Message
                                {
  "authInfo":{
    "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "username":"felixsmith",
    "cbsToken":"FYIUYF6SUYFSD",
    "isFirst":true,
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "linkedCustomers":[{
      "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
      "customerNumber":"5987953",
      "legalName":"Eveline Tripman"
    }],
    "userAuthContexts":[{
      "key":"CUSTOMER_NUMBER",
      "value":"5987953"
    },{
      "key":"TOKEN",
      "value":"qieuriopwoir987ASYDUFISUYDF678u"
    }],
    "authViews":[{
      "view":{
        "id":"owner",
        "name":"Owner",
        "description":"This is the owner view"
      },
      "account":{
        "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
        "accountRoutings":[{
          "scheme":"AccountNumber",
          "address":"546387432"
        },{
          "scheme":"IBAN",
          "address":"DE91 1000 0000 0123 4567 89"
        }],
        "customerOwners":[{
          "bankId":"gh.29.uk",
          "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
          "customerNumber":"5987953",
          "legalName":"Eveline Tripman",
          "dateOfBirth":"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
                                OBPv3.0.0: getAccountsHeld

obp.getCoreBankAccounts

                            
                                Get bank Accounts available to the User (without Metadata)
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.1.to.adapter.mf.caseclass.OutboundGetCoreBankAccounts
                                to.obp.api.1.caseclass.OutboundGetCoreBankAccounts

                                Message
                                {
  "authInfo":{
    "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "username":"felixsmith",
    "cbsToken":"FYIUYF6SUYFSD",
    "isFirst":true,
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "linkedCustomers":[{
      "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
      "customerNumber":"5987953",
      "legalName":"Eveline Tripman"
    }],
    "userAuthContexts":[{
      "key":"CUSTOMER_NUMBER",
      "value":"5987953"
    },{
      "key":"TOKEN",
      "value":"qieuriopwoir987ASYDUFISUYDF678u"
    }],
    "authViews":[{
      "view":{
        "id":"owner",
        "name":"Owner",
        "description":"This is the owner view"
      },
      "account":{
        "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
        "accountRoutings":[{
          "scheme":"AccountNumber",
          "address":"546387432"
        },{
          "scheme":"IBAN",
          "address":"DE91 1000 0000 0123 4567 89"
        }],
        "customerOwners":[{
          "bankId":"gh.29.uk",
          "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
          "customerNumber":"5987953",
          "legalName":"Eveline Tripman",
          "dateOfBirth":"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
                                AUv1.0.0: listAccounts
BGv1: getAccountList
OBPv3.0.0: corePrivateAccountsAllBanks
OBPv3.0.0: privateAccountsAtOneBank
OBPv3.0.0: getPrivateAccountIdsbyBankId
OBPv3.0.0: getAccountsHeld

obp.checkBankAccountExists

                            
                                Check a bank Account exists - as specified by bankId and accountId.
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.1.to.adapter.mf.caseclass.OutboundCheckBankAccountExists
                                to.obp.api.1.caseclass.OutboundCheckBankAccountExists

                                Message
                                {
  "authInfo":{
    "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "username":"felixsmith",
    "cbsToken":"FYIUYF6SUYFSD",
    "isFirst":true,
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "linkedCustomers":[{
      "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
      "customerNumber":"5987953",
      "legalName":"Eveline Tripman"
    }],
    "userAuthContexts":[{
      "key":"CUSTOMER_NUMBER",
      "value":"5987953"
    },{
      "key":"TOKEN",
      "value":"qieuriopwoir987ASYDUFISUYDF678u"
    }],
    "authViews":[{
      "view":{
        "id":"owner",
        "name":"Owner",
        "description":"This is the owner view"
      },
      "account":{
        "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
        "accountRoutings":[{
          "scheme":"AccountNumber",
          "address":"546387432"
        },{
          "scheme":"IBAN",
          "address":"DE91 1000 0000 0123 4567 89"
        }],
        "customerOwners":[{
          "bankId":"gh.29.uk",
          "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
          "customerNumber":"5987953",
          "legalName":"Eveline Tripman",
          "dateOfBirth":"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
                                STETv1.4: accountsBalancesGet
STETv1.4: accountsTransactionsGet
AUv1.0.0: listBalance
BGv1: getAccountBalances
BGv1: getTransactionList
BGv1.3: getPaymentInitiationStatus
BGv1.3: updatePaymentCancellationPsuData
BGv1.3: updatePaymentPsuData
: getPaymentInitiationStatus
: updatePaymentCancellationPsuData
: updatePaymentPsuData
OBPv1.2.1: updateAccountLabel
OBPv1.2.1: deleteViewForBankAccount
OBPv1.2.1: addPermissionForUserForBankAccountForMultipleViews
OBPv1.2.1: addPermissionForUserForBankAccountForOneView
OBPv1.2.1: removePermissionForUserForBankAccountForOneView
OBPv1.2.1: removePermissionForUserForBankAccountForAllViews
OBPv1.2.1: getOtherAccountMetadata
OBPv1.2.1: getCounterpartyPublicAlias
OBPv1.2.1: addCounterpartyPublicAlias
OBPv1.2.1: updateCounterpartyPublicAlias
OBPv1.2.1: deleteCounterpartyPublicAlias
OBPv1.2.1: getOtherAccountPrivateAlias
OBPv1.2.1: addOtherAccountPrivateAlias
OBPv1.2.1: updateCounterpartyPrivateAlias
OBPv1.2.1: deleteCounterpartyPrivateAlias
OBPv1.2.1: addCounterpartyMoreInfo
OBPv1.2.1: updateCounterpartyMoreInfo
OBPv1.2.1: deleteCounterpartyMoreInfo
OBPv1.2.1: addCounterpartyUrl
OBPv1.2.1: updateCounterpartyUrl
OBPv1.2.1: deleteCounterpartyUrl
OBPv1.2.1: addCounterpartyImageUrl
OBPv1.2.1: updateCounterpartyImageUrl
OBPv1.2.1: deleteCounterpartyImageUrl
OBPv1.2.1: addCounterpartyOpenCorporatesUrl
OBPv1.2.1: updateCounterpartyOpenCorporatesUrl
OBPv1.2.1: deleteCounterpartyOpenCorporatesUrl
OBPv1.2.1: deleteCounterpartyCorporateLocation
OBPv1.2.1: deleteCounterpartyPhysicalLocation
OBPv1.2.1: getTransactionNarrative
OBPv1.2.1: addTransactionNarrative
OBPv1.2.1: updateTransactionNarrative
OBPv1.2.1: deleteTransactionNarrative
OBPv1.2.1: getCommentsForViewOnTransaction
OBPv1.2.1: addCommentForViewOnTransaction
OBPv1.2.1: deleteCommentForViewOnTransaction
OBPv1.2.1: getTagsForViewOnTransaction
OBPv1.2.1: addTagForViewOnTransaction
OBPv1.2.1: deleteTagForViewOnTransaction
OBPv1.2.1: getImagesForViewOnTransaction
OBPv1.2.1: addImageForViewOnTransaction
OBPv1.2.1: deleteImageForViewOnTransaction
OBPv1.2.1: getWhereTagForViewOnTransaction
OBPv1.2.1: addWhereTagForViewOnTransaction
OBPv1.2.1: updateWhereTagForViewOnTransaction
OBPv1.2.1: deleteWhereTagForViewOnTransaction
OBPv1.2.1: getOtherAccountForTransaction
OBPv1.4.0: getTransactionRequestTypes
OBPv2.0.0: getPermissionsForBankAccount
OBPv2.1.0: createTransactionRequestSandboxTan
OBPv2.1.0: createTransactionRequestCounterparty
OBPv2.1.0: createTransactionRequestSepa
OBPv2.1.0: createTransactionRequestFreeForm
OBPv2.1.0: answerTransactionRequestChallenge
OBPv2.1.0: addCardsForBank
OBPv2.2.0: getViewsForBankAccount
OBPv2.2.0: getExplictCounterpartiesForAccount
OBPv2.2.0: getExplictCounterpartyById
OBPv2.2.0: createCounterparty
OBPv3.0.0: getViewsForBankAccount
OBPv3.0.0: createViewForBankAccount
OBPv3.0.0: getPermissionForUserForBankAccount
OBPv3.0.0: updateViewForBankAccount
OBPv3.0.0: getPrivateAccountById
OBPv3.0.0: getPublicAccountById
OBPv3.0.0: getCoreAccountById
OBPv3.0.0: getFirehoseTransactionsForBankAccount
OBPv3.0.0: getCoreTransactionsForBankAccount
OBPv3.0.0: getTransactionsForBankAccount
OBPv3.0.0: getOtherAccountsForBankAccount
OBPv3.0.0: getOtherAccountByIdForBankAccount
OBPv3.1.0: getCheckbookOrders
OBPv3.1.0: getStatusOfCreditCardOrder
OBPv3.1.0: checkFundsAvailable
OBPv3.1.0: getTransactionByIdForBankAccount
OBPv3.1.0: getTransactionRequests
OBPv3.1.0: createAccountAttribute
OBPv3.1.0: updateAccountAttribute
OBPv3.1.0: updateAccount
OBPv3.1.0: addCardForBank
OBPv3.1.0: updatedCardForBank
OBPv3.1.0: createAccount
OBPv3.1.0: getPrivateAccountByIdFull
OBPv3.1.0: saveHistoricalTransaction
OBPv4.0.0: getAccountsByAccountRoutingRegex
OBPv4.0.0: createHistoricalTransactionAtBank
OBPv4.0.0: createCounterparty
OBPv4.0.0: createCounterpartyForAnyAccount
OBPv5.0.0: createAccount
OBPv5.0.0: addCardForBank
OBPv5.0.0: createCustomerAccountLink
OBPv5.0.0: getViewsForBankAccount
OBPv5.0.0: getCustomerAccountLinksByBankIdAccountId
OBPv4.0.0: getDoubleEntryTransaction
OBPv4.0.0: createTransactionRequestAccount
OBPv4.0.0: createTransactionRequestAccountOtp
OBPv4.0.0: createTransactionRequestCounterparty
OBPv4.0.0: createTransactionRequestSimple
OBPv4.0.0: createTransactionRequestSepa
OBPv4.0.0: createTransactionRequestRefund
OBPv4.0.0: createTransactionRequestFreeForm
OBPv4.0.0: answerTransactionRequestChallenge
OBPv4.0.0: createTransactionRequestAttribute
OBPv4.0.0: getTransactionRequestAttributeById
OBPv4.0.0: getTransactionRequestAttributes
OBPv4.0.0: updateTransactionRequestAttribute
OBPv4.0.0: updateAccountLabel
OBPv4.0.0: addTagForViewOnAccount
OBPv4.0.0: deleteTagForViewOnAccount
OBPv4.0.0: getTagsForViewOnAccount
OBPv4.0.0: getCoreAccountById
OBPv4.0.0: getPrivateAccountByIdFull
OBPv4.0.0: createDirectDebit
OBPv4.0.0: createDirectDebitManagement
OBPv4.0.0: createStandingOrder
OBPv4.0.0: createStandingOrderManagement
OBPv4.0.0: createTransactionAttribute
OBPv4.0.0: updateTransactionAttribute
OBPv4.0.0: getTransactionAttributes
OBPv4.0.0: getTransactionAttributeById
OBPv4.0.0: getTransactionRequest
OBPv4.0.0: deleteTransactionCascade
OBPv4.0.0: deleteAccountCascade
OBPv4.0.0: deleteExplicitCounterparty
OBPv4.0.0: deleteCounterpartyForAnyAccount
OBPv4.0.0: getExplictCounterpartiesForAccount
OBPv4.0.0: getCounterpartiesForAnyAccount
OBPv4.0.0: getExplictCounterpartyById
OBPv4.0.0: getCounterpartyByNameForAnyAccount
OBPv4.0.0: getCounterpartyByIdForAnyAccount

obp.getBankAccountsForUser

                            
                                Gets the list of accounts available to the User. This call sends authInfo including username.
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.1.to.adapter.mf.caseclass.OutboundGetAccounts
                                to.obp.api.1.caseclass.InboundGetAccounts

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

obp.getBankAccount

                            
                                Get a single Account as specified by the bankId and accountId.
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.1.to.adapter.mf.caseclass.OutboundGetAccountbyAccountID
                                to.obp.api.1.caseclass.OutboundGetAccountbyAccountID

                                Message
                                {
  "authInfo":{
    "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "username":"felixsmith",
    "cbsToken":"FYIUYF6SUYFSD",
    "isFirst":true,
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "linkedCustomers":[{
      "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
      "customerNumber":"5987953",
      "legalName":"Eveline Tripman"
    }],
    "userAuthContexts":[{
      "key":"CUSTOMER_NUMBER",
      "value":"5987953"
    },{
      "key":"TOKEN",
      "value":"qieuriopwoir987ASYDUFISUYDF678u"
    }],
    "authViews":[{
      "view":{
        "id":"owner",
        "name":"Owner",
        "description":"This is the owner view"
      },
      "account":{
        "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
        "accountRoutings":[{
          "scheme":"AccountNumber",
          "address":"546387432"
        },{
          "scheme":"IBAN",
          "address":"DE91 1000 0000 0123 4567 89"
        }],
        "customerOwners":[{
          "bankId":"gh.29.uk",
          "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
          "customerNumber":"5987953",
          "legalName":"Eveline Tripman",
          "dateOfBirth":"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/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.1.to.adapter.mf.caseclass.OutboundGetCustomersByUserId
                                to.obp.api.1.caseclass.OutboundGetCustomersByUserId

                                Message
                                {
  "authInfo":{
    "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "username":"felixsmith",
    "cbsToken":"FYIUYF6SUYFSD",
    "isFirst":true,
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "linkedCustomers":[{
      "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
      "customerNumber":"5987953",
      "legalName":"Eveline Tripman"
    }],
    "userAuthContexts":[{
      "key":"CUSTOMER_NUMBER",
      "value":"5987953"
    },{
      "key":"TOKEN",
      "value":"qieuriopwoir987ASYDUFISUYDF678u"
    }],
    "authViews":[{
      "view":{
        "id":"owner",
        "name":"Owner",
        "description":"This is the owner view"
      },
      "account":{
        "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
        "accountRoutings":[{
          "scheme":"AccountNumber",
          "address":"546387432"
        },{
          "scheme":"IBAN",
          "address":"DE91 1000 0000 0123 4567 89"
        }],
        "customerOwners":[{
          "bankId":"gh.29.uk",
          "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
          "customerNumber":"5987953",
          "legalName":"Eveline Tripman",
          "dateOfBirth":"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 Customer
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.1.to.adapter.mf.caseclass.OutBoundCreateCustomer
                                to.obp.api.1.caseclass.OutBoundCreateCustomer

                                Message
                                {
  "outboundAdapterCallContext":{
    "correlationId":"string",
    "sessionId":"string",
    "consumerId":"string",
    "generalContext":[{
      "key":"string",
      "value":"string"
    }],
    "outboundAdapterAuthInfo":{
      "userId":"string",
      "username":"string",
      "linkedCustomers":[{
        "customerId":"string",
        "customerNumber":"string",
        "legalName":"string"
      }],
      "userAuthContext":[{
        "key":"string",
        "value":"string"
      }],
      "authViews":[{
        "view":{
          "id":"string",
          "name":"string",
          "description":"string"
        },
        "account":{
          "id":"string",
          "accountRoutings":[{
            "scheme":"string",
            "address":"string"
          }],
          "customerOwners":[{
            "bankId":"string",
            "customerId":"string",
            "customerNumber":"string",
            "legalName":"string",
            "dateOfBirth":"2024-11-21T03:33:33Z"
          }],
          "userOwners":[{
            "userId":"string",
            "emailAddress":"string",
            "name":"string"
          }]
        }
      }]
    }
  },
  "bankId":{
    "value":"string"
  },
  "legalName":"string",
  "mobileNumber":"string",
  "email":"string",
  "faceImage":{
    "date":"2024-11-21T03:33:33Z",
    "url":"string"
  },
  "dateOfBirth":"2024-11-21T03:33:33Z",
  "relationshipStatus":"string",
  "dependents":123,
  "dobOfDependents":["2024-11-21T03:33:33Z"],
  "highestEducationAttained":"string",
  "employmentStatus":"string",
  "kycStatus":true,
  "lastOkDate":"2024-11-21T03:33:33Z",
  "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-11-21T03:33:33Z",
      "url":"string"
    },
    "dateOfBirth":"2024-11-21T03:33:33Z",
    "relationshipStatus":"string",
    "dependents":123,
    "dobOfDependents":["2024-11-21T03:33:33Z"],
    "highestEducationAttained":"string",
    "employmentStatus":"string",
    "creditRating":{
      "rating":"string",
      "source":"string"
    },
    "creditLimit":{
      "currency":"string",
      "amount":"string"
    },
    "kycStatus":true,
    "lastOkDate":"2024-11-21T03:33:33Z",
    "title":"string",
    "branchId":"string",
    "nameSuffix":"string"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.1.0: createCustomer
OBPv4.0.0: createCustomer

obp.createOrUpdateKycCheck

                            
                                Create Or Update Kyc Check
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.1.to.adapter.mf.caseclass.OutBoundCreateOrUpdateKycCheck
                                to.obp.api.1.caseclass.OutBoundCreateOrUpdateKycCheck

                                Message
                                {
  "outboundAdapterCallContext":{
    "correlationId":"string",
    "sessionId":"string",
    "consumerId":"string",
    "generalContext":[{
      "key":"string",
      "value":"string"
    }],
    "outboundAdapterAuthInfo":{
      "userId":"string",
      "username":"string",
      "linkedCustomers":[{
        "customerId":"string",
        "customerNumber":"string",
        "legalName":"string"
      }],
      "userAuthContext":[{
        "key":"string",
        "value":"string"
      }],
      "authViews":[{
        "view":{
          "id":"string",
          "name":"string",
          "description":"string"
        },
        "account":{
          "id":"string",
          "accountRoutings":[{
            "scheme":"string",
            "address":"string"
          }],
          "customerOwners":[{
            "bankId":"string",
            "customerId":"string",
            "customerNumber":"string",
            "legalName":"string",
            "dateOfBirth":"2024-11-21T03:33:33Z"
          }],
          "userOwners":[{
            "userId":"string",
            "emailAddress":"string",
            "name":"string"
          }]
        }
      }]
    }
  },
  "bankId":"string",
  "customerId":"string",
  "id":"string",
  "customerNumber":"string",
  "date":"2024-11-21T03:33:33Z",
  "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-11-21T03:33:33Z",
    "how":"string",
    "staffUserId":"string",
    "staffName":"string",
    "satisfied":true,
    "comments":"string"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv2.0.0: addKycCheck

obp.createOrUpdateKycDocument

                            
                                Create Or Update Kyc Document
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.1.to.adapter.mf.caseclass.OutBoundCreateOrUpdateKycDocument
                                to.obp.api.1.caseclass.OutBoundCreateOrUpdateKycDocument

                                Message
                                {
  "outboundAdapterCallContext":{
    "correlationId":"string",
    "sessionId":"string",
    "consumerId":"string",
    "generalContext":[{
      "key":"string",
      "value":"string"
    }],
    "outboundAdapterAuthInfo":{
      "userId":"string",
      "username":"string",
      "linkedCustomers":[{
        "customerId":"string",
        "customerNumber":"string",
        "legalName":"string"
      }],
      "userAuthContext":[{
        "key":"string",
        "value":"string"
      }],
      "authViews":[{
        "view":{
          "id":"string",
          "name":"string",
          "description":"string"
        },
        "account":{
          "id":"string",
          "accountRoutings":[{
            "scheme":"string",
            "address":"string"
          }],
          "customerOwners":[{
            "bankId":"string",
            "customerId":"string",
            "customerNumber":"string",
            "legalName":"string",
            "dateOfBirth":"2024-11-21T03:33:33Z"
          }],
          "userOwners":[{
            "userId":"string",
            "emailAddress":"string",
            "name":"string"
          }]
        }
      }]
    }
  },
  "bankId":"string",
  "customerId":"string",
  "id":"string",
  "customerNumber":"string",
  "type":"string",
  "number":"string",
  "issueDate":"2024-11-21T03:33:33Z",
  "issuePlace":"string",
  "expiryDate":"2024-11-21T03:33:33Z"
}
                                {
  "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-11-21T03:33:33Z",
    "issuePlace":"string",
    "expiryDate":"2024-11-21T03:33:33Z"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv2.0.0: addKycDocument

obp.createOrUpdateKycMedia

                            
                                Create Or Update Kyc Media
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.1.to.adapter.mf.caseclass.OutBoundCreateOrUpdateKycMedia
                                to.obp.api.1.caseclass.OutBoundCreateOrUpdateKycMedia

                                Message
                                {
  "outboundAdapterCallContext":{
    "correlationId":"string",
    "sessionId":"string",
    "consumerId":"string",
    "generalContext":[{
      "key":"string",
      "value":"string"
    }],
    "outboundAdapterAuthInfo":{
      "userId":"string",
      "username":"string",
      "linkedCustomers":[{
        "customerId":"string",
        "customerNumber":"string",
        "legalName":"string"
      }],
      "userAuthContext":[{
        "key":"string",
        "value":"string"
      }],
      "authViews":[{
        "view":{
          "id":"string",
          "name":"string",
          "description":"string"
        },
        "account":{
          "id":"string",
          "accountRoutings":[{
            "scheme":"string",
            "address":"string"
          }],
          "customerOwners":[{
            "bankId":"string",
            "customerId":"string",
            "customerNumber":"string",
            "legalName":"string",
            "dateOfBirth":"2024-11-21T03:33:33Z"
          }],
          "userOwners":[{
            "userId":"string",
            "emailAddress":"string",
            "name":"string"
          }]
        }
      }]
    }
  },
  "bankId":"string",
  "customerId":"string",
  "id":"string",
  "customerNumber":"string",
  "type":"string",
  "url":"string",
  "date":"2024-11-21T03:33:33Z",
  "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-11-21T03:33:33Z",
    "relatesToKycDocumentId":"string",
    "relatesToKycCheckId":"string"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv2.0.0: addKycMedia

obp.createOrUpdateKycStatus

                            
                                Create Or Update Kyc Status
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.1.to.adapter.mf.caseclass.OutBoundCreateOrUpdateKycStatus
                                to.obp.api.1.caseclass.OutBoundCreateOrUpdateKycStatus

                                Message
                                {
  "outboundAdapterCallContext":{
    "correlationId":"string",
    "sessionId":"string",
    "consumerId":"string",
    "generalContext":[{
      "key":"string",
      "value":"string"
    }],
    "outboundAdapterAuthInfo":{
      "userId":"string",
      "username":"string",
      "linkedCustomers":[{
        "customerId":"string",
        "customerNumber":"string",
        "legalName":"string"
      }],
      "userAuthContext":[{
        "key":"string",
        "value":"string"
      }],
      "authViews":[{
        "view":{
          "id":"string",
          "name":"string",
          "description":"string"
        },
        "account":{
          "id":"string",
          "accountRoutings":[{
            "scheme":"string",
            "address":"string"
          }],
          "customerOwners":[{
            "bankId":"string",
            "customerId":"string",
            "customerNumber":"string",
            "legalName":"string",
            "dateOfBirth":"2024-11-21T03:33:33Z"
          }],
          "userOwners":[{
            "userId":"string",
            "emailAddress":"string",
            "name":"string"
          }]
        }
      }]
    }
  },
  "bankId":"string",
  "customerId":"string",
  "customerNumber":"string",
  "ok":true,
  "date":"2024-11-21T03:33:33Z"
}
                                {
  "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-11-21T03:33:33Z"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv2.0.0: addKycStatus

obp.getKycChecks

                            
                                Get Kyc Checks
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.1.to.adapter.mf.caseclass.OutBoundGetKycChecks
                                to.obp.api.1.caseclass.OutBoundGetKycChecks

                                Message
                                {
  "outboundAdapterCallContext":{
    "correlationId":"string",
    "sessionId":"string",
    "consumerId":"string",
    "generalContext":[{
      "key":"string",
      "value":"string"
    }],
    "outboundAdapterAuthInfo":{
      "userId":"string",
      "username":"string",
      "linkedCustomers":[{
        "customerId":"string",
        "customerNumber":"string",
        "legalName":"string"
      }],
      "userAuthContext":[{
        "key":"string",
        "value":"string"
      }],
      "authViews":[{
        "view":{
          "id":"string",
          "name":"string",
          "description":"string"
        },
        "account":{
          "id":"string",
          "accountRoutings":[{
            "scheme":"string",
            "address":"string"
          }],
          "customerOwners":[{
            "bankId":"string",
            "customerId":"string",
            "customerNumber":"string",
            "legalName":"string",
            "dateOfBirth":"2024-11-21T03:33:33Z"
          }],
          "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-11-21T03:33:33Z",
    "how":"string",
    "staffUserId":"string",
    "staffName":"string",
    "satisfied":true,
    "comments":"string"
  }]
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv2.0.0: getKycChecks

obp.getKycDocuments

                            
                                Get Kyc Documents
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.1.to.adapter.mf.caseclass.OutBoundGetKycDocuments
                                to.obp.api.1.caseclass.OutBoundGetKycDocuments

                                Message
                                {
  "outboundAdapterCallContext":{
    "correlationId":"string",
    "sessionId":"string",
    "consumerId":"string",
    "generalContext":[{
      "key":"string",
      "value":"string"
    }],
    "outboundAdapterAuthInfo":{
      "userId":"string",
      "username":"string",
      "linkedCustomers":[{
        "customerId":"string",
        "customerNumber":"string",
        "legalName":"string"
      }],
      "userAuthContext":[{
        "key":"string",
        "value":"string"
      }],
      "authViews":[{
        "view":{
          "id":"string",
          "name":"string",
          "description":"string"
        },
        "account":{
          "id":"string",
          "accountRoutings":[{
            "scheme":"string",
            "address":"string"
          }],
          "customerOwners":[{
            "bankId":"string",
            "customerId":"string",
            "customerNumber":"string",
            "legalName":"string",
            "dateOfBirth":"2024-11-21T03:33:33Z"
          }],
          "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-11-21T03:33:33Z",
    "issuePlace":"string",
    "expiryDate":"2024-11-21T03:33:33Z"
  }]
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv2.0.0: getKycDocuments

obp.getKycMedias

                            
                                Get Kyc Medias
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.1.to.adapter.mf.caseclass.OutBoundGetKycMedias
                                to.obp.api.1.caseclass.OutBoundGetKycMedias

                                Message
                                {
  "outboundAdapterCallContext":{
    "correlationId":"string",
    "sessionId":"string",
    "consumerId":"string",
    "generalContext":[{
      "key":"string",
      "value":"string"
    }],
    "outboundAdapterAuthInfo":{
      "userId":"string",
      "username":"string",
      "linkedCustomers":[{
        "customerId":"string",
        "customerNumber":"string",
        "legalName":"string"
      }],
      "userAuthContext":[{
        "key":"string",
        "value":"string"
      }],
      "authViews":[{
        "view":{
          "id":"string",
          "name":"string",
          "description":"string"
        },
        "account":{
          "id":"string",
          "accountRoutings":[{
            "scheme":"string",
            "address":"string"
          }],
          "customerOwners":[{
            "bankId":"string",
            "customerId":"string",
            "customerNumber":"string",
            "legalName":"string",
            "dateOfBirth":"2024-11-21T03:33:33Z"
          }],
          "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-11-21T03:33:33Z",
    "relatesToKycDocumentId":"string",
    "relatesToKycCheckId":"string"
  }]
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv2.0.0: getKycMedia

obp.getKycStatuses

                            
                                Get Kyc Statuses
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.1.to.adapter.mf.caseclass.OutBoundGetKycStatuses
                                to.obp.api.1.caseclass.OutBoundGetKycStatuses

                                Message
                                {
  "outboundAdapterCallContext":{
    "correlationId":"string",
    "sessionId":"string",
    "consumerId":"string",
    "generalContext":[{
      "key":"string",
      "value":"string"
    }],
    "outboundAdapterAuthInfo":{
      "userId":"string",
      "username":"string",
      "linkedCustomers":[{
        "customerId":"string",
        "customerNumber":"string",
        "legalName":"string"
      }],
      "userAuthContext":[{
        "key":"string",
        "value":"string"
      }],
      "authViews":[{
        "view":{
          "id":"string",
          "name":"string",
          "description":"string"
        },
        "account":{
          "id":"string",
          "accountRoutings":[{
            "scheme":"string",
            "address":"string"
          }],
          "customerOwners":[{
            "bankId":"string",
            "customerId":"string",
            "customerNumber":"string",
            "legalName":"string",
            "dateOfBirth":"2024-11-21T03:33:33Z"
          }],
          "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-11-21T03:33:33Z"
  }]
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv2.0.0: getKycStatuses

obp.getCheckbookOrdersFuture

                            
                                Get the status of CheckbookOrders for an Account.
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.1.to.adapter.mf.caseclass.OutboundGetCheckbookOrderStatus
                                to.obp.api.1.caseclass.OutboundGetCheckbookOrderStatus

                                Message
                                {
  "authInfo":{
    "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "username":"felixsmith",
    "cbsToken":"FYIUYF6SUYFSD",
    "isFirst":true,
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "linkedCustomers":[{
      "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
      "customerNumber":"5987953",
      "legalName":"Eveline Tripman"
    }],
    "userAuthContexts":[{
      "key":"CUSTOMER_NUMBER",
      "value":"5987953"
    },{
      "key":"TOKEN",
      "value":"qieuriopwoir987ASYDUFISUYDF678u"
    }],
    "authViews":[{
      "view":{
        "id":"owner",
        "name":"Owner",
        "description":"This is the owner view"
      },
      "account":{
        "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
        "accountRoutings":[{
          "scheme":"AccountNumber",
          "address":"546387432"
        },{
          "scheme":"IBAN",
          "address":"DE91 1000 0000 0123 4567 89"
        }],
        "customerOwners":[{
          "bankId":"gh.29.uk",
          "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
          "customerNumber":"5987953",
          "legalName":"Eveline Tripman",
          "dateOfBirth":"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 CreditCardOrders
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.1.to.adapter.mf.caseclass.OutboundGetCreditCardOrderStatus
                                to.obp.api.1.caseclass.OutboundGetCreditCardOrderStatus

                                Message
                                {
  "authInfo":{
    "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "username":"felixsmith",
    "cbsToken":"FYIUYF6SUYFSD",
    "isFirst":true,
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "linkedCustomers":[{
      "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
      "customerNumber":"5987953",
      "legalName":"Eveline Tripman"
    }],
    "userAuthContexts":[{
      "key":"CUSTOMER_NUMBER",
      "value":"5987953"
    },{
      "key":"TOKEN",
      "value":"qieuriopwoir987ASYDUFISUYDF678u"
    }],
    "authViews":[{
      "view":{
        "id":"owner",
        "name":"Owner",
        "description":"This is the owner view"
      },
      "account":{
        "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
        "accountRoutings":[{
          "scheme":"AccountNumber",
          "address":"546387432"
        },{
          "scheme":"IBAN",
          "address":"DE91 1000 0000 0123 4567 89"
        }],
        "customerOwners":[{
          "bankId":"gh.29.uk",
          "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
          "customerNumber":"5987953",
          "legalName":"Eveline Tripman",
          "dateOfBirth":"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 bankId
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.1.to.adapter.mf.caseclass.OutboundGetBranches
                                to.obp.api.1.caseclass.OutboundGetBranches

                                Message
                                {
  "authInfo":{
    "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "username":"felixsmith",
    "cbsToken":"FYIUYF6SUYFSD",
    "isFirst":true,
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "linkedCustomers":[{
      "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
      "customerNumber":"5987953",
      "legalName":"Eveline Tripman"
    }],
    "userAuthContexts":[{
      "key":"CUSTOMER_NUMBER",
      "value":"5987953"
    },{
      "key":"TOKEN",
      "value":"qieuriopwoir987ASYDUFISUYDF678u"
    }],
    "authViews":[{
      "view":{
        "id":"owner",
        "name":"Owner",
        "description":"This is the owner view"
      },
      "account":{
        "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
        "accountRoutings":[{
          "scheme":"AccountNumber",
          "address":"546387432"
        },{
          "scheme":"IBAN",
          "address":"DE91 1000 0000 0123 4567 89"
        }],
        "customerOwners":[{
          "bankId":"gh.29.uk",
          "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
          "customerNumber":"5987953",
          "legalName":"Eveline Tripman",
          "dateOfBirth":"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
                                OBPv3.0.0: getBranches

obp.getBranch

                            
                                Get a Branch as specified by bankId and branchId
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.1.to.adapter.mf.caseclass.OutboundGetBranch
                                to.obp.api.1.caseclass.OutboundGetBranch

                                Message
                                {
  "authInfo":{
    "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "username":"felixsmith",
    "cbsToken":"FYIUYF6SUYFSD",
    "isFirst":true,
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "linkedCustomers":[{
      "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
      "customerNumber":"5987953",
      "legalName":"Eveline Tripman"
    }],
    "userAuthContexts":[{
      "key":"CUSTOMER_NUMBER",
      "value":"5987953"
    },{
      "key":"TOKEN",
      "value":"qieuriopwoir987ASYDUFISUYDF678u"
    }],
    "authViews":[{
      "view":{
        "id":"owner",
        "name":"Owner",
        "description":"This is the owner view"
      },
      "account":{
        "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
        "accountRoutings":[{
          "scheme":"AccountNumber",
          "address":"546387432"
        },{
          "scheme":"IBAN",
          "address":"DE91 1000 0000 0123 4567 89"
        }],
        "customerOwners":[{
          "bankId":"gh.29.uk",
          "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
          "customerNumber":"5987953",
          "legalName":"Eveline Tripman",
          "dateOfBirth":"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
                                OBPv3.0.0: getBranch
OBPv3.1.0: deleteBranch

obp.getAtms

                            
                                Get ATMs for a bank specified by bankId
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.1.to.adapter.mf.caseclass.OutboundGetAtms
                                to.obp.api.1.caseclass.OutboundGetAtms

                                Message
                                {
  "authInfo":{
    "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "username":"felixsmith",
    "cbsToken":"FYIUYF6SUYFSD",
    "isFirst":true,
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "linkedCustomers":[{
      "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
      "customerNumber":"5987953",
      "legalName":"Eveline Tripman"
    }],
    "userAuthContexts":[{
      "key":"CUSTOMER_NUMBER",
      "value":"5987953"
    },{
      "key":"TOKEN",
      "value":"qieuriopwoir987ASYDUFISUYDF678u"
    }],
    "authViews":[{
      "view":{
        "id":"owner",
        "name":"Owner",
        "description":"This is the owner view"
      },
      "account":{
        "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
        "accountRoutings":[{
          "scheme":"AccountNumber",
          "address":"546387432"
        },{
          "scheme":"IBAN",
          "address":"DE91 1000 0000 0123 4567 89"
        }],
        "customerOwners":[{
          "bankId":"gh.29.uk",
          "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
          "customerNumber":"5987953",
          "legalName":"Eveline Tripman",
          "dateOfBirth":"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
                                OBPv3.0.0: getAtms
OBPv4.0.0: getAtms
OBPv5.1.0: getAtms

obp.getAtm

                            
                                Get an ATM as specified by bankId and atmId.
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.1.to.adapter.mf.caseclass.OutboundGetAtm
                                to.obp.api.1.caseclass.OutboundGetAtm

                                Message
                                {
  "authInfo":{
    "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "username":"felixsmith",
    "cbsToken":"FYIUYF6SUYFSD",
    "isFirst":true,
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "linkedCustomers":[{
      "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
      "customerNumber":"5987953",
      "legalName":"Eveline Tripman"
    }],
    "userAuthContexts":[{
      "key":"CUSTOMER_NUMBER",
      "value":"5987953"
    },{
      "key":"TOKEN",
      "value":"qieuriopwoir987ASYDUFISUYDF678u"
    }],
    "authViews":[{
      "view":{
        "id":"owner",
        "name":"Owner",
        "description":"This is the owner view"
      },
      "account":{
        "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
        "accountRoutings":[{
          "scheme":"AccountNumber",
          "address":"546387432"
        },{
          "scheme":"IBAN",
          "address":"DE91 1000 0000 0123 4567 89"
        }],
        "customerOwners":[{
          "bankId":"gh.29.uk",
          "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
          "customerNumber":"5987953",
          "legalName":"Eveline Tripman",
          "dateOfBirth":"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
                                OBPv3.0.0: getAtm
OBPv4.0.0: updateAtmSupportedCurrencies
OBPv4.0.0: updateAtmSupportedLanguages
OBPv4.0.0: updateAtmAccessibilityFeatures
OBPv4.0.0: updateAtmServices
OBPv4.0.0: updateAtmNotes
OBPv4.0.0: updateAtmLocationCategories
OBPv4.0.0: updateAtm
OBPv4.0.0: deleteAtm
OBPv4.0.0: getAtm
OBPv5.1.0: createAtmAttribute
OBPv5.1.0: getAtmAttributes
OBPv5.1.0: getAtmAttribute
OBPv5.1.0: updateAtmAttribute
OBPv5.1.0: deleteAtmAttribute
OBPv5.1.0: updateAtm
OBPv5.1.0: getAtm
OBPv5.1.0: deleteAtm

obp.getCounterparties

                            
                                Get Counterparties available to the View on the Account specified by thisBankId, thisAccountId and viewId.
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.1.to.adapter.mf.caseclass.OutboundGetCounterparties
                                to.obp.api.1.caseclass.OutboundGetCounterparties

                                Message
                                {
  "authInfo":{
    "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "username":"felixsmith",
    "cbsToken":"FYIUYF6SUYFSD",
    "isFirst":true,
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "linkedCustomers":[{
      "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
      "customerNumber":"5987953",
      "legalName":"Eveline Tripman"
    }],
    "userAuthContexts":[{
      "key":"CUSTOMER_NUMBER",
      "value":"5987953"
    },{
      "key":"TOKEN",
      "value":"qieuriopwoir987ASYDUFISUYDF678u"
    }],
    "authViews":[{
      "view":{
        "id":"owner",
        "name":"Owner",
        "description":"This is the owner view"
      },
      "account":{
        "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
        "accountRoutings":[{
          "scheme":"AccountNumber",
          "address":"546387432"
        },{
          "scheme":"IBAN",
          "address":"DE91 1000 0000 0123 4567 89"
        }],
        "customerOwners":[{
          "bankId":"gh.29.uk",
          "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
          "customerNumber":"5987953",
          "legalName":"Eveline Tripman",
          "dateOfBirth":"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
                                OBPv2.2.0: getExplictCounterpartiesForAccount
OBPv4.0.0: getExplictCounterpartiesForAccount
OBPv4.0.0: getCounterpartiesForAnyAccount

obp.getCounterpartyByCounterpartyId

                            
                                Get a Counterparty by its counterpartyId.
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.1.to.adapter.mf.caseclass.OutboundGetCounterpartyByCounterpartyId
                                to.obp.api.1.caseclass.OutboundGetCounterpartyByCounterpartyId

                                Message
                                {
  "authInfo":{
    "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "username":"felixsmith",
    "cbsToken":"FYIUYF6SUYFSD",
    "isFirst":true,
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "linkedCustomers":[{
      "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
      "customerNumber":"5987953",
      "legalName":"Eveline Tripman"
    }],
    "userAuthContexts":[{
      "key":"CUSTOMER_NUMBER",
      "value":"5987953"
    },{
      "key":"TOKEN",
      "value":"qieuriopwoir987ASYDUFISUYDF678u"
    }],
    "authViews":[{
      "view":{
        "id":"owner",
        "name":"Owner",
        "description":"This is the owner view"
      },
      "account":{
        "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
        "accountRoutings":[{
          "scheme":"AccountNumber",
          "address":"546387432"
        },{
          "scheme":"IBAN",
          "address":"DE91 1000 0000 0123 4567 89"
        }],
        "customerOwners":[{
          "bankId":"gh.29.uk",
          "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
          "customerNumber":"5987953",
          "legalName":"Eveline Tripman",
          "dateOfBirth":"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
                                OBPv2.1.0: createTransactionRequestSandboxTan
OBPv2.1.0: createTransactionRequestCounterparty
OBPv2.1.0: createTransactionRequestSepa
OBPv2.1.0: createTransactionRequestFreeForm
OBPv3.1.0: saveHistoricalTransaction
OBPv4.0.0: createDirectDebit
OBPv4.0.0: createDirectDebitManagement
OBPv4.0.0: createStandingOrder
OBPv4.0.0: createStandingOrderManagement
OBPv4.0.0: getExplictCounterpartyById
OBPv4.0.0: getCounterpartyByIdForAnyAccount

obp.getCounterpartyTrait

                            
                                Get a Counterparty by its bankId, accountId and counterpartyId
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.1.to.adapter.mf.caseclass.OutboundGetCounterparty
                                to.obp.api.1.caseclass.OutboundGetCounterparty

                                Message
                                {
  "authInfo":{
    "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "username":"felixsmith",
    "cbsToken":"FYIUYF6SUYFSD",
    "isFirst":true,
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "linkedCustomers":[{
      "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
      "customerNumber":"5987953",
      "legalName":"Eveline Tripman"
    }],
    "userAuthContexts":[{
      "key":"CUSTOMER_NUMBER",
      "value":"5987953"
    },{
      "key":"TOKEN",
      "value":"qieuriopwoir987ASYDUFISUYDF678u"
    }],
    "authViews":[{
      "view":{
        "id":"owner",
        "name":"Owner",
        "description":"This is the owner view"
      },
      "account":{
        "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
        "accountRoutings":[{
          "scheme":"AccountNumber",
          "address":"546387432"
        },{
          "scheme":"IBAN",
          "address":"DE91 1000 0000 0123 4567 89"
        }],
        "customerOwners":[{
          "bankId":"gh.29.uk",
          "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
          "customerNumber":"5987953",
          "legalName":"Eveline Tripman",
          "dateOfBirth":"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
                                OBPv2.2.0: getExplictCounterpartyById

obp.getChallengeThreshold

                            
                                Get Challenge Threshold
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.1.to.adapter.mf.caseclass.OutboundGetChallengeThreshold
                                to.obp.api.1.caseclass.OutboundGetChallengeThreshold

                                Message
                                {
  "authInfo":{
    "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "username":"felixsmith",
    "cbsToken":"FYIUYF6SUYFSD",
    "isFirst":true,
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "linkedCustomers":[{
      "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
      "customerNumber":"5987953",
      "legalName":"Eveline Tripman"
    }],
    "userAuthContexts":[{
      "key":"CUSTOMER_NUMBER",
      "value":"5987953"
    },{
      "key":"TOKEN",
      "value":"qieuriopwoir987ASYDUFISUYDF678u"
    }],
    "authViews":[{
      "view":{
        "id":"owner",
        "name":"Owner",
        "description":"This is the owner view"
      },
      "account":{
        "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
        "accountRoutings":[{
          "scheme":"AccountNumber",
          "address":"546387432"
        },{
          "scheme":"IBAN",
          "address":"DE91 1000 0000 0123 4567 89"
        }],
        "customerOwners":[{
          "bankId":"gh.29.uk",
          "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
          "customerNumber":"5987953",
          "legalName":"Eveline Tripman",
          "dateOfBirth":"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/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.1.to.adapter.mf.caseclass.OutboundCreateTransaction
                                to.obp.api.1.caseclass.OutboundCreateTransaction

                                Message
                                {
  "authInfo":{
    "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "username":"felixsmith",
    "cbsToken":"FYIUYF6SUYFSD",
    "isFirst":true,
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "linkedCustomers":[{
      "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
      "customerNumber":"5987953",
      "legalName":"Eveline Tripman"
    }],
    "userAuthContexts":[{
      "key":"CUSTOMER_NUMBER",
      "value":"5987953"
    },{
      "key":"TOKEN",
      "value":"qieuriopwoir987ASYDUFISUYDF678u"
    }],
    "authViews":[{
      "view":{
        "id":"owner",
        "name":"Owner",
        "description":"This is the owner view"
      },
      "account":{
        "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
        "accountRoutings":[{
          "scheme":"AccountNumber",
          "address":"546387432"
        },{
          "scheme":"IBAN",
          "address":"DE91 1000 0000 0123 4567 89"
        }],
        "customerOwners":[{
          "bankId":"gh.29.uk",
          "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
          "customerNumber":"5987953",
          "legalName":"Eveline Tripman",
          "dateOfBirth":"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 Counterparty
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.1.to.adapter.mf.caseclass.OutboundCreateCounterparty
                                to.obp.api.1.caseclass.OutboundCreateCounterparty

                                Message
                                {
  "authInfo":{
    "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "username":"felixsmith",
    "cbsToken":"FYIUYF6SUYFSD",
    "isFirst":true,
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "linkedCustomers":[{
      "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
      "customerNumber":"5987953",
      "legalName":"Eveline Tripman"
    }],
    "userAuthContexts":[{
      "key":"CUSTOMER_NUMBER",
      "value":"5987953"
    },{
      "key":"TOKEN",
      "value":"qieuriopwoir987ASYDUFISUYDF678u"
    }],
    "authViews":[{
      "view":{
        "id":"owner",
        "name":"Owner",
        "description":"This is the owner view"
      },
      "account":{
        "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
        "accountRoutings":[{
          "scheme":"AccountNumber",
          "address":"546387432"
        },{
          "scheme":"IBAN",
          "address":"DE91 1000 0000 0123 4567 89"
        }],
        "customerOwners":[{
          "bankId":"gh.29.uk",
          "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
          "customerNumber":"5987953",
          "legalName":"Eveline Tripman",
          "dateOfBirth":"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 Requests
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.1.to.adapter.mf.caseclass.OutboundGetTransactionRequests210
                                to.obp.api.1.caseclass.OutboundGetTransactionRequests210

                                Message
                                {
  "authInfo":{
    "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "username":"felixsmith",
    "cbsToken":"FYIUYF6SUYFSD",
    "isFirst":true,
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "linkedCustomers":[{
      "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
      "customerNumber":"5987953",
      "legalName":"Eveline Tripman"
    }],
    "userAuthContexts":[{
      "key":"CUSTOMER_NUMBER",
      "value":"5987953"
    },{
      "key":"TOKEN",
      "value":"qieuriopwoir987ASYDUFISUYDF678u"
    }],
    "authViews":[{
      "view":{
        "id":"owner",
        "name":"Owner",
        "description":"This is the owner view"
      },
      "account":{
        "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
        "accountRoutings":[{
          "scheme":"AccountNumber",
          "address":"546387432"
        },{
          "scheme":"IBAN",
          "address":"DE91 1000 0000 0123 4567 89"
        }],
        "customerOwners":[{
          "bankId":"gh.29.uk",
          "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
          "customerNumber":"5987953",
          "legalName":"Eveline Tripman",
          "dateOfBirth":"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
                                UKv2.0: getAccountTransactions
UKv3.1: getTransactions
STETv1.4: accountsTransactionsGet
BGv1: getAccountBalances
BGv1: getTransactionList
BGv1.3: getCardAccountTransactionList
BGv1.3: getTransactionList
: getCardAccountTransactionList
: getTransactionList
OBPv2.1.0: getTransactionRequests
OBPv3.1.0: getTransactionRequests

obp.createChallenge

                            
                                Create a Security Challenge that may be used to complete a Transaction Request.
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.1.to.adapter.mf.caseclass.OutboundCreateChallengeSept2018
                                to.obp.api.1.caseclass.OutboundCreateChallengeSept2018

                                Message
                                {
  "authInfo":{
    "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "username":"felixsmith",
    "cbsToken":"FYIUYF6SUYFSD",
    "isFirst":true,
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "linkedCustomers":[{
      "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
      "customerNumber":"5987953",
      "legalName":"Eveline Tripman"
    }],
    "userAuthContexts":[{
      "key":"CUSTOMER_NUMBER",
      "value":"5987953"
    },{
      "key":"TOKEN",
      "value":"qieuriopwoir987ASYDUFISUYDF678u"
    }],
    "authViews":[{
      "view":{
        "id":"owner",
        "name":"Owner",
        "description":"This is the owner view"
      },
      "account":{
        "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
        "accountRoutings":[{
          "scheme":"AccountNumber",
          "address":"546387432"
        },{
          "scheme":"IBAN",
          "address":"DE91 1000 0000 0123 4567 89"
        }],
        "customerOwners":[{
          "bankId":"gh.29.uk",
          "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
          "customerNumber":"5987953",
          "legalName":"Eveline Tripman",
          "dateOfBirth":"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/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.1.to.adapter.mf.caseclass.OutboundGetTransactions
                                to.obp.api.1.caseclass.OutboundGetTransactions

                                Message
                                {
  "authInfo":{
    "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "username":"felixsmith",
    "cbsToken":"FYIUYF6SUYFSD",
    "isFirst":true,
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "linkedCustomers":[{
      "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
      "customerNumber":"5987953",
      "legalName":"Eveline Tripman"
    }],
    "userAuthContexts":[{
      "key":"CUSTOMER_NUMBER",
      "value":"5987953"
    },{
      "key":"TOKEN",
      "value":"qieuriopwoir987ASYDUFISUYDF678u"
    }],
    "authViews":[{
      "view":{
        "id":"owner",
        "name":"Owner",
        "description":"This is the owner view"
      },
      "account":{
        "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
        "accountRoutings":[{
          "scheme":"AccountNumber",
          "address":"546387432"
        },{
          "scheme":"IBAN",
          "address":"DE91 1000 0000 0123 4567 89"
        }],
        "customerOwners":[{
          "bankId":"gh.29.uk",
          "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
          "customerNumber":"5987953",
          "legalName":"Eveline Tripman",
          "dateOfBirth":"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
                                UKv3.1: getAccountsAccountIdTransactions
BGv1.3: getCardAccountTransactionList
BGv1.3: getTransactionList
: getCardAccountTransactionList
: getTransactionList
OBPv3.0.0: getTransactionsForBankAccount

obp.getTransaction

                            
                                Get a single Transaction specified by bankId, accountId and transactionId
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.1.to.adapter.mf.caseclass.OutboundGetTransaction
                                to.obp.api.1.caseclass.OutboundGetTransaction

                                Message
                                {
  "authInfo":{
    "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "username":"felixsmith",
    "cbsToken":"FYIUYF6SUYFSD",
    "isFirst":true,
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "linkedCustomers":[{
      "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
      "customerNumber":"5987953",
      "legalName":"Eveline Tripman"
    }],
    "userAuthContexts":[{
      "key":"CUSTOMER_NUMBER",
      "value":"5987953"
    },{
      "key":"TOKEN",
      "value":"qieuriopwoir987ASYDUFISUYDF678u"
    }],
    "authViews":[{
      "view":{
        "id":"owner",
        "name":"Owner",
        "description":"This is the owner view"
      },
      "account":{
        "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
        "accountRoutings":[{
          "scheme":"AccountNumber",
          "address":"546387432"
        },{
          "scheme":"IBAN",
          "address":"DE91 1000 0000 0123 4567 89"
        }],
        "customerOwners":[{
          "bankId":"gh.29.uk",
          "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
          "customerNumber":"5987953",
          "legalName":"Eveline Tripman",
          "dateOfBirth":"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
                                BGv1.3: getTransactionDetails
: getTransactionDetails
OBPv1.2.1: getOtherAccountForTransaction
OBPv3.1.0: getTransactionByIdForBankAccount
OBPv4.0.0: getDoubleEntryTransaction
OBPv4.0.0: createTransactionAttribute
OBPv4.0.0: updateTransactionAttribute
OBPv4.0.0: getTransactionAttributes
OBPv4.0.0: getTransactionAttributeById
OBPv4.0.0: deleteTransactionCascade

obp.getUser

                            
                                Gets the User as identifiedgetAdapterInfo by the the credentials (username and password) supplied.
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.1.to.adapter.mf.caseclass.OutboundGetUserByUsernamePassword
                                to.obp.api.1.caseclass.OutboundGetUserByUsernamePassword

                                Message
                                {
  "authInfo":{
    "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "username":"felixsmith",
    "cbsToken":"FYIUYF6SUYFSD",
    "isFirst":true,
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "linkedCustomers":[{
      "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
      "customerNumber":"5987953",
      "legalName":"Eveline Tripman"
    }],
    "userAuthContexts":[{
      "key":"CUSTOMER_NUMBER",
      "value":"5987953"
    },{
      "key":"TOKEN",
      "value":"qieuriopwoir987ASYDUFISUYDF678u"
    }],
    "authViews":[{
      "view":{
        "id":"owner",
        "name":"Owner",
        "description":"This is the owner view"
      },
      "account":{
        "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
        "accountRoutings":[{
          "scheme":"AccountNumber",
          "address":"546387432"
        },{
          "scheme":"IBAN",
          "address":"DE91 1000 0000 0123 4567 89"
        }],
        "customerOwners":[{
          "bankId":"gh.29.uk",
          "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
          "customerNumber":"5987953",
          "legalName":"Eveline Tripman",
          "dateOfBirth":"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