API Explorer

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.b228f986-118d-49d6-9cf7-b4a201b89abb.to.adapter.mf.caseclass.OutboundGetAdapterInfo
                                to.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.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

obp.createBankAccount

                            
                                Create Bank Account
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.to.adapter.mf.caseclass.OutBoundCreateBankAccount
                                from.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.to.adapter.mf.caseclass.OutBoundCreateBankAccount

                                Message
                                {
  "outboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "consumerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }],
    "outboundAdapterAuthInfo":{
      "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
      "username":"felixsmith",
      "linkedCustomers":[{
        "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
        "customerNumber":"5987953",
        "legalName":"Eveline Tripman"
      }],
      "userAuthContext":[{
        "key":"CustomerNumber",
        "value":"5987953"
      }],
      "authViews":[{
        "view":{
          "id":"owner",
          "name":"owner",
          "description":"This view is for the owner for the account."
        },
        "account":{
          "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
          "accountRoutings":[{
            "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":"2018-03-09T00:00:00Z"
          }],
          "userOwners":[{
            "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
            "emailAddress":"felixsmith@example.com",
            "name":"felixsmith"
          }]
        }
      }]
    },
    "outboundAdapterConsenterInfo":{
      "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
      "username":"felixsmith",
      "linkedCustomers":[{
        "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
        "customerNumber":"5987953",
        "legalName":"Eveline Tripman"
      }],
      "userAuthContext":[{
        "key":"CustomerNumber",
        "value":"5987953"
      }],
      "authViews":[{
        "view":{
          "id":"owner",
          "name":"owner",
          "description":"This view is for the owner for the account."
        },
        "account":{
          "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
          "accountRoutings":[{
            "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":"2018-03-09T00:00:00Z"
          }],
          "userOwners":[{
            "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
            "emailAddress":"felixsmith@example.com",
            "name":"felixsmith"
          }]
        }
      }]
    }
  },
  "bankId":{
    "value":"gh.29.uk"
  },
  "accountId":{
    "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
  },
  "accountType":"AC",
  "accountLabel":"string",
  "currency":"EUR",
  "initialBalance":"123.321",
  "accountHolderName":"string",
  "branchId":"DERBY6",
  "accountRoutings":[{
    "scheme":"IBAN",
    "address":"DE91 1000 0000 0123 4567 89"
  }]
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"",
      "status":"",
      "errorCode":"",
      "text":"",
      "duration":"5.123"
    }]
  },
  "data":{
    "accountId":{
      "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
    },
    "accountType":"AC",
    "balance":"10",
    "currency":"EUR",
    "name":"bankAccount name string",
    "number":"bankAccount number string",
    "bankId":{
      "value":"gh.29.uk"
    },
    "lastUpdate":"2018-03-09T00:00:00Z",
    "branchId":"DERBY6",
    "accountRoutings":[{
      "scheme":"IBAN",
      "address":"DE91 1000 0000 0123 4567 89"
    }],
    "attributes":[{
      "name":"STATUS",
      "type":"STRING",
      "value":"closed"
    }]
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints

obp.getBanks

                            
                                Gets the banks list on this OBP installation.
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.to.adapter.mf.caseclass.OutboundGetBanks
                                to.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.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

obp.getBank

                            
                                Get a specific Bank as specified by bankId
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.to.adapter.mf.caseclass.OutboundGetBank
                                to.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.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

obp.createMessage

                            
                                Create Message
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.to.adapter.mf.caseclass.OutBoundCreateMessage
                                to.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.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-21T09:14:44Z"
          }],
          "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-21T09:14:44Z",
    "message":"string",
    "fromDepartment":"string",
    "fromPerson":"string"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints

obp.createOrUpdateKycCheck

                            
                                Create Or Update Kyc Check
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.to.adapter.mf.caseclass.OutBoundCreateOrUpdateKycCheck
                                to.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.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-21T09:14:44Z"
          }],
          "userOwners":[{
            "userId":"string",
            "emailAddress":"string",
            "name":"string"
          }]
        }
      }]
    }
  },
  "bankId":"string",
  "customerId":"string",
  "id":"string",
  "customerNumber":"string",
  "date":"2024-11-21T09:14:44Z",
  "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-21T09:14:44Z",
    "how":"string",
    "staffUserId":"string",
    "staffName":"string",
    "satisfied":true,
    "comments":"string"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints

obp.createOrUpdateKycDocument

                            
                                Create Or Update KYC Document
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.to.adapter.mf.caseclass.OutBoundCreateOrUpdateKycDocument
                                to.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.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-21T09:14:44Z"
          }],
          "userOwners":[{
            "userId":"string",
            "emailAddress":"string",
            "name":"string"
          }]
        }
      }]
    }
  },
  "bankId":"string",
  "customerId":"string",
  "id":"string",
  "customerNumber":"string",
  "type":"string",
  "number":"string",
  "issueDate":"2024-11-21T09:14:44Z",
  "issuePlace":"string",
  "expiryDate":"2024-11-21T09:14:44Z"
}
                                {
  "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-21T09:14:44Z",
    "issuePlace":"string",
    "expiryDate":"2024-11-21T09:14:44Z"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints

obp.createOrUpdateKycMedia

                            
                                Create Or Update KYC Media
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.to.adapter.mf.caseclass.OutBoundCreateOrUpdateKycMedia
                                to.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.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-21T09:14:44Z"
          }],
          "userOwners":[{
            "userId":"string",
            "emailAddress":"string",
            "name":"string"
          }]
        }
      }]
    }
  },
  "bankId":"string",
  "customerId":"string",
  "id":"string",
  "customerNumber":"string",
  "type":"string",
  "url":"string",
  "date":"2024-11-21T09:14:44Z",
  "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-21T09:14:44Z",
    "relatesToKycDocumentId":"string",
    "relatesToKycCheckId":"string"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints

obp.createOrUpdateKycStatus

                            
                                Create Or Update KYC Status
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.to.adapter.mf.caseclass.OutBoundCreateOrUpdateKycStatus
                                to.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.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-21T09:14:44Z"
          }],
          "userOwners":[{
            "userId":"string",
            "emailAddress":"string",
            "name":"string"
          }]
        }
      }]
    }
  },
  "bankId":"string",
  "customerId":"string",
  "customerNumber":"string",
  "ok":true,
  "date":"2024-11-21T09:14:44Z"
}
                                {
  "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-21T09:14:44Z"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints

obp.getKycDocuments

                            
                                Get KYC Documents
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.to.adapter.mf.caseclass.OutBoundGetKycDocuments
                                to.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.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-21T09:14:44Z"
          }],
          "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-21T09:14:44Z",
    "issuePlace":"string",
    "expiryDate":"2024-11-21T09:14:44Z"
  }]
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints

obp.getKycMedias

                            
                                Get KYC Medias
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.to.adapter.mf.caseclass.OutBoundGetKycMedias
                                to.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.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-21T09:14:44Z"
          }],
          "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-21T09:14:44Z",
    "relatesToKycDocumentId":"string",
    "relatesToKycCheckId":"string"
  }]
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints

obp.getKycStatuses

                            
                                Get KYC Statuses
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.to.adapter.mf.caseclass.OutBoundGetKycStatuses
                                to.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.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-21T09:14:44Z"
          }],
          "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-21T09:14:44Z"
  }]
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints

obp.getKycChecks

                            
                                Get KYC Checks
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.to.adapter.mf.caseclass.OutBoundGetKycChecks
                                to.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.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-21T09:14:44Z"
          }],
          "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-21T09:14:44Z",
    "how":"string",
    "staffUserId":"string",
    "staffName":"string",
    "satisfied":true,
    "comments":"string"
  }]
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints

obp.createMeeting

                            
                                Create Meeting
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.to.adapter.mf.caseclass.OutBoundCreateMeeting
                                from.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.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-21T09:14:44Z"
          }],
          "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-21T09:14:44Z",
  "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-21T09:14:44Z",
    "creator":{
      "name":"string",
      "phone":"string",
      "email":"string"
    },
    "invitees":[{
      "contactDetails":{
        "name":"string",
        "phone":"string",
        "email":"string"
      },
      "status":"string"
    }]
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints

obp.getBankAccountsHeld

                            
                                Get Accounts held by the current User if even the User has not been assigned the owner View yet.
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.to.adapter.mf.caseclass.OutboundGetBankAccountsHeld
                                to.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.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

obp.getCoreBankAccounts

                            
                                Get bank Accounts available to the User (without Metadata)
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.to.adapter.mf.caseclass.OutboundGetCoreBankAccounts
                                to.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.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

obp.checkBankAccountExists

                            
                                Check a bank Account exists - as specified by bankId and accountId.
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.to.adapter.mf.caseclass.OutboundCheckBankAccountExists
                                to.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.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

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.b228f986-118d-49d6-9cf7-b4a201b89abb.to.adapter.mf.caseclass.OutboundGetAccounts
                                to.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.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

obp.getBankAccount

                            
                                Get a single Account as specified by the bankId and accountId.
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.to.adapter.mf.caseclass.OutboundGetAccountbyAccountID
                                to.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.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.b228f986-118d-49d6-9cf7-b4a201b89abb.to.adapter.mf.caseclass.OutboundGetCustomersByUserId
                                to.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.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.getCheckbookOrdersFuture

                            
                                Get the status of CheckbookOrders for an Account.
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.to.adapter.mf.caseclass.OutboundGetCheckbookOrderStatus
                                to.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.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.b228f986-118d-49d6-9cf7-b4a201b89abb.to.adapter.mf.caseclass.OutboundGetCreditCardOrderStatus
                                to.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.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.b228f986-118d-49d6-9cf7-b4a201b89abb.to.adapter.mf.caseclass.OutboundGetBranches
                                to.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.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

obp.getBranch

                            
                                Get a Branch as specified by bankId and branchId
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.to.adapter.mf.caseclass.OutboundGetBranch
                                to.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.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

obp.getAtms

                            
                                Get ATMs for a bank specified by bankId
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.to.adapter.mf.caseclass.OutboundGetAtms
                                to.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.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

obp.getAtm

                            
                                Get an ATM as specified by bankId and atmId.
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.to.adapter.mf.caseclass.OutboundGetAtm
                                to.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.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

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.b228f986-118d-49d6-9cf7-b4a201b89abb.to.adapter.mf.caseclass.OutboundGetCounterparties
                                to.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.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

obp.getCounterpartyByCounterpartyId

                            
                                Get a Counterparty by its counterpartyId.
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.to.adapter.mf.caseclass.OutboundGetCounterpartyByCounterpartyId
                                to.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.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

obp.getCounterpartyTrait

                            
                                Get a Counterparty by its bankId, accountId and counterpartyId
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.to.adapter.mf.caseclass.OutboundGetCounterparty
                                to.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.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

obp.getChallengeThreshold

                            
                                Get Challenge Threshold
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.to.adapter.mf.caseclass.OutboundGetChallengeThreshold
                                to.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.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.b228f986-118d-49d6-9cf7-b4a201b89abb.to.adapter.mf.caseclass.OutboundCreateTransaction
                                to.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.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.b228f986-118d-49d6-9cf7-b4a201b89abb.to.adapter.mf.caseclass.OutboundCreateCounterparty
                                to.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.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.b228f986-118d-49d6-9cf7-b4a201b89abb.to.adapter.mf.caseclass.OutboundGetTransactionRequests210
                                to.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.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":"Description of the object. Maximum length is 2000. It can be any characters here."
    },
    "transaction_ids":"",
    "status":"COMPLETED",
    "start_date":"1100-01-01T01:01:01Z",
    "end_date":"1100-01-01T01:01:01Z",
    "challenge":{
      "id":"",
      "allowed_attempts":0,
      "challenge_type":""
    },
    "charge":{
      "summary":"",
      "value":{
        "currency":"EUR",
        "amount":"19.64"
      }
    },
    "charge_policy":"",
    "counterparty_id":{
      "value":""
    },
    "name":"name",
    "this_bank_id":{
      "value":"10"
    },
    "this_account_id":{
      "value":"1"
    },
    "this_view_id":{
      "value":""
    },
    "other_account_routing_scheme":"",
    "other_account_routing_address":"",
    "other_bank_routing_scheme":"",
    "other_bank_routing_address":"",
    "is_beneficiary":false
  }]
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints

obp.createChallenge

                            
                                Create a Security Challenge that may be used to complete a Transaction Request.
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.to.adapter.mf.caseclass.OutboundCreateChallengeSept2018
                                to.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.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.b228f986-118d-49d6-9cf7-b4a201b89abb.to.adapter.mf.caseclass.OutboundGetTransactions
                                to.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.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

obp.getTransaction

                            
                                Get a single Transaction specified by bankId, accountId and transactionId
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                from.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.to.adapter.mf.caseclass.OutboundGetTransaction
                                to.obp.api.b228f986-118d-49d6-9cf7-b4a201b89abb.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

Message Doc Index

Message Docs for Connector: kafka_vSept2018

obp.getAdapterInfo

obp.createBankAccount

obp.getBanks

obp.getBank

obp.createMessage

obp.createOrUpdateKycCheck

obp.createOrUpdateKycDocument

obp.createOrUpdateKycMedia

obp.createOrUpdateKycStatus

obp.getKycDocuments

obp.getKycMedias

obp.getKycStatuses

obp.getKycChecks

obp.createMeeting

obp.getBankAccountsHeld

obp.getCoreBankAccounts

obp.checkBankAccountExists

obp.getBankAccountsForUser

obp.getBankAccount

obp.getCustomersByUserIdFuture

obp.getCheckbookOrdersFuture

obp.getStatusOfCreditCardOrderFuture

obp.getBranches

obp.getBranch

obp.getAtms

obp.getAtm

obp.getCounterparties

obp.getCounterpartyByCounterpartyId

obp.getCounterpartyTrait

obp.getChallengeThreshold

obp.makePaymentv210

obp.createCounterparty

obp.getTransactionRequests210

obp.createChallenge

obp.getTransactions

obp.getTransaction