API Explorer

Message Doc Index

Core
Accounts
Transactions
- obp.getTransactions
- obp.getTransaction

Message Docs for Connector: akka_vDec2018

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
                                OutBoundGetAdapterInfo
                                InBoundGetAdapterInfo

                                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"
          }]
        }
      }]
    }
  }
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "errorCode":"",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }],
    "name":"felixsmith",
    "version":"",
    "git_commit":"String",
    "date":"2017-09-19T02:31:05.000Z"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.0.0: getAdapterInfoForBank
OBPv3.1.0: getAdapterInfo

obp.getChallengeThreshold

                            
                                Get Challenge Threshold
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "bankId":"gh.29.uk",
  "accountId":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
  "viewId":"owner",
  "transactionRequestType":"SEPA",
  "currency":"EUR",
  "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "username":"string"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "currency":"EUR",
    "amount":"string"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints

obp.getChargeLevel

                            
                                Get Charge Level
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "bankId":{
    "value":"gh.29.uk"
  },
  "accountId":{
    "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
  },
  "viewId":{
    "value":"owner"
  },
  "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "username":"string",
  "transactionRequestType":"SEPA",
  "currency":"EUR"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "currency":"EUR",
    "amount":"string"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints

obp.createChallenge

                            
                                Create Challenge
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "bankId":{
    "value":"gh.29.uk"
  },
  "accountId":{
    "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
  },
  "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "transactionRequestType":{
    "value":"SEPA"
  },
  "transactionRequestId":"string",
  "scaMethod":"SMS"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":"string"
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints

obp.createChallenges

                            
                                Create Challenges
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "bankId":{
    "value":"gh.29.uk"
  },
  "accountId":{
    "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
  },
  "userIds":["9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"],
  "transactionRequestType":{
    "value":"SEPA"
  },
  "transactionRequestId":"string",
  "scaMethod":"SMS"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":["string"]
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints

obp.validateChallengeAnswer

                            
                                Validate Challenge Answer
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "challengeId":"string",
  "hashOfSuppliedAnswer":"string"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":true
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv2.1.0: answerTransactionRequestChallenge
OBPv4.0.0: answerTransactionRequestChallenge

obp.getUser

                            
                                Get User
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                Message
                                {
  "name":"felixsmith",
  "password":"string"
}
                                {
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "email":"felixsmith@example.com",
    "password":"string",
    "displayName":"string"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints

obp.getBankAccountOld

                            
                                Get Bank Account Old
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                Message
                                {
  "bankId":{
    "value":"gh.29.uk"
  },
  "accountId":{
    "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
  }
}
                                {
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "accountId":{
      "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
    },
    "accountType":"AC",
    "balance":"50.89",
    "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"
    }]
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv1.2.1: updateAccountLabel
OBPv1.2.1: getViewsForBankAccount
OBPv1.2.1: createViewForBankAccount
OBPv1.2.1: updateViewForBankAccount
OBPv1.2.1: getPermissionsForBankAccount
OBPv1.2.1: getPermissionForUserForBankAccount
OBPv1.2.1: getOtherAccountsForBankAccount
OBPv1.2.1: getOtherAccountByIdForBankAccount
OBPv1.2.1: getOtherAccountMetadata
OBPv1.2.1: updateCounterpartyPublicAlias
OBPv1.2.1: deleteCounterpartyPublicAlias
OBPv1.2.1: getOtherAccountPrivateAlias
OBPv1.2.1: updateCounterpartyPrivateAlias
OBPv1.2.1: deleteCounterpartyPrivateAlias
OBPv1.2.1: updateCounterpartyMoreInfo
OBPv1.2.1: deleteCounterpartyMoreInfo
OBPv1.2.1: updateCounterpartyUrl
OBPv1.2.1: deleteCounterpartyUrl
OBPv1.2.1: updateCounterpartyImageUrl
OBPv1.2.1: deleteCounterpartyImageUrl
OBPv1.2.1: updateCounterpartyOpenCorporatesUrl
OBPv1.2.1: deleteCounterpartyOpenCorporatesUrl
OBPv1.2.1: addCounterpartyCorporateLocation
OBPv1.2.1: updateCounterpartyCorporateLocation
OBPv1.2.1: deleteCounterpartyCorporateLocation
OBPv1.2.1: addCounterpartyPhysicalLocation
OBPv1.2.1: updateCounterpartyPhysicalLocation
OBPv1.2.1: deleteCounterpartyPhysicalLocation
OBPv1.2.1: getOtherAccountForTransaction
OBPv1.4.0: getTransactionRequests
OBPv1.4.0: createTransactionRequest
OBPv1.4.0: answerTransactionRequestChallenge
OBPv2.0.0: getCoreAccountById
OBPv2.0.0: getCoreTransactionsForBankAccount
OBPv2.0.0: accountById
OBPv2.0.0: getPermissionForUserForBankAccount
OBPv2.0.0: createAccount
OBPv2.0.0: createTransactionRequest
OBPv2.0.0: answerTransactionRequestChallenge
OBPv2.0.0: getTransactionRequests
OBPv2.2.0: createViewForBankAccount
OBPv2.2.0: updateViewForBankAccount
OBPv3.0.0: getFirehoseAccountsAtOneBank
OBPv4.0.0: getFirehoseAccountsAtOneBank

obp.getBankAccountByIban

                            
                                Get Bank Account By Iban
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "iban":"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":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "accountId":{
      "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
    },
    "accountType":"AC",
    "balance":"50.89",
    "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"
    }]
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                BGv1.3: checkAvailabilityOfFunds
BGv1.3: cancelPayment
BGv1.3: initiatePayment

obp.getBankAccountByRouting

                            
                                Get Bank Account By Routing
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "bankId":{
    "value":"gh.29.uk"
  },
  "scheme":"string",
  "address":"string"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "accountId":{
      "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
    },
    "accountType":"AC",
    "balance":"50.89",
    "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"
    }]
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints

obp.getBankAccounts

                            
                                Get Bank Accounts
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "bankIdAccountIds":[{
    "bankId":{
      "value":"gh.29.uk"
    },
    "accountId":{
      "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
    }
  }]
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":[{
    "accountId":{
      "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
    },
    "accountType":"AC",
    "balance":"50.89",
    "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"
    }]
  }]
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                BGv1.3: getAccountList
BGv1.3: getCardAccounts
STETv1.4: accountsGet
UKv3.1: getAccounts
UKv3.1: getAccountsAccountId
UKv3.1: getBalances
UKv3.1: getTransactions
UKv2.0: getAccountList
UKv2.0: getAccount
UKv2.0: getBalances
OBPv2.0.0: getPrivateAccountsAtOneBank
OBPv2.0.0: corePrivateAccountsAtOneBank
OBPv2.0.0: privateAccountsAtOneBank
OBPv4.0.0: getPrivateAccountsAtOneBank

obp.getBankAccountsBalances

                            
                                Get Bank Accounts Balances
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "bankIdAccountIds":[{
    "bankId":{
      "value":"gh.29.uk"
    },
    "accountId":{
      "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
    }
  }]
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "accounts":[{
      "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
      "label":"My Account",
      "bankId":"gh.29.uk",
      "accountRoutings":[{
        "scheme":"IBAN",
        "address":"DE91 1000 0000 0123 4567 89"
      }],
      "balance":{
        "currency":"EUR",
        "amount":"50.89"
      }
    }],
    "overallBalance":{
      "currency":"EUR",
      "amount":"string"
    },
    "overallBalanceDate":"2022-06-15T14:52:03Z"
  }
}

                                Required 
Fields
                                
                                {
  
}

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

obp.getBankAccountsHeld

                            
                                Get Bank Accounts Held
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "bankIdAccountIds":[{
    "bankId":{
      "value":"gh.29.uk"
    },
    "accountId":{
      "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
    }
  }]
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":[{
    "id":"string",
    "label":"My Account",
    "bankId":"gh.29.uk",
    "number":"string",
    "accountRoutings":[{
      "scheme":"IBAN",
      "address":"DE91 1000 0000 0123 4567 89"
    }]
  }]
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.0.0: getAccountsHeld

obp.getCounterpartyTrait

                            
                                Get Counterparty Trait
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "bankId":{
    "value":"gh.29.uk"
  },
  "accountId":{
    "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
  },
  "couterpartyId":"string"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "createdByUserId":"string",
    "name":"string",
    "description":"string",
    "currency":"EUR",
    "thisBankId":"string",
    "thisAccountId":"string",
    "thisViewId":"string",
    "counterpartyId":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "otherAccountRoutingScheme":"IBAN",
    "otherAccountRoutingAddress":"DE91 1000 0000 0123 4567 89",
    "otherAccountSecondaryRoutingScheme":"string",
    "otherAccountSecondaryRoutingAddress":"string",
    "otherBankRoutingScheme":"BIC",
    "otherBankRoutingAddress":"GENODEM1GLS",
    "otherBranchRoutingScheme":"BRANCH-CODE",
    "otherBranchRoutingAddress":"DERBY6",
    "isBeneficiary":true,
    "bespoke":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv2.2.0: getExplictCounterpartyById
OBPv4.0.0: getExplictCounterpartyById

obp.getCounterpartyByCounterpartyId

                            
                                Get Counterparty By Counterparty Id
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "counterpartyId":{
    "value":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"
  }
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "createdByUserId":"string",
    "name":"string",
    "description":"string",
    "currency":"EUR",
    "thisBankId":"string",
    "thisAccountId":"string",
    "thisViewId":"string",
    "counterpartyId":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "otherAccountRoutingScheme":"IBAN",
    "otherAccountRoutingAddress":"DE91 1000 0000 0123 4567 89",
    "otherAccountSecondaryRoutingScheme":"string",
    "otherAccountSecondaryRoutingAddress":"string",
    "otherBankRoutingScheme":"BIC",
    "otherBankRoutingAddress":"GENODEM1GLS",
    "otherBranchRoutingScheme":"BRANCH-CODE",
    "otherBranchRoutingAddress":"DERBY6",
    "isBeneficiary":true,
    "bespoke":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv2.1.0: createTransactionRequestSandboxTan
OBPv2.1.0: createTransactionRequestCounterparty
OBPv2.1.0: createTransactionRequestSepa
OBPv2.1.0: createTransactionRequestFreeForm
OBPv3.1.0: saveHistoricalTransaction
OBPv4.0.0: createTransactionRequestAccount
OBPv4.0.0: createTransactionRequestAccountOtp
OBPv4.0.0: createTransactionRequestCounterparty
OBPv4.0.0: createTransactionRequestSepa
OBPv4.0.0: createTransactionRequestRefund
OBPv4.0.0: createTransactionRequestFreeForm
OBPv4.0.0: createDirectDebit
OBPv4.0.0: createDirectDebitManagement
OBPv4.0.0: createStandingOrder
OBPv4.0.0: createStandingOrderManagement

obp.getCounterpartyByIban

                            
                                Get Counterparty By Iban
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "iban":"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":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "createdByUserId":"string",
    "name":"string",
    "description":"string",
    "currency":"EUR",
    "thisBankId":"string",
    "thisAccountId":"string",
    "thisViewId":"string",
    "counterpartyId":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "otherAccountRoutingScheme":"IBAN",
    "otherAccountRoutingAddress":"DE91 1000 0000 0123 4567 89",
    "otherAccountSecondaryRoutingScheme":"string",
    "otherAccountSecondaryRoutingAddress":"string",
    "otherBankRoutingScheme":"BIC",
    "otherBankRoutingAddress":"GENODEM1GLS",
    "otherBranchRoutingScheme":"BRANCH-CODE",
    "otherBranchRoutingAddress":"DERBY6",
    "isBeneficiary":true,
    "bespoke":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv2.1.0: createTransactionRequestSandboxTan
OBPv2.1.0: createTransactionRequestCounterparty
OBPv2.1.0: createTransactionRequestSepa
OBPv2.1.0: createTransactionRequestFreeForm

obp.getCounterparties

                            
                                Get Counterparties
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "thisBankId":{
    "value":"gh.29.uk"
  },
  "thisAccountId":{
    "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
  },
  "viewId":{
    "value":"owner"
  }
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":[{
    "createdByUserId":"string",
    "name":"string",
    "description":"string",
    "currency":"EUR",
    "thisBankId":"string",
    "thisAccountId":"string",
    "thisViewId":"string",
    "counterpartyId":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "otherAccountRoutingScheme":"IBAN",
    "otherAccountRoutingAddress":"DE91 1000 0000 0123 4567 89",
    "otherAccountSecondaryRoutingScheme":"string",
    "otherAccountSecondaryRoutingAddress":"string",
    "otherBankRoutingScheme":"BIC",
    "otherBankRoutingAddress":"GENODEM1GLS",
    "otherBranchRoutingScheme":"BRANCH-CODE",
    "otherBranchRoutingAddress":"DERBY6",
    "isBeneficiary":true,
    "bespoke":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  }]
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv2.2.0: getExplictCounterpartiesForAccount
OBPv4.0.0: getExplictCounterpartiesForAccount

obp.getTransactionsCore

                            
                                Get Transactions Core
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "bankId":{
    "value":"gh.29.uk"
  },
  "accountId":{
    "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
  },
  "limit":100,
  "offset":100,
  "fromDate":"string",
  "toDate":"string"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":[{
    "id":{
      "value":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub"
    },
    "thisAccount":{
      "accountId":{
        "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
      },
      "accountType":"AC",
      "balance":"50.89",
      "currency":"EUR",
      "name":"bankAccount name string",
      "label":"My Account",
      "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"
      }],
      "accountRules":[{
        "scheme":"AccountRule scheme string",
        "value":"AccountRule value string"
      }],
      "accountHolder":"bankAccount accountHolder string"
    },
    "otherAccount":{
      "kind":"string",
      "counterpartyId":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh",
      "counterpartyName":"John Smith Ltd.",
      "thisBankId":{
        "value":"gh.29.uk"
      },
      "thisAccountId":{
        "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
      },
      "otherBankRoutingScheme":"BIC",
      "otherBankRoutingAddress":"GENODEM1GLS",
      "otherAccountRoutingScheme":"IBAN",
      "otherAccountRoutingAddress":"DE91 1000 0000 0123 4567 89",
      "otherAccountProvider":"",
      "isBeneficiary":true
    },
    "transactionType":"DEBIT",
    "amount":"123.321",
    "currency":"EUR",
    "description":"string",
    "startDate":"2022-06-15T14:52:03Z",
    "finishDate":"2022-06-15T14:52:03Z",
    "balance":"50.89"
  }]
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.0.0: getCoreTransactionsForBankAccount

obp.getPhysicalCardForBank

                            
                                Get Physical Card For Bank
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "bankId":{
    "value":"gh.29.uk"
  },
  "cardId":"36f8a9e6-c2b1-407a-8bd0-421b7119307e "
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "cardId":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ",
    "bankId":"gh.29.uk",
    "bankCardNumber":"364435172576215",
    "cardType":"Credit",
    "nameOnCard":"SusanSmith",
    "issueNumber":"1",
    "serialNumber":"1324234",
    "validFrom":"2022-06-15T14:52:03Z",
    "expires":"2022-06-15T14:52:03Z",
    "enabled":true,
    "cancelled":true,
    "onHotList":true,
    "technology":"string",
    "networks":["string"],
    "allows":["DEBIT"],
    "account":{
      "accountId":{
        "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
      },
      "accountType":"AC",
      "balance":"50.89",
      "currency":"EUR",
      "name":"bankAccount name string",
      "label":"My Account",
      "number":"546387432",
      "bankId":{
        "value":"gh.29.uk"
      },
      "lastUpdate":"2018-03-09T00:00:00Z",
      "branchId":"DERBY6",
      "accountRoutings":[{
        "scheme":"IBAN",
        "address":"DE91 1000 0000 0123 4567 89"
      }],
      "accountRules":[{
        "scheme":"AccountRule scheme string",
        "value":"AccountRule value string"
      }],
      "accountHolder":"bankAccount accountHolder string"
    },
    "replacement":{
      "requestedDate":"2022-06-15T14:52:03Z",
      "reasonRequested":"FIRST"
    },
    "pinResets":[{
      "requestedDate":"2022-06-15T14:52:03Z",
      "reasonRequested":"FORGOT"
    }],
    "collected":{
      "date":"2022-06-15T14:52:03Z"
    },
    "posted":{
      "date":"2022-06-15T14:52:03Z"
    },
    "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.1.0: updatedCardForBank
OBPv3.1.0: getCardForBank
OBPv3.1.0: createCardAttribute
OBPv3.1.0: updateCardAttribute

obp.deletePhysicalCardForBank

                            
                                Delete Physical Card For Bank
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "bankId":{
    "value":"gh.29.uk"
  },
  "cardId":"36f8a9e6-c2b1-407a-8bd0-421b7119307e "
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":true
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.1.0: deleteCardForBank

obp.getPhysicalCardsForBank

                            
                                Get Physical Cards For Bank
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "bank":{
    "bankId":{
      "value":"gh.29.uk"
    },
    "shortName":"bank shortName string",
    "fullName":"bank fullName string",
    "logoUrl":"bank logoUrl string",
    "websiteUrl":"bank websiteUrl string",
    "bankRoutingScheme":"BIC",
    "bankRoutingAddress":"GENODEM1GLS",
    "swiftBic":"bank swiftBic string",
    "nationalIdentifier":"bank nationalIdentifier string"
  },
  "user":{
    "userPrimaryKey":{
      "value":123
    },
    "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "idGivenByProvider":"string",
    "provider":"string",
    "emailAddress":"felixsmith@example.com",
    "name":"felixsmith"
  },
  "limit":100,
  "offset":100,
  "fromDate":"string",
  "toDate":"string"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":[{
    "cardId":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ",
    "bankId":"gh.29.uk",
    "bankCardNumber":"364435172576215",
    "cardType":"Credit",
    "nameOnCard":"SusanSmith",
    "issueNumber":"1",
    "serialNumber":"1324234",
    "validFrom":"2022-06-15T14:52:03Z",
    "expires":"2022-06-15T14:52:03Z",
    "enabled":true,
    "cancelled":true,
    "onHotList":true,
    "technology":"string",
    "networks":["string"],
    "allows":["DEBIT"],
    "account":{
      "accountId":{
        "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
      },
      "accountType":"AC",
      "balance":"50.89",
      "currency":"EUR",
      "name":"bankAccount name string",
      "label":"My Account",
      "number":"546387432",
      "bankId":{
        "value":"gh.29.uk"
      },
      "lastUpdate":"2018-03-09T00:00:00Z",
      "branchId":"DERBY6",
      "accountRoutings":[{
        "scheme":"IBAN",
        "address":"DE91 1000 0000 0123 4567 89"
      }],
      "accountRules":[{
        "scheme":"AccountRule scheme string",
        "value":"AccountRule value string"
      }],
      "accountHolder":"bankAccount accountHolder string"
    },
    "replacement":{
      "requestedDate":"2022-06-15T14:52:03Z",
      "reasonRequested":"FIRST"
    },
    "pinResets":[{
      "requestedDate":"2022-06-15T14:52:03Z",
      "reasonRequested":"FORGOT"
    }],
    "collected":{
      "date":"2022-06-15T14:52:03Z"
    },
    "posted":{
      "date":"2022-06-15T14:52:03Z"
    },
    "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"
  }]
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.1.0: getCardsForBank

obp.createPhysicalCard

                            
                                Create Physical Card
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "bankCardNumber":"364435172576215",
  "nameOnCard":"SusanSmith",
  "cardType":"Credit",
  "issueNumber":"1",
  "serialNumber":"1324234",
  "validFrom":"2022-06-15T14:52:03Z",
  "expires":"2022-06-15T14:52:03Z",
  "enabled":true,
  "cancelled":true,
  "onHotList":true,
  "technology":"string",
  "networks":["string"],
  "allows":["string"],
  "accountId":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
  "bankId":"gh.29.uk",
  "replacement":{
    "requestedDate":"2022-06-15T14:52:03Z",
    "reasonRequested":"FIRST"
  },
  "pinResets":[{
    "requestedDate":"2022-06-15T14:52:03Z",
    "reasonRequested":"FORGOT"
  }],
  "collected":{
    "date":"2022-06-15T14:52:03Z"
  },
  "posted":{
    "date":"2022-06-15T14:52:03Z"
  },
  "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "cardId":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ",
    "bankId":"gh.29.uk",
    "bankCardNumber":"364435172576215",
    "cardType":"Credit",
    "nameOnCard":"SusanSmith",
    "issueNumber":"1",
    "serialNumber":"1324234",
    "validFrom":"2022-06-15T14:52:03Z",
    "expires":"2022-06-15T14:52:03Z",
    "enabled":true,
    "cancelled":true,
    "onHotList":true,
    "technology":"string",
    "networks":["string"],
    "allows":["DEBIT"],
    "account":{
      "accountId":{
        "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
      },
      "accountType":"AC",
      "balance":"50.89",
      "currency":"EUR",
      "name":"bankAccount name string",
      "label":"My Account",
      "number":"546387432",
      "bankId":{
        "value":"gh.29.uk"
      },
      "lastUpdate":"2018-03-09T00:00:00Z",
      "branchId":"DERBY6",
      "accountRoutings":[{
        "scheme":"IBAN",
        "address":"DE91 1000 0000 0123 4567 89"
      }],
      "accountRules":[{
        "scheme":"AccountRule scheme string",
        "value":"AccountRule value string"
      }],
      "accountHolder":"bankAccount accountHolder string"
    },
    "replacement":{
      "requestedDate":"2022-06-15T14:52:03Z",
      "reasonRequested":"FIRST"
    },
    "pinResets":[{
      "requestedDate":"2022-06-15T14:52:03Z",
      "reasonRequested":"FORGOT"
    }],
    "collected":{
      "date":"2022-06-15T14:52:03Z"
    },
    "posted":{
      "date":"2022-06-15T14:52:03Z"
    },
    "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv2.1.0: addCardsForBank
OBPv3.1.0: addCardForBank

obp.updatePhysicalCard

                            
                                Update Physical Card
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "cardId":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ",
  "bankCardNumber":"364435172576215",
  "nameOnCard":"SusanSmith",
  "cardType":"Credit",
  "issueNumber":"1",
  "serialNumber":"1324234",
  "validFrom":"2022-06-15T14:52:03Z",
  "expires":"2022-06-15T14:52:03Z",
  "enabled":true,
  "cancelled":true,
  "onHotList":true,
  "technology":"string",
  "networks":["string"],
  "allows":["string"],
  "accountId":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
  "bankId":"gh.29.uk",
  "replacement":{
    "requestedDate":"2022-06-15T14:52:03Z",
    "reasonRequested":"FIRST"
  },
  "pinResets":[{
    "requestedDate":"2022-06-15T14:52:03Z",
    "reasonRequested":"FORGOT"
  }],
  "collected":{
    "date":"2022-06-15T14:52:03Z"
  },
  "posted":{
    "date":"2022-06-15T14:52:03Z"
  },
  "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "cardId":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ",
    "bankId":"gh.29.uk",
    "bankCardNumber":"364435172576215",
    "cardType":"Credit",
    "nameOnCard":"SusanSmith",
    "issueNumber":"1",
    "serialNumber":"1324234",
    "validFrom":"2022-06-15T14:52:03Z",
    "expires":"2022-06-15T14:52:03Z",
    "enabled":true,
    "cancelled":true,
    "onHotList":true,
    "technology":"string",
    "networks":["string"],
    "allows":["DEBIT"],
    "account":{
      "accountId":{
        "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
      },
      "accountType":"AC",
      "balance":"50.89",
      "currency":"EUR",
      "name":"bankAccount name string",
      "label":"My Account",
      "number":"546387432",
      "bankId":{
        "value":"gh.29.uk"
      },
      "lastUpdate":"2018-03-09T00:00:00Z",
      "branchId":"DERBY6",
      "accountRoutings":[{
        "scheme":"IBAN",
        "address":"DE91 1000 0000 0123 4567 89"
      }],
      "accountRules":[{
        "scheme":"AccountRule scheme string",
        "value":"AccountRule value string"
      }],
      "accountHolder":"bankAccount accountHolder string"
    },
    "replacement":{
      "requestedDate":"2022-06-15T14:52:03Z",
      "reasonRequested":"FIRST"
    },
    "pinResets":[{
      "requestedDate":"2022-06-15T14:52:03Z",
      "reasonRequested":"FORGOT"
    }],
    "collected":{
      "date":"2022-06-15T14:52:03Z"
    },
    "posted":{
      "date":"2022-06-15T14:52:03Z"
    },
    "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.1.0: updatedCardForBank

obp.makePaymentv210

                            
                                Make Paymentv210
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "fromAccount":{
    "accountId":{
      "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
    },
    "accountType":"AC",
    "balance":"50.89",
    "currency":"EUR",
    "name":"bankAccount name string",
    "label":"My Account",
    "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"
    }],
    "accountRules":[{
      "scheme":"AccountRule scheme string",
      "value":"AccountRule value string"
    }],
    "accountHolder":"bankAccount accountHolder string"
  },
  "toAccount":{
    "accountId":{
      "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
    },
    "accountType":"AC",
    "balance":"50.89",
    "currency":"EUR",
    "name":"bankAccount name string",
    "label":"My Account",
    "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"
    }],
    "accountRules":[{
      "scheme":"AccountRule scheme string",
      "value":"AccountRule value string"
    }],
    "accountHolder":"bankAccount accountHolder string"
  },
  "transactionRequestId":{
    "value":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"
  },
  "transactionRequestCommonBody":{
    "value":{
      "currency":"EUR",
      "amount":"string"
    },
    "description":"string"
  },
  "amount":"123.321",
  "description":"string",
  "transactionRequestType":{
    "value":"SEPA"
  },
  "chargePolicy":"string"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "value":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints

obp.createTransactionRequestv210

                            
                                Create Transaction Requestv210
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "initiator":{
    "userPrimaryKey":{
      "value":123
    },
    "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "idGivenByProvider":"string",
    "provider":"string",
    "emailAddress":"felixsmith@example.com",
    "name":"felixsmith"
  },
  "viewId":{
    "value":"owner"
  },
  "fromAccount":{
    "accountId":{
      "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
    },
    "accountType":"AC",
    "balance":"50.89",
    "currency":"EUR",
    "name":"bankAccount name string",
    "label":"My Account",
    "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"
    }],
    "accountRules":[{
      "scheme":"AccountRule scheme string",
      "value":"AccountRule value string"
    }],
    "accountHolder":"bankAccount accountHolder string"
  },
  "toAccount":{
    "accountId":{
      "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
    },
    "accountType":"AC",
    "balance":"50.89",
    "currency":"EUR",
    "name":"bankAccount name string",
    "label":"My Account",
    "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"
    }],
    "accountRules":[{
      "scheme":"AccountRule scheme string",
      "value":"AccountRule value string"
    }],
    "accountHolder":"bankAccount accountHolder string"
  },
  "transactionRequestType":{
    "value":"SEPA"
  },
  "transactionRequestCommonBody":{
    "value":{
      "currency":"EUR",
      "amount":"string"
    },
    "description":"string"
  },
  "detailsPlain":"string",
  "chargePolicy":"string",
  "challengeType":"string",
  "scaMethod":"SMS"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "id":{
      "value":"string"
    },
    "type":"SEPA",
    "from":{
      "bank_id":"string",
      "account_id":"string"
    },
    "body":{
      "value":{
        "currency":"EUR",
        "amount":"string"
      },
      "description":"string"
    },
    "transaction_ids":"string",
    "status":"string",
    "start_date":"2022-06-15T14:52:03Z",
    "end_date":"2022-06-15T14:52:03Z",
    "challenge":{
      "id":"string",
      "allowed_attempts":123,
      "challenge_type":"string"
    },
    "charge":{
      "summary":"string",
      "value":{
        "currency":"EUR",
        "amount":"string"
      }
    }
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv2.1.0: createTransactionRequestSandboxTan
OBPv2.1.0: createTransactionRequestCounterparty
OBPv2.1.0: createTransactionRequestSepa
OBPv2.1.0: createTransactionRequestFreeForm

obp.notifyTransactionRequest

                            
                                Notify Transaction Request
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "fromAccount":{
    "accountId":{
      "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
    },
    "accountType":"AC",
    "balance":"50.89",
    "currency":"EUR",
    "name":"bankAccount name string",
    "label":"My Account",
    "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"
    }],
    "accountRules":[{
      "scheme":"AccountRule scheme string",
      "value":"AccountRule value string"
    }],
    "accountHolder":"bankAccount accountHolder string"
  },
  "toAccount":{
    "accountId":{
      "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
    },
    "accountType":"AC",
    "balance":"50.89",
    "currency":"EUR",
    "name":"bankAccount name string",
    "label":"My Account",
    "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"
    }],
    "accountRules":[{
      "scheme":"AccountRule scheme string",
      "value":"AccountRule value string"
    }],
    "accountHolder":"bankAccount accountHolder string"
  },
  "transactionRequest":{
    "id":{
      "value":"string"
    },
    "type":"SEPA",
    "from":{
      "bank_id":"string",
      "account_id":"string"
    },
    "body":{
      "value":{
        "currency":"EUR",
        "amount":"string"
      },
      "description":"string"
    },
    "transaction_ids":"string",
    "status":"string",
    "start_date":"2022-06-15T14:52:03Z",
    "end_date":"2022-06-15T14:52:03Z",
    "challenge":{
      "id":"string",
      "allowed_attempts":123,
      "challenge_type":"string"
    },
    "charge":{
      "summary":"string",
      "value":{
        "currency":"EUR",
        "amount":"string"
      }
    }
  }
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "value":"FORWARDED"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv4.0.0: createTransactionRequestAccount
OBPv4.0.0: createTransactionRequestAccountOtp
OBPv4.0.0: createTransactionRequestCounterparty
OBPv4.0.0: createTransactionRequestSepa
OBPv4.0.0: createTransactionRequestRefund
OBPv4.0.0: createTransactionRequestFreeForm
OBPv4.0.0: answerTransactionRequestChallenge

obp.getTransactionRequests210

                            
                                Get Transaction Requests210
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "initiator":{
    "userPrimaryKey":{
      "value":123
    },
    "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "idGivenByProvider":"string",
    "provider":"string",
    "emailAddress":"felixsmith@example.com",
    "name":"felixsmith"
  },
  "fromAccount":{
    "accountId":{
      "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
    },
    "accountType":"AC",
    "balance":"50.89",
    "currency":"EUR",
    "name":"bankAccount name string",
    "label":"My Account",
    "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"
    }],
    "accountRules":[{
      "scheme":"AccountRule scheme string",
      "value":"AccountRule value string"
    }],
    "accountHolder":"bankAccount accountHolder string"
  }
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":[{
    "id":{
      "value":"string"
    },
    "type":"SEPA",
    "from":{
      "bank_id":"string",
      "account_id":"string"
    },
    "body":{
      "value":{
        "currency":"EUR",
        "amount":"string"
      },
      "description":"string"
    },
    "transaction_ids":"string",
    "status":"string",
    "start_date":"2022-06-15T14:52:03Z",
    "end_date":"2022-06-15T14:52:03Z",
    "challenge":{
      "id":"string",
      "allowed_attempts":123,
      "challenge_type":"string"
    },
    "charge":{
      "summary":"string",
      "value":{
        "currency":"EUR",
        "amount":"string"
      }
    }
  }]
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                BGv1.3: getCardAccountTransactionList
BGv1.3: getTransactionList
BGv1: getAccountBalances
BGv1: getTransactionList
STETv1.4: accountsTransactionsGet
UKv3.1: getTransactions
UKv2.0: getAccountTransactions
OBPv2.1.0: getTransactionRequests
OBPv3.1.0: getTransactionRequests

obp.getTransactionRequestImpl

                            
                                Get Transaction Request Impl
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "transactionRequestId":{
    "value":"string"
  }
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "id":{
      "value":"string"
    },
    "type":"SEPA",
    "from":{
      "bank_id":"string",
      "account_id":"string"
    },
    "body":{
      "value":{
        "currency":"EUR",
        "amount":"string"
      },
      "description":"string"
    },
    "transaction_ids":"string",
    "status":"string",
    "start_date":"2022-06-15T14:52:03Z",
    "end_date":"2022-06-15T14:52:03Z",
    "challenge":{
      "id":"string",
      "allowed_attempts":123,
      "challenge_type":"string"
    },
    "charge":{
      "summary":"string",
      "value":{
        "currency":"EUR",
        "amount":"string"
      }
    }
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv2.0.0: answerTransactionRequestChallenge

obp.createTransactionAfterChallengeV210

                            
                                Create Transaction After Challenge V210
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "fromAccount":{
    "accountId":{
      "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
    },
    "accountType":"AC",
    "balance":"50.89",
    "currency":"EUR",
    "name":"bankAccount name string",
    "label":"My Account",
    "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"
    }],
    "accountRules":[{
      "scheme":"AccountRule scheme string",
      "value":"AccountRule value string"
    }],
    "accountHolder":"bankAccount accountHolder string"
  },
  "transactionRequest":{
    "id":{
      "value":"string"
    },
    "type":"SEPA",
    "from":{
      "bank_id":"string",
      "account_id":"string"
    },
    "body":{
      "value":{
        "currency":"EUR",
        "amount":"string"
      },
      "description":"string"
    },
    "transaction_ids":"string",
    "status":"string",
    "start_date":"2022-06-15T14:52:03Z",
    "end_date":"2022-06-15T14:52:03Z",
    "challenge":{
      "id":"string",
      "allowed_attempts":123,
      "challenge_type":"string"
    },
    "charge":{
      "summary":"string",
      "value":{
        "currency":"EUR",
        "amount":"string"
      }
    }
  }
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "id":{
      "value":"string"
    },
    "type":"SEPA",
    "from":{
      "bank_id":"string",
      "account_id":"string"
    },
    "body":{
      "value":{
        "currency":"EUR",
        "amount":"string"
      },
      "description":"string"
    },
    "transaction_ids":"string",
    "status":"string",
    "start_date":"2022-06-15T14:52:03Z",
    "end_date":"2022-06-15T14:52:03Z",
    "challenge":{
      "id":"string",
      "allowed_attempts":123,
      "challenge_type":"string"
    },
    "charge":{
      "summary":"string",
      "value":{
        "currency":"EUR",
        "amount":"string"
      }
    }
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                BGv1.3: updatePaymentPsuData
OBPv2.1.0: answerTransactionRequestChallenge
OBPv4.0.0: answerTransactionRequestChallenge

obp.updateBankAccount

                            
                                Update Bank Account
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "bankId":{
    "value":"gh.29.uk"
  },
  "accountId":{
    "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
  },
  "accountType":"AC",
  "accountLabel":"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":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "accountId":{
      "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
    },
    "accountType":"AC",
    "balance":"50.89",
    "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"
    }]
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.1.0: updateAccount

obp.createBankAccount

                            
                                Create Bank Account
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "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":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "accountId":{
      "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
    },
    "accountType":"AC",
    "balance":"50.89",
    "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"
    }]
  }
}

                                Required 
Fields
                                
                                {
  
}

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

obp.accountExists

                            
                                Account Exists
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                Message
                                {
  "bankId":{
    "value":"gh.29.uk"
  },
  "accountNumber":"546387432"
}
                                {
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":true
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints

obp.getBranch

                            
                                Get Branch
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "bankId":{
    "value":"gh.29.uk"
  },
  "branchId":{
    "value":"DERBY6"
  }
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "branchId":{
      "value":"DERBY6"
    },
    "bankId":{
      "value":"gh.29.uk"
    },
    "name":"string",
    "address":{
      "line1":"string",
      "line2":"string",
      "line3":"string",
      "city":"string",
      "county":"string",
      "state":"string",
      "postCode":"string",
      "countryCode":"string"
    },
    "location":{
      "latitude":123.123,
      "longitude":123.123,
      "date":"2022-06-15T14:52:03Z",
      "user":{
        "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
        "provider":"string",
        "username":"felixsmith"
      }
    },
    "lobbyString":{
      "hours":"string"
    },
    "driveUpString":{
      "hours":"string"
    },
    "meta":{
      "license":{
        "id":"string",
        "name":"string"
      }
    },
    "branchRouting":{
      "scheme":"BRANCH-CODE",
      "address":"DERBY6"
    },
    "lobby":{
      "monday":[{
        "openingTime":"string",
        "closingTime":"string"
      }],
      "tuesday":[{
        "openingTime":"string",
        "closingTime":"string"
      }],
      "wednesday":[{
        "openingTime":"string",
        "closingTime":"string"
      }],
      "thursday":[{
        "openingTime":"string",
        "closingTime":"string"
      }],
      "friday":[{
        "openingTime":"string",
        "closingTime":"string"
      }],
      "saturday":[{
        "openingTime":"string",
        "closingTime":"string"
      }],
      "sunday":[{
        "openingTime":"string",
        "closingTime":"string"
      }]
    },
    "driveUp":{
      "monday":{
        "openingTime":"string",
        "closingTime":"string"
      },
      "tuesday":{
        "openingTime":"string",
        "closingTime":"string"
      },
      "wednesday":{
        "openingTime":"string",
        "closingTime":"string"
      },
      "thursday":{
        "openingTime":"string",
        "closingTime":"string"
      },
      "friday":{
        "openingTime":"string",
        "closingTime":"string"
      },
      "saturday":{
        "openingTime":"string",
        "closingTime":"string"
      },
      "sunday":{
        "openingTime":"string",
        "closingTime":"string"
      }
    },
    "isAccessible":true,
    "accessibleFeatures":"string",
    "branchType":"string",
    "moreInfo":"string",
    "phoneNumber":"string",
    "isDeleted":true
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.0.0: getBranch
OBPv3.1.0: deleteBranch

obp.getBranches

                            
                                Get Branches
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "bankId":{
    "value":"gh.29.uk"
  },
  "limit":100,
  "offset":100,
  "fromDate":"string",
  "toDate":"string"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":[{
    "branchId":{
      "value":"DERBY6"
    },
    "bankId":{
      "value":"gh.29.uk"
    },
    "name":"string",
    "address":{
      "line1":"string",
      "line2":"string",
      "line3":"string",
      "city":"string",
      "county":"string",
      "state":"string",
      "postCode":"string",
      "countryCode":"string"
    },
    "location":{
      "latitude":123.123,
      "longitude":123.123,
      "date":"2022-06-15T14:52:03Z",
      "user":{
        "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
        "provider":"string",
        "username":"felixsmith"
      }
    },
    "lobbyString":{
      "hours":"string"
    },
    "driveUpString":{
      "hours":"string"
    },
    "meta":{
      "license":{
        "id":"string",
        "name":"string"
      }
    },
    "branchRouting":{
      "scheme":"BRANCH-CODE",
      "address":"DERBY6"
    },
    "lobby":{
      "monday":[{
        "openingTime":"string",
        "closingTime":"string"
      }],
      "tuesday":[{
        "openingTime":"string",
        "closingTime":"string"
      }],
      "wednesday":[{
        "openingTime":"string",
        "closingTime":"string"
      }],
      "thursday":[{
        "openingTime":"string",
        "closingTime":"string"
      }],
      "friday":[{
        "openingTime":"string",
        "closingTime":"string"
      }],
      "saturday":[{
        "openingTime":"string",
        "closingTime":"string"
      }],
      "sunday":[{
        "openingTime":"string",
        "closingTime":"string"
      }]
    },
    "driveUp":{
      "monday":{
        "openingTime":"string",
        "closingTime":"string"
      },
      "tuesday":{
        "openingTime":"string",
        "closingTime":"string"
      },
      "wednesday":{
        "openingTime":"string",
        "closingTime":"string"
      },
      "thursday":{
        "openingTime":"string",
        "closingTime":"string"
      },
      "friday":{
        "openingTime":"string",
        "closingTime":"string"
      },
      "saturday":{
        "openingTime":"string",
        "closingTime":"string"
      },
      "sunday":{
        "openingTime":"string",
        "closingTime":"string"
      }
    },
    "isAccessible":true,
    "accessibleFeatures":"string",
    "branchType":"string",
    "moreInfo":"string",
    "phoneNumber":"string",
    "isDeleted":true
  }]
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.0.0: getBranches

obp.getAtm

                            
                                Get Atm
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "bankId":{
    "value":"gh.29.uk"
  },
  "atmId":{
    "value":"string"
  }
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "atmId":{
      "value":"string"
    },
    "bankId":{
      "value":"gh.29.uk"
    },
    "name":"string",
    "address":{
      "line1":"string",
      "line2":"string",
      "line3":"string",
      "city":"string",
      "county":"string",
      "state":"string",
      "postCode":"string",
      "countryCode":"string"
    },
    "location":{
      "latitude":123.123,
      "longitude":123.123,
      "date":"2022-06-15T14:52:03Z",
      "user":{
        "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
        "provider":"string",
        "username":"felixsmith"
      }
    },
    "meta":{
      "license":{
        "id":"string",
        "name":"string"
      }
    },
    "OpeningTimeOnMonday":"string",
    "ClosingTimeOnMonday":"string",
    "OpeningTimeOnTuesday":"string",
    "ClosingTimeOnTuesday":"string",
    "OpeningTimeOnWednesday":"string",
    "ClosingTimeOnWednesday":"string",
    "OpeningTimeOnThursday":"string",
    "ClosingTimeOnThursday":"string",
    "OpeningTimeOnFriday":"string",
    "ClosingTimeOnFriday":"string",
    "OpeningTimeOnSaturday":"string",
    "ClosingTimeOnSaturday":"string",
    "OpeningTimeOnSunday":"string",
    "ClosingTimeOnSunday":"string",
    "isAccessible":true,
    "locatedAt":"string",
    "moreInfo":"string",
    "hasDepositCapability":true
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.0.0: getAtm

obp.getAtms

                            
                                Get Atms
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "bankId":{
    "value":"gh.29.uk"
  },
  "limit":100,
  "offset":100,
  "fromDate":"string",
  "toDate":"string"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":[{
    "atmId":{
      "value":"string"
    },
    "bankId":{
      "value":"gh.29.uk"
    },
    "name":"string",
    "address":{
      "line1":"string",
      "line2":"string",
      "line3":"string",
      "city":"string",
      "county":"string",
      "state":"string",
      "postCode":"string",
      "countryCode":"string"
    },
    "location":{
      "latitude":123.123,
      "longitude":123.123,
      "date":"2022-06-15T14:52:03Z",
      "user":{
        "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
        "provider":"string",
        "username":"felixsmith"
      }
    },
    "meta":{
      "license":{
        "id":"string",
        "name":"string"
      }
    },
    "OpeningTimeOnMonday":"string",
    "ClosingTimeOnMonday":"string",
    "OpeningTimeOnTuesday":"string",
    "ClosingTimeOnTuesday":"string",
    "OpeningTimeOnWednesday":"string",
    "ClosingTimeOnWednesday":"string",
    "OpeningTimeOnThursday":"string",
    "ClosingTimeOnThursday":"string",
    "OpeningTimeOnFriday":"string",
    "ClosingTimeOnFriday":"string",
    "OpeningTimeOnSaturday":"string",
    "ClosingTimeOnSaturday":"string",
    "OpeningTimeOnSunday":"string",
    "ClosingTimeOnSunday":"string",
    "isAccessible":true,
    "locatedAt":"string",
    "moreInfo":"string",
    "hasDepositCapability":true
  }]
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.0.0: getAtms

obp.createTransactionAfterChallengev300

                            
                                Create Transaction After Challengev300
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "initiator":{
    "userPrimaryKey":{
      "value":123
    },
    "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "idGivenByProvider":"string",
    "provider":"string",
    "emailAddress":"felixsmith@example.com",
    "name":"felixsmith"
  },
  "fromAccount":{
    "accountId":{
      "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
    },
    "accountType":"AC",
    "balance":"50.89",
    "currency":"EUR",
    "name":"bankAccount name string",
    "label":"My Account",
    "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"
    }],
    "accountRules":[{
      "scheme":"AccountRule scheme string",
      "value":"AccountRule value string"
    }],
    "accountHolder":"bankAccount accountHolder string"
  },
  "transReqId":{
    "value":"string"
  },
  "transactionRequestType":{
    "value":"SEPA"
  }
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "id":{
      "value":"string"
    },
    "type":"SEPA",
    "from":{
      "bank_id":"string",
      "account_id":"string"
    },
    "body":{
      "value":{
        "currency":"EUR",
        "amount":"string"
      },
      "description":"string"
    },
    "transaction_ids":"string",
    "status":"string",
    "start_date":"2022-06-15T14:52:03Z",
    "end_date":"2022-06-15T14:52:03Z",
    "challenge":{
      "id":"string",
      "allowed_attempts":123,
      "challenge_type":"string"
    },
    "charge":{
      "summary":"string",
      "value":{
        "currency":"EUR",
        "amount":"string"
      }
    }
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv2.1.0: answerTransactionRequestChallenge
OBPv4.0.0: answerTransactionRequestChallenge

obp.makePaymentv300

                            
                                Make Paymentv300
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "initiator":{
    "userPrimaryKey":{
      "value":123
    },
    "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "idGivenByProvider":"string",
    "provider":"string",
    "emailAddress":"felixsmith@example.com",
    "name":"felixsmith"
  },
  "fromAccount":{
    "accountId":{
      "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
    },
    "accountType":"AC",
    "balance":"50.89",
    "currency":"EUR",
    "name":"bankAccount name string",
    "label":"My Account",
    "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"
    }],
    "accountRules":[{
      "scheme":"AccountRule scheme string",
      "value":"AccountRule value string"
    }],
    "accountHolder":"bankAccount accountHolder string"
  },
  "toAccount":{
    "accountId":{
      "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
    },
    "accountType":"AC",
    "balance":"50.89",
    "currency":"EUR",
    "name":"bankAccount name string",
    "label":"My Account",
    "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"
    }],
    "accountRules":[{
      "scheme":"AccountRule scheme string",
      "value":"AccountRule value string"
    }],
    "accountHolder":"bankAccount accountHolder string"
  },
  "toCounterparty":{
    "createdByUserId":"string",
    "name":"string",
    "description":"string",
    "currency":"EUR",
    "thisBankId":"string",
    "thisAccountId":"string",
    "thisViewId":"string",
    "counterpartyId":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "otherAccountRoutingScheme":"IBAN",
    "otherAccountRoutingAddress":"DE91 1000 0000 0123 4567 89",
    "otherAccountSecondaryRoutingScheme":"string",
    "otherAccountSecondaryRoutingAddress":"string",
    "otherBankRoutingScheme":"BIC",
    "otherBankRoutingAddress":"GENODEM1GLS",
    "otherBranchRoutingScheme":"BRANCH-CODE",
    "otherBranchRoutingAddress":"DERBY6",
    "isBeneficiary":true,
    "bespoke":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "transactionRequestCommonBody":{
    "value":{
      "currency":"EUR",
      "amount":"string"
    },
    "description":"string"
  },
  "transactionRequestType":{
    "value":"SEPA"
  },
  "chargePolicy":"string"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "value":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints

obp.makePaymentV400

                            
                                Make Payment V400
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "transactionRequest":{
    "id":{
      "value":"8138a7e4-6d02-40e3-a129-0b2bf89de9f1"
    },
    "type":"SEPA",
    "from":{
      "bank_id":"gh.29.uk",
      "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
    },
    "body":{
      "value":{
        "currency":"EUR",
        "amount":"10.12"
      },
      "description":"no-example-provided"
    },
    "transaction_ids":"string",
    "status":"no-example-provided",
    "start_date":"2019-09-07T00:00:00Z",
    "end_date":"2019-09-08T00:00:00Z",
    "challenge":{
      "id":"123chaneid13-6d02-40e3-a129-0b2bf89de9f0",
      "allowed_attempts":123,
      "challenge_type":"string"
    },
    "charge":{
      "summary":"no-example-provided",
      "value":{
        "currency":"EUR",
        "amount":"10.12"
      }
    }
  },
  "reasons":[{
    "code":"no-example-provided",
    "documentNumber":"no-example-provided",
    "amount":"10.12",
    "currency":"EUR",
    "description":"no-example-provided"
  }]
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "value":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints

obp.createTransactionRequestv300

                            
                                Create Transaction Requestv300
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "initiator":{
    "userPrimaryKey":{
      "value":123
    },
    "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "idGivenByProvider":"string",
    "provider":"string",
    "emailAddress":"felixsmith@example.com",
    "name":"felixsmith"
  },
  "viewId":{
    "value":"owner"
  },
  "fromAccount":{
    "accountId":{
      "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
    },
    "accountType":"AC",
    "balance":"50.89",
    "currency":"EUR",
    "name":"bankAccount name string",
    "label":"My Account",
    "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"
    }],
    "accountRules":[{
      "scheme":"AccountRule scheme string",
      "value":"AccountRule value string"
    }],
    "accountHolder":"bankAccount accountHolder string"
  },
  "toAccount":{
    "accountId":{
      "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
    },
    "accountType":"AC",
    "balance":"50.89",
    "currency":"EUR",
    "name":"bankAccount name string",
    "label":"My Account",
    "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"
    }],
    "accountRules":[{
      "scheme":"AccountRule scheme string",
      "value":"AccountRule value string"
    }],
    "accountHolder":"bankAccount accountHolder string"
  },
  "toCounterparty":{
    "createdByUserId":"string",
    "name":"string",
    "description":"string",
    "currency":"EUR",
    "thisBankId":"string",
    "thisAccountId":"string",
    "thisViewId":"string",
    "counterpartyId":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "otherAccountRoutingScheme":"IBAN",
    "otherAccountRoutingAddress":"DE91 1000 0000 0123 4567 89",
    "otherAccountSecondaryRoutingScheme":"string",
    "otherAccountSecondaryRoutingAddress":"string",
    "otherBankRoutingScheme":"BIC",
    "otherBankRoutingAddress":"GENODEM1GLS",
    "otherBranchRoutingScheme":"BRANCH-CODE",
    "otherBranchRoutingAddress":"DERBY6",
    "isBeneficiary":true,
    "bespoke":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "transactionRequestType":{
    "value":"SEPA"
  },
  "transactionRequestCommonBody":{
    "value":{
      "currency":"EUR",
      "amount":"string"
    },
    "description":"string"
  },
  "detailsPlain":"string",
  "chargePolicy":"string"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "id":{
      "value":"string"
    },
    "type":"SEPA",
    "from":{
      "bank_id":"string",
      "account_id":"string"
    },
    "body":{
      "value":{
        "currency":"EUR",
        "amount":"string"
      },
      "description":"string"
    },
    "transaction_ids":"string",
    "status":"string",
    "start_date":"2022-06-15T14:52:03Z",
    "end_date":"2022-06-15T14:52:03Z",
    "challenge":{
      "id":"string",
      "allowed_attempts":123,
      "challenge_type":"string"
    },
    "charge":{
      "summary":"string",
      "value":{
        "currency":"EUR",
        "amount":"string"
      }
    }
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints

obp.createCounterparty

                            
                                Create Counterparty
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "name":"string",
  "description":"string",
  "currency":"EUR",
  "createdByUserId":"string",
  "thisBankId":"string",
  "thisAccountId":"string",
  "thisViewId":"string",
  "otherAccountRoutingScheme":"IBAN",
  "otherAccountRoutingAddress":"DE91 1000 0000 0123 4567 89",
  "otherAccountSecondaryRoutingScheme":"string",
  "otherAccountSecondaryRoutingAddress":"string",
  "otherBankRoutingScheme":"BIC",
  "otherBankRoutingAddress":"GENODEM1GLS",
  "otherBranchRoutingScheme":"BRANCH-CODE",
  "otherBranchRoutingAddress":"DERBY6",
  "isBeneficiary":true,
  "bespoke":[{
    "key":"CustomerNumber",
    "value":"5987953"
  }]
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "createdByUserId":"string",
    "name":"string",
    "description":"string",
    "currency":"EUR",
    "thisBankId":"string",
    "thisAccountId":"string",
    "thisViewId":"string",
    "counterpartyId":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "otherAccountRoutingScheme":"IBAN",
    "otherAccountRoutingAddress":"DE91 1000 0000 0123 4567 89",
    "otherAccountSecondaryRoutingScheme":"string",
    "otherAccountSecondaryRoutingAddress":"string",
    "otherBankRoutingScheme":"BIC",
    "otherBankRoutingAddress":"GENODEM1GLS",
    "otherBranchRoutingScheme":"BRANCH-CODE",
    "otherBranchRoutingAddress":"DERBY6",
    "isBeneficiary":true,
    "bespoke":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints

obp.checkCustomerNumberAvailable

                            
                                Check Customer Number Available
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "bankId":{
    "value":"gh.29.uk"
  },
  "customerNumber":"5987953"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":true
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.1.0: updateCustomerNumber

obp.createCustomer

                            
                                Create Customer
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "bankId":{
    "value":"gh.29.uk"
  },
  "legalName":"Eveline Tripman",
  "mobileNumber":"+44 07972 444 876",
  "email":"felixsmith@example.com",
  "faceImage":{
    "date":"2019-09-08T00:00:00Z",
    "url":"http://www.example.com/id-docs/123/image.png"
  },
  "dateOfBirth":"2018-03-09T00:00:00Z",
  "relationshipStatus":"single",
  "dependents":1,
  "dobOfDependents":["2019-09-08T00:00:00Z","2019-01-03T00:00:00Z"],
  "highestEducationAttained":"Master",
  "employmentStatus":"worker",
  "kycStatus":true,
  "lastOkDate":"2019-09-12T00:00:00Z",
  "creditRating":{
    "rating":"",
    "source":""
  },
  "creditLimit":{
    "currency":"EUR",
    "amount":"1000.00"
  },
  "title":"Dr.",
  "branchId":"DERBY6",
  "nameSuffix":"Sr"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "bankId":"gh.29.uk",
    "number":"5987953",
    "legalName":"Eveline Tripman",
    "mobileNumber":"+44 07972 444 876",
    "email":"felixsmith@example.com",
    "faceImage":{
      "date":"2019-09-08T00:00:00Z",
      "url":"http://www.example.com/id-docs/123/image.png"
    },
    "dateOfBirth":"2018-03-09T00:00:00Z",
    "relationshipStatus":"single",
    "dependents":1,
    "dobOfDependents":["2019-09-08T00:00:00Z","2019-01-03T00:00:00Z"],
    "highestEducationAttained":"Master",
    "employmentStatus":"worker",
    "creditRating":{
      "rating":"",
      "source":""
    },
    "creditLimit":{
      "currency":"EUR",
      "amount":"1000.00"
    },
    "kycStatus":true,
    "lastOkDate":"2019-09-08T00:00:00Z",
    "title":"title of customer",
    "branchId":"DERBY6",
    "nameSuffix":"Sr"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.1.0: createCustomer

obp.updateCustomerScaData

                            
                                Update Customer Sca Data
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "mobileNumber":"+44 07972 444 876",
  "email":"felixsmith@example.com",
  "customerNumber":"5987953"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "bankId":"gh.29.uk",
    "number":"5987953",
    "legalName":"Eveline Tripman",
    "mobileNumber":"+44 07972 444 876",
    "email":"felixsmith@example.com",
    "faceImage":{
      "date":"2019-09-08T00:00:00Z",
      "url":"http://www.example.com/id-docs/123/image.png"
    },
    "dateOfBirth":"2018-03-09T00:00:00Z",
    "relationshipStatus":"single",
    "dependents":1,
    "dobOfDependents":["2019-09-08T00:00:00Z","2019-01-03T00:00:00Z"],
    "highestEducationAttained":"Master",
    "employmentStatus":"worker",
    "creditRating":{
      "rating":"",
      "source":""
    },
    "creditLimit":{
      "currency":"EUR",
      "amount":"1000.00"
    },
    "kycStatus":true,
    "lastOkDate":"2019-09-08T00:00:00Z",
    "title":"title of customer",
    "branchId":"DERBY6",
    "nameSuffix":"Sr"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.1.0: updateCustomerEmail
OBPv3.1.0: updateCustomerNumber
OBPv3.1.0: updateCustomerMobileNumber

obp.updateCustomerCreditData

                            
                                Update Customer Credit Data
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "creditRating":"string",
  "creditSource":"string",
  "creditLimit":{
    "currency":"EUR",
    "amount":"1000.00"
  }
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "bankId":"gh.29.uk",
    "number":"5987953",
    "legalName":"Eveline Tripman",
    "mobileNumber":"+44 07972 444 876",
    "email":"felixsmith@example.com",
    "faceImage":{
      "date":"2019-09-08T00:00:00Z",
      "url":"http://www.example.com/id-docs/123/image.png"
    },
    "dateOfBirth":"2018-03-09T00:00:00Z",
    "relationshipStatus":"single",
    "dependents":1,
    "dobOfDependents":["2019-09-08T00:00:00Z","2019-01-03T00:00:00Z"],
    "highestEducationAttained":"Master",
    "employmentStatus":"worker",
    "creditRating":{
      "rating":"",
      "source":""
    },
    "creditLimit":{
      "currency":"EUR",
      "amount":"1000.00"
    },
    "kycStatus":true,
    "lastOkDate":"2019-09-08T00:00:00Z",
    "title":"title of customer",
    "branchId":"DERBY6",
    "nameSuffix":"Sr"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.1.0: updateCustomerCreditLimit
OBPv3.1.0: updateCustomerCreditRatingAndSource

obp.updateCustomerGeneralData

                            
                                Update Customer General Data
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "legalName":"Eveline Tripman",
  "faceImage":{
    "date":"2022-06-15T14:52:03Z",
    "url":"http://www.example.com/id-docs/123/image.png"
  },
  "dateOfBirth":"2018-03-09T00:00:00Z",
  "relationshipStatus":"single",
  "dependents":1,
  "highestEducationAttained":"Master",
  "employmentStatus":"worker",
  "title":"Dr.",
  "branchId":"DERBY6",
  "nameSuffix":"Sr"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "bankId":"gh.29.uk",
    "number":"5987953",
    "legalName":"Eveline Tripman",
    "mobileNumber":"+44 07972 444 876",
    "email":"felixsmith@example.com",
    "faceImage":{
      "date":"2019-09-08T00:00:00Z",
      "url":"http://www.example.com/id-docs/123/image.png"
    },
    "dateOfBirth":"2018-03-09T00:00:00Z",
    "relationshipStatus":"single",
    "dependents":1,
    "dobOfDependents":["2019-09-08T00:00:00Z","2019-01-03T00:00:00Z"],
    "highestEducationAttained":"Master",
    "employmentStatus":"worker",
    "creditRating":{
      "rating":"",
      "source":""
    },
    "creditLimit":{
      "currency":"EUR",
      "amount":"1000.00"
    },
    "kycStatus":true,
    "lastOkDate":"2019-09-08T00:00:00Z",
    "title":"title of customer",
    "branchId":"DERBY6",
    "nameSuffix":"Sr"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.1.0: updateCustomerIdentity
OBPv3.1.0: updateCustomerBranch
OBPv3.1.0: updateCustomerData

obp.getCustomerByCustomerId

                            
                                Get Customer By Customer Id
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "bankId":"gh.29.uk",
    "number":"5987953",
    "legalName":"Eveline Tripman",
    "mobileNumber":"+44 07972 444 876",
    "email":"felixsmith@example.com",
    "faceImage":{
      "date":"2019-09-08T00:00:00Z",
      "url":"http://www.example.com/id-docs/123/image.png"
    },
    "dateOfBirth":"2018-03-09T00:00:00Z",
    "relationshipStatus":"single",
    "dependents":1,
    "dobOfDependents":["2019-09-08T00:00:00Z","2019-01-03T00:00:00Z"],
    "highestEducationAttained":"Master",
    "employmentStatus":"worker",
    "creditRating":{
      "rating":"",
      "source":""
    },
    "creditLimit":{
      "currency":"EUR",
      "amount":"1000.00"
    },
    "kycStatus":true,
    "lastOkDate":"2019-09-08T00:00:00Z",
    "title":"title of customer",
    "branchId":"DERBY6",
    "nameSuffix":"Sr"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv1.4.0: createCustomerMessage
OBPv2.0.0: getKycDocuments
OBPv2.0.0: getKycMedia
OBPv2.0.0: getKycChecks
OBPv2.0.0: getKycStatuses
OBPv2.0.0: addKycDocument
OBPv2.0.0: addKycMedia
OBPv2.0.0: addKycCheck
OBPv2.0.0: addKycStatus
OBPv3.1.0: getCustomerByCustomerId
OBPv3.1.0: createTaxResidence
OBPv3.1.0: getTaxResidence
OBPv3.1.0: deleteTaxResidence
OBPv3.1.0: createCustomerAddress
OBPv3.1.0: updateCustomerAddress
OBPv3.1.0: getCustomerAddresses
OBPv3.1.0: deleteCustomerAddress
OBPv3.1.0: createAccountApplication
OBPv3.1.0: getAccountApplication
OBPv3.1.0: updateAccountApplicationStatus
OBPv3.1.0: updateCustomerEmail
OBPv3.1.0: updateCustomerNumber
OBPv3.1.0: updateCustomerMobileNumber
OBPv3.1.0: updateCustomerIdentity
OBPv3.1.0: updateCustomerCreditLimit
OBPv3.1.0: updateCustomerCreditRatingAndSource
OBPv3.1.0: addCardForBank
OBPv3.1.0: updatedCardForBank
OBPv3.1.0: updateCustomerBranch
OBPv3.1.0: updateCustomerData
OBPv4.0.0: createDirectDebit
OBPv4.0.0: createDirectDebitManagement
OBPv4.0.0: createStandingOrder
OBPv4.0.0: createStandingOrderManagement
OBPv4.0.0: createCustomerAttribute
OBPv4.0.0: updateCustomerAttribute
OBPv4.0.0: getCustomerAttributes
OBPv4.0.0: getCustomerAttributeById
OBPv4.0.0: getCustomersByAttributes

obp.getCustomerByCustomerNumber

                            
                                Get Customer By Customer Number
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "customerNumber":"5987953",
  "bankId":{
    "value":"gh.29.uk"
  }
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "bankId":"gh.29.uk",
    "number":"5987953",
    "legalName":"Eveline Tripman",
    "mobileNumber":"+44 07972 444 876",
    "email":"felixsmith@example.com",
    "faceImage":{
      "date":"2019-09-08T00:00:00Z",
      "url":"http://www.example.com/id-docs/123/image.png"
    },
    "dateOfBirth":"2018-03-09T00:00:00Z",
    "relationshipStatus":"single",
    "dependents":1,
    "dobOfDependents":["2019-09-08T00:00:00Z","2019-01-03T00:00:00Z"],
    "highestEducationAttained":"Master",
    "employmentStatus":"worker",
    "creditRating":{
      "rating":"",
      "source":""
    },
    "creditLimit":{
      "currency":"EUR",
      "amount":"1000.00"
    },
    "kycStatus":true,
    "lastOkDate":"2019-09-08T00:00:00Z",
    "title":"title of customer",
    "branchId":"DERBY6",
    "nameSuffix":"Sr"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.1.0: getCustomerByCustomerNumber
OBPv3.1.0: createUserAuthContextUpdateRequest
OBPv3.1.0: answerUserAuthContextUpdateChallenge

obp.getCustomerAddress

                            
                                Get Customer Address
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":[{
    "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "customerAddressId":"string",
    "line1":"string",
    "line2":"string",
    "line3":"string",
    "city":"string",
    "county":"string",
    "state":"string",
    "postcode":"string",
    "countryCode":"string",
    "status":"string",
    "tags":"string",
    "insertDate":"2022-06-15T14:52:03Z"
  }]
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.1.0: getCustomerAddresses

obp.createCustomerAddress

                            
                                Create Customer Address
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "line1":"string",
  "line2":"string",
  "line3":"string",
  "city":"string",
  "county":"string",
  "state":"string",
  "postcode":"string",
  "countryCode":"string",
  "tags":"string",
  "status":"string"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "customerAddressId":"string",
    "line1":"string",
    "line2":"string",
    "line3":"string",
    "city":"string",
    "county":"string",
    "state":"string",
    "postcode":"string",
    "countryCode":"string",
    "status":"string",
    "tags":"string",
    "insertDate":"2022-06-15T14:52:03Z"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.1.0: createCustomerAddress

obp.updateCustomerAddress

                            
                                Update Customer Address
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "customerAddressId":"string",
  "line1":"string",
  "line2":"string",
  "line3":"string",
  "city":"string",
  "county":"string",
  "state":"string",
  "postcode":"string",
  "countryCode":"string",
  "tags":"string",
  "status":"string"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "customerAddressId":"string",
    "line1":"string",
    "line2":"string",
    "line3":"string",
    "city":"string",
    "county":"string",
    "state":"string",
    "postcode":"string",
    "countryCode":"string",
    "status":"string",
    "tags":"string",
    "insertDate":"2022-06-15T14:52:03Z"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.1.0: updateCustomerAddress

obp.deleteCustomerAddress

                            
                                Delete Customer Address
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "customerAddressId":"string"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":true
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.1.0: deleteCustomerAddress

obp.createTaxResidence

                            
                                Create Tax Residence
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "domain":"string",
  "taxNumber":"string"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "taxResidenceId":"string",
    "domain":"string",
    "taxNumber":"string"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.1.0: createTaxResidence

obp.getTaxResidence

                            
                                Get Tax Residence
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":[{
    "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "taxResidenceId":"string",
    "domain":"string",
    "taxNumber":"string"
  }]
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.1.0: getTaxResidence

obp.deleteTaxResidence

                            
                                Delete Tax Residence
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "taxResourceId":"string"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":true
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.1.0: deleteTaxResidence

obp.getCustomers

                            
                                Get Customers
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "bankId":{
    "value":"gh.29.uk"
  },
  "limit":100,
  "offset":100,
  "fromDate":"string",
  "toDate":"string"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":[{
    "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "bankId":"gh.29.uk",
    "number":"5987953",
    "legalName":"Eveline Tripman",
    "mobileNumber":"+44 07972 444 876",
    "email":"felixsmith@example.com",
    "faceImage":{
      "date":"2019-09-08T00:00:00Z",
      "url":"http://www.example.com/id-docs/123/image.png"
    },
    "dateOfBirth":"2018-03-09T00:00:00Z",
    "relationshipStatus":"single",
    "dependents":1,
    "dobOfDependents":["2019-09-08T00:00:00Z","2019-01-03T00:00:00Z"],
    "highestEducationAttained":"Master",
    "employmentStatus":"worker",
    "creditRating":{
      "rating":"",
      "source":""
    },
    "creditLimit":{
      "currency":"EUR",
      "amount":"1000.00"
    },
    "kycStatus":true,
    "lastOkDate":"2019-09-08T00:00:00Z",
    "title":"title of customer",
    "branchId":"DERBY6",
    "nameSuffix":"Sr"
  }]
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.1.0: getFirehoseCustomers

obp.getCustomersByCustomerPhoneNumber

                            
                                Get Customers By Customer Phone Number
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "bankId":{
    "value":"gh.29.uk"
  },
  "phoneNumber":"string"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":[{
    "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "bankId":"gh.29.uk",
    "number":"5987953",
    "legalName":"Eveline Tripman",
    "mobileNumber":"+44 07972 444 876",
    "email":"felixsmith@example.com",
    "faceImage":{
      "date":"2019-09-08T00:00:00Z",
      "url":"http://www.example.com/id-docs/123/image.png"
    },
    "dateOfBirth":"2018-03-09T00:00:00Z",
    "relationshipStatus":"single",
    "dependents":1,
    "dobOfDependents":["2019-09-08T00:00:00Z","2019-01-03T00:00:00Z"],
    "highestEducationAttained":"Master",
    "employmentStatus":"worker",
    "creditRating":{
      "rating":"",
      "source":""
    },
    "creditLimit":{
      "currency":"EUR",
      "amount":"1000.00"
    },
    "kycStatus":true,
    "lastOkDate":"2019-09-08T00:00:00Z",
    "title":"title of customer",
    "branchId":"DERBY6",
    "nameSuffix":"Sr"
  }]
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv4.0.0: getCustomersByCustomerPhoneNumber

obp.getCheckbookOrders

                            
                                Get Checkbook Orders
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "bankId":"gh.29.uk",
  "accountId":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "account":{
      "bank_id":"string",
      "account_id":"string",
      "account_type":"string",
      "account_routings":[{
        "scheme":"string",
        "address":"string"
      }],
      "branch_routings":[{
        "scheme":"string",
        "address":"string"
      }]
    },
    "orders":[{
      "order":{
        "order_id":"string",
        "order_date":"string",
        "number_of_checkbooks":"string",
        "distribution_channel":"string",
        "status":"string",
        "first_check_number":"string",
        "shipping_code":"string"
      }
    }]
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.1.0: getCheckbookOrders

obp.getStatusOfCreditCardOrder

                            
                                Get Status Of Credit Card Order
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "bankId":"gh.29.uk",
  "accountId":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":[{
    "card_type":"string",
    "card_description":"string",
    "use_type":"string"
  }]
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.1.0: getStatusOfCreditCardOrder

obp.createUserAuthContext

                            
                                Create User Auth Context
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "key":"CustomerNumber",
  "value":"5987953"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "userAuthContextId":"string",
    "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "key":"CustomerNumber",
    "value":"5987953"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.1.0: createUserAuthContext
OBPv3.1.0: answerUserAuthContextUpdateChallenge

obp.createUserAuthContextUpdate

                            
                                Create User Auth Context Update
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "key":"CustomerNumber",
  "value":"5987953"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "userAuthContextUpdateId":"string",
    "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "key":"CustomerNumber",
    "value":"5987953",
    "challenge":"string",
    "status":"string"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.1.0: createUserAuthContextUpdateRequest

obp.deleteUserAuthContexts

                            
                                Delete User Auth Contexts
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":true
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.1.0: deleteUserAuthContexts

obp.deleteUserAuthContextById

                            
                                Delete User Auth Context By Id
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "userAuthContextId":"string"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":true
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.1.0: deleteUserAuthContextById

obp.getUserAuthContexts

                            
                                Get User Auth Contexts
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":[{
    "userAuthContextId":"string",
    "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "key":"CustomerNumber",
    "value":"5987953"
  }]
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.1.0: getUserAuthContexts

obp.createOrUpdateProductAttribute

                            
                                Create Or Update Product Attribute
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "bankId":{
    "value":"gh.29.uk"
  },
  "productCode":{
    "value":"string"
  },
  "productAttributeId":"string",
  "name":"string",
  "productAttributeType":"STRING",
  "value":"5987953"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "bankId":{
      "value":"gh.29.uk"
    },
    "productCode":{
      "value":"string"
    },
    "productAttributeId":"string",
    "name":"string",
    "attributeType":"STRING",
    "value":"5987953"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.1.0: createProductAttribute
OBPv3.1.0: updateProductAttribute

obp.getProductAttributeById

                            
                                Get Product Attribute By Id
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "productAttributeId":"string"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "bankId":{
      "value":"gh.29.uk"
    },
    "productCode":{
      "value":"string"
    },
    "productAttributeId":"string",
    "name":"string",
    "attributeType":"STRING",
    "value":"5987953"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.1.0: getProductAttribute
OBPv3.1.0: updateProductAttribute

obp.getProductAttributesByBankAndCode

                            
                                Get Product Attributes By Bank And Code
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "bank":{
    "value":"gh.29.uk"
  },
  "productCode":{
    "value":"string"
  }
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":[{
    "bankId":{
      "value":"gh.29.uk"
    },
    "productCode":{
      "value":"string"
    },
    "productAttributeId":"string",
    "name":"string",
    "attributeType":"STRING",
    "value":"5987953"
  }]
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.1.0: getProduct
OBPv3.1.0: createAccount
OBPv4.0.0: createSettlementAccount
OBPv4.0.0: addAccount

obp.deleteProductAttribute

                            
                                Delete Product Attribute
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "productAttributeId":"string"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":true
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.1.0: deleteProductAttribute

obp.getAccountAttributeById

                            
                                Get Account Attribute By Id
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "accountAttributeId":"string"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "bankId":{
      "value":"gh.29.uk"
    },
    "accountId":{
      "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
    },
    "productCode":{
      "value":"string"
    },
    "accountAttributeId":"string",
    "name":"string",
    "attributeType":"STRING",
    "value":"5987953"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.1.0: updateAccountAttribute

obp.getTransactionAttributeById

                            
                                Get Transaction Attribute By Id
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "transactionAttributeId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "bankId":{
      "value":"gh.29.uk"
    },
    "transactionId":{
      "value":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub"
    },
    "transactionAttributeId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "attributeType":"STRING",
    "name":"HOUSE_RENT",
    "value":"123456789"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv4.0.0: updateTransactionAttribute
OBPv4.0.0: getTransactionAttributeById

obp.createOrUpdateAccountAttribute

                            
                                Create Or Update Account Attribute
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "bankId":{
    "value":"gh.29.uk"
  },
  "accountId":{
    "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
  },
  "productCode":{
    "value":"string"
  },
  "productAttributeId":"string",
  "name":"string",
  "accountAttributeType":"STRING",
  "value":"5987953"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "bankId":{
      "value":"gh.29.uk"
    },
    "accountId":{
      "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
    },
    "productCode":{
      "value":"string"
    },
    "accountAttributeId":"string",
    "name":"string",
    "attributeType":"STRING",
    "value":"5987953"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.1.0: createAccountAttribute
OBPv3.1.0: updateAccountAttribute

obp.createOrUpdateCustomerAttribute

                            
                                Create Or Update Customer Attribute
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "bankId":{
    "value":"gh.29.uk"
  },
  "customerId":{
    "value":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"
  },
  "customerAttributeId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "name":"string",
  "attributeType":"STRING",
  "value":"5987953"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "bankId":{
      "value":"gh.29.uk"
    },
    "customerId":{
      "value":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"
    },
    "customerAttributeId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "attributeType":"STRING",
    "name":"SPECIAL_TAX_NUMBER",
    "value":"123456789"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv4.0.0: createCustomerAttribute
OBPv4.0.0: updateCustomerAttribute

obp.createOrUpdateTransactionAttribute

                            
                                Create Or Update Transaction Attribute
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "bankId":{
    "value":"gh.29.uk"
  },
  "transactionId":{
    "value":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub"
  },
  "transactionAttributeId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "name":"string",
  "attributeType":"STRING",
  "value":"5987953"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "bankId":{
      "value":"gh.29.uk"
    },
    "transactionId":{
      "value":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub"
    },
    "transactionAttributeId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "attributeType":"STRING",
    "name":"HOUSE_RENT",
    "value":"123456789"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv4.0.0: createTransactionAttribute
OBPv4.0.0: updateTransactionAttribute

obp.createAccountAttributes

                            
                                Create Account Attributes
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "bankId":{
    "value":"gh.29.uk"
  },
  "accountId":{
    "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
  },
  "productCode":{
    "value":"string"
  },
  "accountAttributes":[{
    "bankId":{
      "value":"gh.29.uk"
    },
    "productCode":{
      "value":"string"
    },
    "productAttributeId":"string",
    "name":"string",
    "attributeType":"STRING",
    "value":"5987953"
  }]
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":[{
    "bankId":{
      "value":"gh.29.uk"
    },
    "accountId":{
      "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
    },
    "productCode":{
      "value":"string"
    },
    "accountAttributeId":"string",
    "name":"string",
    "attributeType":"STRING",
    "value":"5987953"
  }]
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.1.0: createAccount
OBPv4.0.0: createSettlementAccount
OBPv4.0.0: addAccount

obp.getAccountAttributesByAccount

                            
                                Get Account Attributes By Account
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "bankId":{
    "value":"gh.29.uk"
  },
  "accountId":{
    "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
  }
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":[{
    "bankId":{
      "value":"gh.29.uk"
    },
    "accountId":{
      "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
    },
    "productCode":{
      "value":"string"
    },
    "accountAttributeId":"string",
    "name":"string",
    "attributeType":"STRING",
    "value":"5987953"
  }]
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.0.0: getFirehoseAccountsAtOneBank
OBPv3.1.0: getPrivateAccountByIdFull
OBPv4.0.0: getSettlementAccounts
OBPv4.0.0: answerTransactionRequestChallenge
OBPv4.0.0: getPrivateAccountByIdFull
OBPv4.0.0: getAccountByAccountRouting
OBPv4.0.0: getFirehoseAccountsAtOneBank

obp.getCustomerAttributes

                            
                                Get Customer Attributes
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "bankId":{
    "value":"gh.29.uk"
  },
  "customerId":{
    "value":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"
  }
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":[{
    "bankId":{
      "value":"gh.29.uk"
    },
    "customerId":{
      "value":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"
    },
    "customerAttributeId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "attributeType":"STRING",
    "name":"SPECIAL_TAX_NUMBER",
    "value":"123456789"
  }]
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.1.0: getCustomerByCustomerId
OBPv3.1.0: getCustomerByCustomerNumber
OBPv4.0.0: getCustomerAttributes
OBPv4.0.0: getCustomersByAttributes

obp.getCustomerIdsByAttributeNameValues

                            
                                Get Customer Ids By Attribute Name Values
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "bankId":{
    "value":"gh.29.uk"
  },
  "nameValues":{
    "some_name":["name1","name2"]
  }
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":["string"]
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.1.0: getFirehoseCustomers
OBPv4.0.0: getCustomersByAttributes

obp.getCustomerAttributesForCustomers

                            
                                Get Customer Attributes For Customers
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "customers":[{
    "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "bankId":"gh.29.uk",
    "number":"5987953",
    "legalName":"Eveline Tripman",
    "mobileNumber":"+44 07972 444 876",
    "email":"felixsmith@example.com",
    "faceImage":{
      "date":"2019-09-08T00:00:00Z",
      "url":"http://www.example.com/id-docs/123/image.png"
    },
    "dateOfBirth":"2018-03-09T00:00:00Z",
    "relationshipStatus":"single",
    "dependents":1,
    "dobOfDependents":["2019-09-08T00:00:00Z","2019-01-03T00:00:00Z"],
    "highestEducationAttained":"Master",
    "employmentStatus":"worker",
    "creditRating":{
      "rating":"",
      "source":""
    },
    "creditLimit":{
      "currency":"EUR",
      "amount":"1000.00"
    },
    "kycStatus":true,
    "lastOkDate":"2019-09-08T00:00:00Z",
    "title":"title of customer",
    "branchId":"DERBY6",
    "nameSuffix":"Sr"
  }]
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":[{
    "customer":{
      "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
      "bankId":"gh.29.uk",
      "number":"546387432",
      "legalName":"Eveline Tripman",
      "mobileNumber":"+44 07972 444 876",
      "email":"felixsmith@example.com",
      "faceImage":{
        "date":"2017-09-19T00:00:00Z",
        "url":"http://www.example.com/id-docs/123/image.png"
      },
      "dateOfBirth":"2017-09-19T00:00:00Z",
      "relationshipStatus":"single",
      "dependents":1,
      "dobOfDependents":["2017-09-19T00:00:00Z"],
      "highestEducationAttained":"Master",
      "employmentStatus":"worker",
      "creditRating":{
        "rating":"",
        "source":""
      },
      "creditLimit":{
        "currency":"EUR",
        "amount":"50.89"
      },
      "kycStatus":true,
      "lastOkDate":"2017-09-19T00:00:00Z",
      "title":"Dr.",
      "branchId":"DERBY6",
      "nameSuffix":"Sr"
    },
    "attributes":[{
      "bankId":{
        "value":"gh.29.uk"
      },
      "customerId":{
        "value":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"
      },
      "customerAttributeId":"some_customer_attributeId_value",
      "attributeType":"INTEGER",
      "name":"customer_attribute_field",
      "value":"example_value"
    }]
  }]
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.0.0: getCustomersForUser

obp.getTransactionIdsByAttributeNameValues

                            
                                Get Transaction Ids By Attribute Name Values
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "bankId":{
    "value":"gh.29.uk"
  },
  "nameValues":{
    "some_name":["name1","name2"]
  }
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":["string"]
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.0.0: getFirehoseTransactionsForBankAccount

obp.getTransactionAttributes

                            
                                Get Transaction Attributes
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "bankId":{
    "value":"gh.29.uk"
  },
  "transactionId":{
    "value":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub"
  }
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":[{
    "bankId":{
      "value":"gh.29.uk"
    },
    "transactionId":{
      "value":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub"
    },
    "transactionAttributeId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "attributeType":"STRING",
    "name":"HOUSE_RENT",
    "value":"123456789"
  }]
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.0.0: getFirehoseTransactionsForBankAccount
OBPv3.0.0: getCoreTransactionsForBankAccount
OBPv3.0.0: getTransactionsForBankAccount
OBPv3.1.0: getTransactionByIdForBankAccount
OBPv4.0.0: getTransactionAttributes

obp.getCustomerAttributeById

                            
                                Get Customer Attribute By Id
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "customerAttributeId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "bankId":{
      "value":"gh.29.uk"
    },
    "customerId":{
      "value":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"
    },
    "customerAttributeId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "attributeType":"STRING",
    "name":"SPECIAL_TAX_NUMBER",
    "value":"123456789"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv4.0.0: updateCustomerAttribute
OBPv4.0.0: getCustomerAttributeById

obp.createOrUpdateCardAttribute

                            
                                Create Or Update Card Attribute
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "bankId":{
    "value":"gh.29.uk"
  },
  "cardId":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ",
  "cardAttributeId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
  "name":"string",
  "cardAttributeType":"STRING",
  "value":"5987953"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "name":"OVERDRAFT_START_DATE",
    "card_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ",
    "attribute_type":"STRING",
    "bank_id":{
      "value":"gh.29.uk"
    },
    "value":"2012-04-23",
    "card_attribute_id":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.1.0: createCardAttribute
OBPv3.1.0: updateCardAttribute

obp.getCardAttributeById

                            
                                Get Card Attribute By Id
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "cardAttributeId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "name":"OVERDRAFT_START_DATE",
    "card_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ",
    "attribute_type":"STRING",
    "bank_id":{
      "value":"gh.29.uk"
    },
    "value":"2012-04-23",
    "card_attribute_id":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.1.0: updateCardAttribute

obp.getCardAttributesFromProvider

                            
                                Get Card Attributes From Provider
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "cardId":"36f8a9e6-c2b1-407a-8bd0-421b7119307e "
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":[{
    "name":"OVERDRAFT_START_DATE",
    "card_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ",
    "attribute_type":"STRING",
    "bank_id":{
      "value":"gh.29.uk"
    },
    "value":"2012-04-23",
    "card_attribute_id":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50"
  }]
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.1.0: getCardForBank

obp.createAccountApplication

                            
                                Create Account Application
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "productCode":{
    "value":"string"
  },
  "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "accountApplicationId":"string",
    "productCode":{
      "value":"string"
    },
    "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "dateOfApplication":"2022-06-15T14:52:03Z",
    "status":"string"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.1.0: createAccountApplication

obp.getAllAccountApplication

                            
                                Get All Account Application
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  }
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":[{
    "accountApplicationId":"string",
    "productCode":{
      "value":"string"
    },
    "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "dateOfApplication":"2022-06-15T14:52:03Z",
    "status":"string"
  }]
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.1.0: getAccountApplications

obp.getAccountApplicationById

                            
                                Get Account Application By Id
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "accountApplicationId":"string"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "accountApplicationId":"string",
    "productCode":{
      "value":"string"
    },
    "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "dateOfApplication":"2022-06-15T14:52:03Z",
    "status":"string"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.1.0: getAccountApplication
OBPv3.1.0: updateAccountApplicationStatus

obp.updateAccountApplicationStatus

                            
                                Update Account Application Status
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "accountApplicationId":"string",
  "status":"string"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "accountApplicationId":"string",
    "productCode":{
      "value":"string"
    },
    "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "dateOfApplication":"2022-06-15T14:52:03Z",
    "status":"string"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.1.0: updateAccountApplicationStatus

obp.getOrCreateProductCollection

                            
                                Get Or Create Product Collection
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "collectionCode":"string",
  "productCodes":["string"]
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":[{
    "collectionCode":"string",
    "productCode":"string"
  }]
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.1.0: createProductCollection

obp.getProductCollection

                            
                                Get Product Collection
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "collectionCode":"string"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":[{
    "collectionCode":"string",
    "productCode":"string"
  }]
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints

obp.getOrCreateProductCollectionItem

                            
                                Get Or Create Product Collection Item
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "collectionCode":"string",
  "memberProductCodes":["string"]
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":[{
    "collectionCode":"string",
    "memberProductCode":"string"
  }]
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.1.0: createProductCollection

obp.getProductCollectionItem

                            
                                Get Product Collection Item
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "collectionCode":"string"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":[{
    "collectionCode":"string",
    "memberProductCode":"string"
  }]
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints

obp.getProductCollectionItemsTree

                            
                                Get Product Collection Items Tree
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "collectionCode":"string",
  "bankId":"gh.29.uk"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":[{
    "productCollectionItem":{
      "collectionCode":"string",
      "memberProductCode":"string"
    },
    "product":{
      "bankId":{
        "value":"gh.29.uk"
      },
      "code":{
        "value":"string"
      },
      "parentProductCode":{
        "value":"string"
      },
      "name":"string",
      "category":"string",
      "family":"string",
      "superFamily":"string",
      "moreInfoUrl":"string",
      "details":"string",
      "description":"string",
      "meta":{
        "license":{
          "id":"string",
          "name":"string"
        }
      }
    },
    "attributes":[{
      "bankId":{
        "value":"gh.29.uk"
      },
      "productCode":{
        "value":"string"
      },
      "productAttributeId":"string",
      "name":"string",
      "attributeType":"STRING",
      "value":"5987953"
    }]
  }]
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.1.0: getProductCollection

obp.createMeeting

                            
                                Create Meeting
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "bankId":{
    "value":"gh.29.uk"
  },
  "staffUser":{
    "userPrimaryKey":{
      "value":123
    },
    "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "idGivenByProvider":"string",
    "provider":"string",
    "emailAddress":"felixsmith@example.com",
    "name":"felixsmith"
  },
  "customerUser":{
    "userPrimaryKey":{
      "value":123
    },
    "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "idGivenByProvider":"string",
    "provider":"string",
    "emailAddress":"felixsmith@example.com",
    "name":"felixsmith"
  },
  "providerId":"string",
  "purposeId":"string",
  "when":"2022-06-15T14:52:03Z",
  "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
  "customerToken":"string",
  "staffToken":"string",
  "creator":{
    "name":"string",
    "phone":"string",
    "email":"felixsmith@example.com"
  },
  "invitees":[{
    "contactDetails":{
      "name":"string",
      "phone":"string",
      "email":"felixsmith@example.com"
    },
    "status":"string"
  }]
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "meetingId":"string",
    "providerId":"string",
    "purposeId":"string",
    "bankId":"gh.29.uk",
    "present":{
      "staffUserId":"string",
      "customerUserId":"string"
    },
    "keys":{
      "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
      "customerToken":"string",
      "staffToken":"string"
    },
    "when":"2022-06-15T14:52:03Z",
    "creator":{
      "name":"string",
      "phone":"string",
      "email":"felixsmith@example.com"
    },
    "invitees":[{
      "contactDetails":{
        "name":"string",
        "phone":"string",
        "email":"felixsmith@example.com"
      },
      "status":"string"
    }]
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.1.0: createMeeting

obp.getMeetings

                            
                                Get Meetings
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "bankId":{
    "value":"gh.29.uk"
  },
  "user":{
    "userPrimaryKey":{
      "value":123
    },
    "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "idGivenByProvider":"string",
    "provider":"string",
    "emailAddress":"felixsmith@example.com",
    "name":"felixsmith"
  }
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":[{
    "meetingId":"string",
    "providerId":"string",
    "purposeId":"string",
    "bankId":"gh.29.uk",
    "present":{
      "staffUserId":"string",
      "customerUserId":"string"
    },
    "keys":{
      "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
      "customerToken":"string",
      "staffToken":"string"
    },
    "when":"2022-06-15T14:52:03Z",
    "creator":{
      "name":"string",
      "phone":"string",
      "email":"felixsmith@example.com"
    },
    "invitees":[{
      "contactDetails":{
        "name":"string",
        "phone":"string",
        "email":"felixsmith@example.com"
      },
      "status":"string"
    }]
  }]
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.1.0: getMeetings

obp.getMeeting

                            
                                Get Meeting
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "bankId":{
    "value":"gh.29.uk"
  },
  "user":{
    "userPrimaryKey":{
      "value":123
    },
    "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "idGivenByProvider":"string",
    "provider":"string",
    "emailAddress":"felixsmith@example.com",
    "name":"felixsmith"
  },
  "meetingId":"string"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "meetingId":"string",
    "providerId":"string",
    "purposeId":"string",
    "bankId":"gh.29.uk",
    "present":{
      "staffUserId":"string",
      "customerUserId":"string"
    },
    "keys":{
      "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
      "customerToken":"string",
      "staffToken":"string"
    },
    "when":"2022-06-15T14:52:03Z",
    "creator":{
      "name":"string",
      "phone":"string",
      "email":"felixsmith@example.com"
    },
    "invitees":[{
      "contactDetails":{
        "name":"string",
        "phone":"string",
        "email":"felixsmith@example.com"
      },
      "status":"string"
    }]
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.1.0: getMeeting

obp.createOrUpdateKycCheck

                            
                                Create Or Update Kyc Check
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "bankId":"gh.29.uk",
  "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "id":"string",
  "customerNumber":"5987953",
  "date":"2022-06-15T14:52:03Z",
  "how":"string",
  "staffUserId":"string",
  "mStaffName":"string",
  "mSatisfied":true,
  "comments":"string"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "bankId":"gh.29.uk",
    "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "idKycCheck":"string",
    "customerNumber":"5987953",
    "date":"2022-06-15T14:52:03Z",
    "how":"string",
    "staffUserId":"string",
    "staffName":"string",
    "satisfied":true,
    "comments":"string"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv2.0.0: addKycCheck

obp.createOrUpdateKycDocument

                            
                                Create Or Update Kyc Document
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "bankId":"gh.29.uk",
  "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "id":"string",
  "customerNumber":"5987953",
  "type":"string",
  "number":"string",
  "issueDate":"2022-06-15T14:52:03Z",
  "issuePlace":"string",
  "expiryDate":"2022-06-15T14:52:03Z"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "bankId":"gh.29.uk",
    "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "idKycDocument":"string",
    "customerNumber":"5987953",
    "type":"string",
    "number":"string",
    "issueDate":"2022-06-15T14:52:03Z",
    "issuePlace":"string",
    "expiryDate":"2022-06-15T14:52:03Z"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv2.0.0: addKycDocument

obp.createOrUpdateKycMedia

                            
                                Create Or Update Kyc Media
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "bankId":"gh.29.uk",
  "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "id":"string",
  "customerNumber":"5987953",
  "type":"string",
  "url":"http://www.example.com/id-docs/123/image.png",
  "date":"2022-06-15T14:52:03Z",
  "relatesToKycDocumentId":"string",
  "relatesToKycCheckId":"string"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "bankId":"gh.29.uk",
    "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "idKycMedia":"string",
    "customerNumber":"5987953",
    "type":"string",
    "url":"http://www.example.com/id-docs/123/image.png",
    "date":"2022-06-15T14:52:03Z",
    "relatesToKycDocumentId":"string",
    "relatesToKycCheckId":"string"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv2.0.0: addKycMedia

obp.createOrUpdateKycStatus

                            
                                Create Or Update Kyc Status
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "bankId":"gh.29.uk",
  "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "customerNumber":"5987953",
  "ok":true,
  "date":"2022-06-15T14:52:03Z"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "bankId":"gh.29.uk",
    "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "customerNumber":"5987953",
    "ok":true,
    "date":"2022-06-15T14:52:03Z"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv2.0.0: addKycStatus

obp.getKycChecks

                            
                                Get Kyc Checks
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":[{
    "bankId":"gh.29.uk",
    "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "idKycCheck":"string",
    "customerNumber":"5987953",
    "date":"2022-06-15T14:52:03Z",
    "how":"string",
    "staffUserId":"string",
    "staffName":"string",
    "satisfied":true,
    "comments":"string"
  }]
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv2.0.0: getKycChecks

obp.getKycDocuments

                            
                                Get Kyc Documents
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":[{
    "bankId":"gh.29.uk",
    "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "idKycDocument":"string",
    "customerNumber":"5987953",
    "type":"string",
    "number":"string",
    "issueDate":"2022-06-15T14:52:03Z",
    "issuePlace":"string",
    "expiryDate":"2022-06-15T14:52:03Z"
  }]
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv2.0.0: getKycDocuments

obp.getKycMedias

                            
                                Get Kyc Medias
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":[{
    "bankId":"gh.29.uk",
    "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "idKycMedia":"string",
    "customerNumber":"5987953",
    "type":"string",
    "url":"http://www.example.com/id-docs/123/image.png",
    "date":"2022-06-15T14:52:03Z",
    "relatesToKycDocumentId":"string",
    "relatesToKycCheckId":"string"
  }]
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv2.0.0: getKycMedia

obp.getKycStatuses

                            
                                Get Kyc Statuses
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":[{
    "bankId":"gh.29.uk",
    "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "customerNumber":"5987953",
    "ok":true,
    "date":"2022-06-15T14:52:03Z"
  }]
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv2.0.0: getKycStatuses

obp.createMessage

                            
                                Create Message
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "user":{
    "userPrimaryKey":{
      "value":123
    },
    "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "idGivenByProvider":"string",
    "provider":"string",
    "emailAddress":"felixsmith@example.com",
    "name":"felixsmith"
  },
  "bankId":{
    "value":"gh.29.uk"
  },
  "message":"string",
  "fromDepartment":"string",
  "fromPerson":"string"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "messageId":"string",
    "date":"2022-06-15T14:52:03Z",
    "message":"string",
    "fromDepartment":"string",
    "fromPerson":"string"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv1.4.0: createCustomerMessage

obp.makeHistoricalPayment

                            
                                Make Historical Payment
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "fromAccount":{
    "accountId":{
      "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
    },
    "accountType":"AC",
    "balance":"50.89",
    "currency":"EUR",
    "name":"bankAccount name string",
    "label":"My Account",
    "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"
    }],
    "accountRules":[{
      "scheme":"AccountRule scheme string",
      "value":"AccountRule value string"
    }],
    "accountHolder":"bankAccount accountHolder string"
  },
  "toAccount":{
    "accountId":{
      "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
    },
    "accountType":"AC",
    "balance":"50.89",
    "currency":"EUR",
    "name":"bankAccount name string",
    "label":"My Account",
    "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"
    }],
    "accountRules":[{
      "scheme":"AccountRule scheme string",
      "value":"AccountRule value string"
    }],
    "accountHolder":"bankAccount accountHolder string"
  },
  "posted":"2022-06-15T14:52:03Z",
  "completed":"2022-06-15T14:52:03Z",
  "amount":"123.321",
  "currency":"EUR",
  "description":"string",
  "transactionRequestType":"SEPA",
  "chargePolicy":"string"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "value":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv3.1.0: saveHistoricalTransaction

obp.createDirectDebit

                            
                                Create Direct Debit
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "bankId":"gh.29.uk",
  "accountId":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
  "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "counterpartyId":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "dateSigned":"2022-06-15T14:52:03Z",
  "dateStarts":"2022-06-15T14:52:03Z",
  "dateExpires":"2022-06-15T14:52:03Z"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "directDebitId":"string",
    "bankId":"gh.29.uk",
    "accountId":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
    "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "counterpartyId":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "dateSigned":"2022-06-15T14:52:03Z",
    "dateCancelled":"2022-06-15T14:52:03Z",
    "dateStarts":"2022-06-15T14:52:03Z",
    "dateExpires":"2022-06-15T14:52:03Z",
    "active":true
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv4.0.0: createDirectDebit
OBPv4.0.0: createDirectDebitManagement

obp.deleteCustomerAttribute

                            
                                Delete Customer Attribute
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                
                                

                                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"
          }]
        }
      }]
    }
  },
  "customerAttributeId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":true
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv4.0.0: deleteCustomerAttribute

obp.getBanks

                            
                                Gets the banks list on this OBP installation.
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                OutBoundGetBanks
                                InBoundGetBanks

                                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"
          }]
        }
      }]
    }
  }
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":[{
    "bankId":{
      "value":"gh.29.uk"
    },
    "shortName":"The Royal Bank of Scotland",
    "fullName":"The Royal Bank of Scotland",
    "logoUrl":"http://www.red-bank-shoreditch.com/logo.gif",
    "websiteUrl":"http://www.red-bank-shoreditch.com",
    "bankRoutingScheme":"OBP",
    "bankRoutingAddress":"rbs"
  }]
}

                                Required 
Fields
                                
                                {
  "data.bankId":["allVersion"]
}

                                Dependent
Endpoints
                                OBPv3.0.0: getBanks
OBPv4.0.0: getBanks

obp.getBank

                            
                                Get a specific Bank as specified by bankId
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                OutBoundGetBank
                                InBoundGetBank

                                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"
          }]
        }
      }]
    }
  },
  "bankId":{
    "value":"gh.29.uk"
  }
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "bankId":{
      "value":"gh.29.uk"
    },
    "shortName":"The Royal Bank of Scotland",
    "fullName":"The Royal Bank of Scotland",
    "logoUrl":"http://www.red-bank-shoreditch.com/logo.gif",
    "websiteUrl":"http://www.red-bank-shoreditch.com",
    "bankRoutingScheme":"OBP",
    "bankRoutingAddress":"rbs"
  }
}

                                Required 
Fields
                                
                                {
  "data.bankId":["allVersion"]
}

                                Dependent
Endpoints
                                BGv1.3: getAccountList
BGv1.3: getBalances
BGv1.3: getCardAccounts
BGv1.3: getCardAccountBalances
BGv1.3: getCardAccountTransactionList
BGv1.3: getTransactionDetails
BGv1.3: getTransactionList
BGv1: getAccountList
BGv1: getAccountBalances
BGv1: getTransactionList
STETv1.4: accountsBalancesGet
STETv1.4: accountsGet
STETv1.4: accountsTransactionsGet
UKv3.1: getAccountsAccountIdTransactions
UKv3.1: getTransactions
UKv2.0: getAccountTransactions
OBPv1.2.1: deleteViewForBankAccount
OBPv1.2.1: addPermissionForUserForBankAccountForMultipleViews
OBPv1.2.1: addPermissionForUserForBankAccountForOneView
OBPv1.2.1: removePermissionForUserForBankAccountForOneView
OBPv1.2.1: removePermissionForUserForBankAccountForAllViews
OBPv1.2.1: addCounterpartyPublicAlias
OBPv1.2.1: addOtherAccountPrivateAlias
OBPv1.2.1: addCounterpartyMoreInfo
OBPv1.2.1: addCounterpartyUrl
OBPv1.2.1: addCounterpartyImageUrl
OBPv1.2.1: addCounterpartyOpenCorporatesUrl
OBPv1.4.0: createCustomerMessage
OBPv1.4.0: getTransactionRequestTypes
OBPv2.0.0: getPrivateAccountsAtOneBank
OBPv2.0.0: corePrivateAccountsAtOneBank
OBPv2.0.0: privateAccountsAtOneBank
OBPv2.0.0: publicAccountsAtOneBank
OBPv2.0.0: addKycDocument
OBPv2.0.0: addKycMedia
OBPv2.0.0: addKycCheck
OBPv2.0.0: addKycStatus
OBPv2.0.0: getPermissionsForBankAccount
OBPv2.0.0: getTransactionTypes
OBPv2.1.0: createTransactionRequestSandboxTan
OBPv2.1.0: createTransactionRequestCounterparty
OBPv2.1.0: createTransactionRequestSepa
OBPv2.1.0: createTransactionRequestFreeForm
OBPv2.1.0: answerTransactionRequestChallenge
OBPv2.1.0: getEntitlementsByBankAndUser
OBPv2.1.0: getCustomersForCurrentUserAtBank
OBPv2.2.0: getCurrentFxRate
OBPv2.2.0: createAccount
OBPv2.2.0: createCounterparty
OBPv3.0.0: getPermissionForUserForBankAccount
OBPv3.0.0: getFirehoseAccountsAtOneBank
OBPv3.0.0: getFirehoseTransactionsForBankAccount
OBPv3.0.0: getCoreTransactionsForBankAccount
OBPv3.0.0: getTransactionsForBankAccount
OBPv3.0.0: getAdapterInfoForBank
OBPv3.0.0: getBranch
OBPv3.0.0: getBranches
OBPv3.0.0: getAtm
OBPv3.0.0: getAtms
OBPv3.0.0: privateAccountsAtOneBank
OBPv3.0.0: getPrivateAccountIdsbyBankId
OBPv3.0.0: addEntitlementRequest
OBPv3.0.0: getAccountsHeld
OBPv3.0.0: bankById
OBPv3.1.0: getCheckbookOrders
OBPv3.1.0: getStatusOfCreditCardOrder
OBPv3.1.0: getFirehoseCustomers
OBPv3.1.0: checkFundsAvailable
OBPv3.1.0: createAccountWebhook
OBPv3.1.0: enableDisableAccountWebhook
OBPv3.1.0: getAccountWebhooks
OBPv3.1.0: getTransactionByIdForBankAccount
OBPv3.1.0: getTransactionRequests
OBPv3.1.0: createCustomer
OBPv3.1.0: getCustomerByCustomerId
OBPv3.1.0: getCustomerByCustomerNumber
OBPv3.1.0: createTaxResidence
OBPv3.1.0: getTaxResidence
OBPv3.1.0: deleteTaxResidence
OBPv3.1.0: createCustomerAddress
OBPv3.1.0: updateCustomerAddress
OBPv3.1.0: getCustomerAddresses
OBPv3.1.0: deleteCustomerAddress
OBPv3.1.0: createProductAttribute
OBPv3.1.0: getProductAttribute
OBPv3.1.0: updateProductAttribute
OBPv3.1.0: deleteProductAttribute
OBPv3.1.0: createAccountApplication
OBPv3.1.0: getAccountApplications
OBPv3.1.0: getAccountApplication
OBPv3.1.0: updateAccountApplicationStatus
OBPv3.1.0: createProduct
OBPv3.1.0: getProduct
OBPv3.1.0: getProductTree
OBPv3.1.0: getProducts
OBPv3.1.0: createAccountAttribute
OBPv3.1.0: updateAccountAttribute
OBPv3.1.0: createProductCollection
OBPv3.1.0: getProductCollection
OBPv3.1.0: deleteBranch
OBPv3.1.0: createMeeting
OBPv3.1.0: getMeetings
OBPv3.1.0: getMeeting
OBPv3.1.0: createConsentEmail
OBPv3.1.0: createConsentSms
OBPv3.1.0: answerConsentChallenge
OBPv3.1.0: getConsents
OBPv3.1.0: revokeConsent
OBPv3.1.0: createUserAuthContextUpdateRequest
OBPv3.1.0: updateCustomerEmail
OBPv3.1.0: updateCustomerNumber
OBPv3.1.0: updateCustomerMobileNumber
OBPv3.1.0: updateCustomerIdentity
OBPv3.1.0: updateCustomerCreditLimit
OBPv3.1.0: updateCustomerCreditRatingAndSource
OBPv3.1.0: updateAccount
OBPv3.1.0: getCardsForBank
OBPv3.1.0: getCardForBank
OBPv3.1.0: deleteCardForBank
OBPv3.1.0: createCardAttribute
OBPv3.1.0: updateCardAttribute
OBPv3.1.0: updateCustomerBranch
OBPv3.1.0: updateCustomerData
OBPv3.1.0: createAccount
OBPv3.1.0: saveHistoricalTransaction
OBPv3.1.0: getBankAccountsBalances
OBPv4.0.0: createSettlementAccount
OBPv4.0.0: addAccount
OBPv4.0.0: createCounterparty
OBPv4.0.0: createCounterpartyForAnyAccount
OBPv4.0.0: getDoubleEntryTransaction
OBPv4.0.0: getSettlementAccounts
OBPv4.0.0: createTransactionRequestAccount
OBPv4.0.0: createTransactionRequestAccountOtp
OBPv4.0.0: createTransactionRequestCounterparty
OBPv4.0.0: createTransactionRequestSepa
OBPv4.0.0: createTransactionRequestRefund
OBPv4.0.0: createTransactionRequestFreeForm
OBPv4.0.0: answerTransactionRequestChallenge
OBPv4.0.0: createTransactionRequestAttribute
OBPv4.0.0: getTransactionRequestAttributeById
OBPv4.0.0: getTransactionRequestAttributes
OBPv4.0.0: updateTransactionRequestAttribute
OBPv4.0.0: createOrUpdateTransactionRequestAttributeDefinition
OBPv4.0.0: getTransactionRequestAttributeDefinition
OBPv4.0.0: deleteTransactionRequestAttributeDefinition
OBPv4.0.0: updateAccountLabel
OBPv4.0.0: addTagForViewOnAccount
OBPv4.0.0: deleteTagForViewOnAccount
OBPv4.0.0: getTagsForViewOnAccount
OBPv4.0.0: getPrivateAccountByIdFull
OBPv4.0.0: getBankAccountsBalances
OBPv4.0.0: getFirehoseAccountsAtOneBank
OBPv4.0.0: createDirectDebit
OBPv4.0.0: createDirectDebitManagement
OBPv4.0.0: createStandingOrder
OBPv4.0.0: createStandingOrderManagement
OBPv4.0.0: createCustomerAttribute
OBPv4.0.0: updateCustomerAttribute
OBPv4.0.0: getCustomerAttributes
OBPv4.0.0: getCustomerAttributeById
OBPv4.0.0: getCustomersByAttributes
OBPv4.0.0: createTransactionAttribute
OBPv4.0.0: updateTransactionAttribute
OBPv4.0.0: getTransactionAttributes
OBPv4.0.0: getTransactionAttributeById
OBPv4.0.0: getTransactionRequest
OBPv4.0.0: getPrivateAccountsAtOneBank
OBPv4.0.0: deleteCustomerAttribute
OBPv4.0.0: createOrUpdateCustomerAttributeAttributeDefinition
OBPv4.0.0: createOrUpdateAccountAttributeDefinition
OBPv4.0.0: createOrUpdateProductAttributeDefinition
OBPv4.0.0: createOrUpdateTransactionAttributeDefinition
OBPv4.0.0: createOrUpdateCardAttributeDefinition
OBPv4.0.0: deleteTransactionAttributeDefinition
OBPv4.0.0: deleteCustomerAttributeDefinition
OBPv4.0.0: deleteAccountAttributeDefinition
OBPv4.0.0: deleteProductAttributeDefinition
OBPv4.0.0: deleteCardAttributeDefinition
OBPv4.0.0: getProductAttributeDefinition
OBPv4.0.0: getCustomerAttributeDefinition
OBPv4.0.0: getAccountAttributeDefinition
OBPv4.0.0: getTransactionAttributeDefinition
OBPv4.0.0: getCardAttributeDefinition
OBPv4.0.0: deleteUserCustomerLink
OBPv4.0.0: getUserCustomerLinksByUserId
OBPv4.0.0: getUserCustomerLinksByCustomerId
OBPv4.0.0: deleteTransactionCascade
OBPv4.0.0: deleteAccountCascade
OBPv4.0.0: deleteProductCascade
OBPv4.0.0: getExplictCounterpartyById
OBPv4.0.0: getCounterpartyByNameForAnyAccount
OBPv4.0.0: addConsentUser
OBPv4.0.0: updateConsentStatus

obp.getCustomersByUserId

                            
                                Get Customers represented by the User.
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                OutBoundGetCustomersByUserId
                                InBoundGetCustomersByUserId

                                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"
          }]
        }
      }]
    }
  },
  "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":[{
    "customerId":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "bankId":"gh.29.uk",
    "number":"546387432",
    "legalName":"Eveline Tripman",
    "mobileNumber":"+44 07972 444 876",
    "email":"felixsmith@example.com",
    "faceImage":{
      "date":"2017-09-19T00:00:00Z",
      "url":"http://www.example.com/id-docs/123/image.png"
    },
    "dateOfBirth":"2017-09-19T00:00:00Z",
    "relationshipStatus":"single",
    "dependents":1,
    "dobOfDependents":["2017-09-19T00:00:00Z"],
    "highestEducationAttained":"Master",
    "employmentStatus":"worker",
    "creditRating":{
      "rating":"",
      "source":""
    },
    "creditLimit":{
      "currency":"EUR",
      "amount":"50.89"
    },
    "kycStatus":true,
    "lastOkDate":"2017-09-19T00:00:00Z",
    "title":"Dr.",
    "branchId":"DERBY6",
    "nameSuffix":"Sr"
  }]
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                OBPv2.1.0: getCustomersForCurrentUserAtBank
OBPv3.0.0: getCustomersForUser

obp.getCoreBankAccounts

                            
                                Get bank Accounts available to the User (without Metadata)
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                OutBoundGetCoreBankAccounts
                                InBoundGetCoreBankAccounts

                                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"
          }]
        }
      }]
    }
  },
  "bankIdAccountIds":[{
    "bankId":{
      "value":"gh.29.uk"
    },
    "accountId":{
      "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
    }
  }]
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":[{
    "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
    "label":"My private account for Uber",
    "bankId":"gh.29.uk",
    "accountType":"AC",
    "accountRoutings":[{
      "scheme":"IBAN",
      "address":"DE91 1000 0000 0123 4567 89"
    }]
  }]
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                BGv1: getAccountList
AUv1.0.0: listAccounts
OBPv3.0.0: corePrivateAccountsAllBanks
OBPv3.0.0: privateAccountsAtOneBank
OBPv3.0.0: getPrivateAccountIdsbyBankId
OBPv3.0.0: getAccountsHeld

obp.checkBankAccountExists

                            
                                Check a bank Account exists - as specified by bankId and accountId.
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                OutBoundCheckBankAccountExists
                                InBoundCheckBankAccountExists

                                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"
          }]
        }
      }]
    }
  },
  "bankId":{
    "value":"gh.29.uk"
  },
  "accountId":{
    "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
  }
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "accountId":{
      "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
    },
    "accountType":"AC",
    "balance":"50.89",
    "currency":"EUR",
    "name":"felixsmith",
    "number":"546387432",
    "bankId":{
      "value":"gh.29.uk"
    },
    "lastUpdate":"2022-06-14T07:58:41Z",
    "branchId":"DERBY6",
    "accountRoutings":[{
      "scheme":"IBAN",
      "address":"DE91 1000 0000 0123 4567 89"
    }]
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                BGv1.3: getBalances
BGv1.3: getCardAccountBalances
BGv1.3: getCardAccountTransactionList
BGv1.3: getTransactionDetails
BGv1.3: getTransactionList
BGv1.3: readAccountDetails
BGv1.3: readCardAccount
BGv1.3: getPaymentInitiationStatus
BGv1.3: updatePaymentCancellationPsuData
BGv1.3: updatePaymentPsuData
BGv1: getAccountBalances
BGv1: getTransactionList
STETv1.4: accountsBalancesGet
STETv1.4: accountsTransactionsGet
AUv1.0.0: listBalance
OBPv1.2.1: deleteViewForBankAccount
OBPv1.2.1: addPermissionForUserForBankAccountForMultipleViews
OBPv1.2.1: addPermissionForUserForBankAccountForOneView
OBPv1.2.1: removePermissionForUserForBankAccountForOneView
OBPv1.2.1: removePermissionForUserForBankAccountForAllViews
OBPv1.2.1: getCounterpartyPublicAlias
OBPv1.2.1: addCounterpartyPublicAlias
OBPv1.2.1: addOtherAccountPrivateAlias
OBPv1.2.1: addCounterpartyMoreInfo
OBPv1.2.1: addCounterpartyUrl
OBPv1.2.1: addCounterpartyImageUrl
OBPv1.2.1: addCounterpartyOpenCorporatesUrl
OBPv1.2.1: getTransactionNarrative
OBPv1.2.1: addTransactionNarrative
OBPv1.2.1: updateTransactionNarrative
OBPv1.2.1: deleteTransactionNarrative
OBPv1.2.1: getCommentsForViewOnTransaction
OBPv1.2.1: addCommentForViewOnTransaction
OBPv1.2.1: deleteCommentForViewOnTransaction
OBPv1.2.1: getTagsForViewOnTransaction
OBPv1.2.1: addTagForViewOnTransaction
OBPv1.2.1: deleteTagForViewOnTransaction
OBPv1.2.1: getImagesForViewOnTransaction
OBPv1.2.1: addImageForViewOnTransaction
OBPv1.2.1: deleteImageForViewOnTransaction
OBPv1.2.1: getWhereTagForViewOnTransaction
OBPv1.2.1: addWhereTagForViewOnTransaction
OBPv1.2.1: updateWhereTagForViewOnTransaction
OBPv1.2.1: deleteWhereTagForViewOnTransaction
OBPv1.4.0: getTransactionRequestTypes
OBPv2.0.0: getPermissionsForBankAccount
OBPv2.1.0: createTransactionRequestSandboxTan
OBPv2.1.0: createTransactionRequestCounterparty
OBPv2.1.0: createTransactionRequestSepa
OBPv2.1.0: createTransactionRequestFreeForm
OBPv2.1.0: answerTransactionRequestChallenge
OBPv2.1.0: addCardsForBank
OBPv2.2.0: getViewsForBankAccount
OBPv2.2.0: getExplictCounterpartiesForAccount
OBPv2.2.0: getExplictCounterpartyById
OBPv2.2.0: createCounterparty
OBPv3.0.0: getViewsForBankAccount
OBPv3.0.0: createViewForBankAccount
OBPv3.0.0: getPermissionForUserForBankAccount
OBPv3.0.0: updateViewForBankAccount
OBPv3.0.0: getPrivateAccountById
OBPv3.0.0: getPublicAccountById
OBPv3.0.0: getCoreAccountById
OBPv3.0.0: getFirehoseTransactionsForBankAccount
OBPv3.0.0: getCoreTransactionsForBankAccount
OBPv3.0.0: getTransactionsForBankAccount
OBPv3.0.0: getOtherAccountsForBankAccount
OBPv3.0.0: getOtherAccountByIdForBankAccount
OBPv3.1.0: getCheckbookOrders
OBPv3.1.0: getStatusOfCreditCardOrder
OBPv3.1.0: checkFundsAvailable
OBPv3.1.0: getTransactionByIdForBankAccount
OBPv3.1.0: getTransactionRequests
OBPv3.1.0: createAccountAttribute
OBPv3.1.0: updateAccountAttribute
OBPv3.1.0: updateAccount
OBPv3.1.0: addCardForBank
OBPv3.1.0: updatedCardForBank
OBPv3.1.0: createAccount
OBPv3.1.0: getPrivateAccountByIdFull
OBPv3.1.0: saveHistoricalTransaction
OBPv4.0.0: createTransactionRequestAccount
OBPv4.0.0: createTransactionRequestAccountOtp
OBPv4.0.0: createTransactionRequestCounterparty
OBPv4.0.0: createTransactionRequestSepa
OBPv4.0.0: createTransactionRequestRefund
OBPv4.0.0: createTransactionRequestFreeForm
OBPv4.0.0: createCounterparty
OBPv4.0.0: createCounterpartyForAnyAccount
OBPv4.0.0: getDoubleEntryTransaction
OBPv4.0.0: answerTransactionRequestChallenge
OBPv4.0.0: createTransactionRequestAttribute
OBPv4.0.0: getTransactionRequestAttributeById
OBPv4.0.0: getTransactionRequestAttributes
OBPv4.0.0: updateTransactionRequestAttribute
OBPv4.0.0: updateAccountLabel
OBPv4.0.0: addTagForViewOnAccount
OBPv4.0.0: deleteTagForViewOnAccount
OBPv4.0.0: getTagsForViewOnAccount
OBPv4.0.0: getCoreAccountById
OBPv4.0.0: getPrivateAccountByIdFull
OBPv4.0.0: createDirectDebit
OBPv4.0.0: createDirectDebitManagement
OBPv4.0.0: createStandingOrder
OBPv4.0.0: createStandingOrderManagement
OBPv4.0.0: createTransactionAttribute
OBPv4.0.0: updateTransactionAttribute
OBPv4.0.0: getTransactionAttributes
OBPv4.0.0: getTransactionAttributeById
OBPv4.0.0: getTransactionRequest
OBPv4.0.0: deleteTransactionCascade
OBPv4.0.0: deleteAccountCascade
OBPv4.0.0: getExplictCounterpartiesForAccount
OBPv4.0.0: getExplictCounterpartyById
OBPv4.0.0: getCounterpartyByNameForAnyAccount

obp.getBankAccountsForUser

                            
                                Gets the list of accounts available to the User. This call sends authInfo including username.
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                OutBoundGetBankAccountsForUser
                                InBoundGetBankAccountsForUser

                                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"
          }]
        }
      }]
    }
  },
  "username":"felixsmith"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":[{
    "bankId":"gh.29.uk",
    "accountId":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
    "viewsToGenerate":["Owner","Accountant","Auditor"]
  }]
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                BGv1.3: createConsent
BGv1.3: deleteConsent
BGv1.3: getAccountList
BGv1.3: getBalances
BGv1.3: getCardAccounts
BGv1.3: getCardAccountBalances
BGv1.3: getCardAccountTransactionList
BGv1.3: getConsentAuthorisation
BGv1.3: getConsentInformation
BGv1.3: getConsentScaStatus
BGv1.3: getConsentStatus
BGv1.3: getTransactionDetails
BGv1.3: getTransactionList
BGv1.3: readAccountDetails
BGv1.3: readCardAccount
BGv1.3: startConsentAuthorisation
BGv1.3: updateConsentsPsuData
BGv1.3: checkAvailabilityOfFunds
BGv1.3: cancelPayment
BGv1.3: getPaymentCancellationScaStatus
BGv1.3: getPaymentInformation
BGv1.3: getPaymentInitiationAuthorisation
BGv1.3: getPaymentInitiationCancellationAuthorisationInformation
BGv1.3: getPaymentInitiationScaStatus
BGv1.3: getPaymentInitiationStatus
BGv1.3: initiatePayment
BGv1.3: startPaymentAuthorisation
BGv1.3: startPaymentInitiationCancellationAuthorisation
BGv1.3: updatePaymentCancellationPsuData
BGv1.3: updatePaymentPsuData
BGv1.3: createSigningBasket
BGv1.3: deleteSigningBasket
BGv1.3: getSigningBasket
BGv1.3: getSigningBasketAuthorisation
BGv1.3: getSigningBasketScaStatus
BGv1.3: getSigningBasketStatus
BGv1.3: startSigningBasketAuthorisation
BGv1.3: updateSigningBasketPsuData
BGv1: getAccountList
BGv1: getAccountBalances
BGv1: getTransactionList
STETv1.4: accountsBalancesGet
STETv1.4: accountsGet
STETv1.4: accountsTransactionsGet
STETv1.4: consentsPut
STETv1.4: endUserIdentityGet
STETv1.4: trustedBeneficiariesGet
STETv1.4: fundsConfirmationsPost
STETv1.4: paymentRequestConfirmationPost
STETv1.4: paymentRequestPut
STETv1.4: paymentRequestsGet
STETv1.4: paymentRequestsPost
UKv3.1: createAccountAccessConsents
UKv3.1: deleteAccountAccessConsentsConsentId
UKv3.1: getAccountAccessConsentsConsentId
UKv3.1: getAccounts
UKv3.1: getAccountsAccountId
UKv3.1: getAccountsAccountIdBalances
UKv3.1: getBalances
UKv3.1: getAccountsAccountIdBeneficiaries
UKv3.1: getBeneficiaries
UKv3.1: getAccountsAccountIdDirectDebits
UKv3.1: getDirectDebits
UKv3.1: createDomesticPaymentConsents
UKv3.1: createDomesticPayments
UKv3.1: getDomesticPaymentConsentsConsentId
UKv3.1: getDomesticPaymentConsentsConsentIdFundsConfirmation
UKv3.1: getDomesticPaymentsDomesticPaymentId
UKv3.1: createDomesticScheduledPaymentConsents
UKv3.1: createDomesticScheduledPayments
UKv3.1: getDomesticScheduledPaymentConsentsConsentId
UKv3.1: getDomesticScheduledPaymentsDomesticScheduledPaymentId
UKv3.1: createDomesticStandingOrderConsents
UKv3.1: createDomesticStandingOrders
UKv3.1: getDomesticStandingOrderConsentsConsentId
UKv3.1: getDomesticStandingOrdersDomesticStandingOrderId
UKv3.1: createFilePaymentConsents
UKv3.1: createFilePaymentConsentsConsentIdFile
UKv3.1: createFilePayments
UKv3.1: getFilePaymentConsentsConsentId
UKv3.1: getFilePaymentConsentsConsentIdFile
UKv3.1: getFilePaymentsFilePaymentId
UKv3.1: getFilePaymentsFilePaymentIdReportFile
UKv3.1: createFundsConfirmationConsents
UKv3.1: createFundsConfirmations
UKv3.1: deleteFundsConfirmationConsentsConsentId
UKv3.1: getFundsConfirmationConsentsConsentId
UKv3.1: createInternationalPaymentConsents
UKv3.1: createInternationalPayments
UKv3.1: getInternationalPaymentConsentsConsentId
UKv3.1: getInternationalPaymentConsentsConsentIdFundsConfirmation
UKv3.1: getInternationalPaymentsInternationalPaymentId
UKv3.1: createInternationalScheduledPaymentConsents
UKv3.1: createInternationalScheduledPayments
UKv3.1: getInternationalScheduledPaymentConsentsConsentId
UKv3.1: getInternationalScheduledPaymentConsentsConsentIdFundsConfirmation
UKv3.1: getInternationalScheduledPaymentsInternationalScheduledPaymentId
UKv3.1: createInternationalStandingOrderConsents
UKv3.1: createInternationalStandingOrders
UKv3.1: getInternationalStandingOrderConsentsConsentId
UKv3.1: getInternationalStandingOrdersInternationalStandingOrderPaymentId
UKv3.1: getAccountsAccountIdOffers
UKv3.1: getOffers
UKv3.1: getAccountsAccountIdParty
UKv3.1: getParty
UKv3.1: getAccountsAccountIdProduct
UKv3.1: getProducts
UKv3.1: getAccountsAccountIdScheduledPayments
UKv3.1: getScheduledPayments
UKv3.1: getAccountsAccountIdStandingOrders
UKv3.1: getStandingOrders
UKv3.1: getAccountsAccountIdStatements
UKv3.1: getAccountsAccountIdStatementsStatementId
UKv3.1: getAccountsAccountIdStatementsStatementIdFile
UKv3.1: getAccountsAccountIdStatementsStatementIdTransactions
UKv3.1: getStatements
UKv3.1: getAccountsAccountIdTransactions
UKv3.1: getTransactions
UKv2.0: getAccountList
UKv2.0: getAccountTransactions
UKv2.0: getAccount
UKv2.0: getAccountBalances
UKv2.0: getBalances
AUv1.0.0: getAccountDetail
AUv1.0.0: getTransactionDetail
AUv1.0.0: getTransactions
AUv1.0.0: listBalancesBulk
AUv1.0.0: listBalancesSpecificAccounts
AUv1.0.0: getPayeeDetail
AUv1.0.0: getProductDetail
AUv1.0.0: listAccounts
AUv1.0.0: listBalance
AUv1.0.0: listDirectDebits
AUv1.0.0: listDirectDebitsBulk
AUv1.0.0: listDirectDebitsSpecificAccounts
AUv1.0.0: listPayees
AUv1.0.0: listProducts
AUv1.0.0: listScheduledPayments
AUv1.0.0: listScheduledPaymentsBulk
AUv1.0.0: listScheduledPaymentsSpecificAccounts
AUv1.0.0: getCustomer
AUv1.0.0: getCustomerDetail
AUv1.0.0: getOutages
AUv1.0.0: getStatus
PAPIv2.1.1.1: deleteConsent
PAPIv2.1.1.1: getAccount
PAPIv2.1.1.1: getAccounts
PAPIv2.1.1.1: getHolds
PAPIv2.1.1.1: getTransactionDetail
PAPIv2.1.1.1: getTransactionsCancelled
PAPIv2.1.1.1: getTransactionsDone
PAPIv2.1.1.1: getTransactionsPending
PAPIv2.1.1.1: getTransactionsRejected
PAPIv2.1.1.1: getTransactionsScheduled
PAPIv2.1.1.1: authorize
PAPIv2.1.1.1: authorizeExt
PAPIv2.1.1.1: token
PAPIv2.1.1.1: getConfirmationOfFunds
PAPIv2.1.1.1: bundle
PAPIv2.1.1.1: cancelPayments
PAPIv2.1.1.1: cancelRecurringPayment
PAPIv2.1.1.1: domestic
PAPIv2.1.1.1: eEA
PAPIv2.1.1.1: getBundle
PAPIv2.1.1.1: getMultiplePayments
PAPIv2.1.1.1: getPayment
PAPIv2.1.1.1: getRecurringPayment
PAPIv2.1.1.1: nonEEA
PAPIv2.1.1.1: recurring
PAPIv2.1.1.1: tax
OBPv1.2.1: deleteViewForBankAccount
OBPv1.2.1: addPermissionForUserForBankAccountForMultipleViews
OBPv1.2.1: addPermissionForUserForBankAccountForOneView
OBPv1.2.1: removePermissionForUserForBankAccountForOneView
OBPv1.2.1: removePermissionForUserForBankAccountForAllViews
OBPv1.2.1: getCounterpartyPublicAlias
OBPv1.2.1: addCounterpartyPublicAlias
OBPv1.2.1: addOtherAccountPrivateAlias
OBPv1.2.1: addCounterpartyMoreInfo
OBPv1.2.1: addCounterpartyUrl
OBPv1.2.1: addCounterpartyImageUrl
OBPv1.2.1: addCounterpartyOpenCorporatesUrl
OBPv1.2.1: getTransactionNarrative
OBPv1.2.1: addTransactionNarrative
OBPv1.2.1: updateTransactionNarrative
OBPv1.2.1: deleteTransactionNarrative
OBPv1.2.1: getCommentsForViewOnTransaction
OBPv1.2.1: addCommentForViewOnTransaction
OBPv1.2.1: deleteCommentForViewOnTransaction
OBPv1.2.1: getTagsForViewOnTransaction
OBPv1.2.1: addTagForViewOnTransaction
OBPv1.2.1: deleteTagForViewOnTransaction
OBPv1.2.1: getImagesForViewOnTransaction
OBPv1.2.1: addImageForViewOnTransaction
OBPv1.2.1: deleteImageForViewOnTransaction
OBPv1.2.1: getWhereTagForViewOnTransaction
OBPv1.2.1: addWhereTagForViewOnTransaction
OBPv1.2.1: updateWhereTagForViewOnTransaction
OBPv1.2.1: deleteWhereTagForViewOnTransaction
OBPv1.3.0: getCards
OBPv1.4.0: createCustomerMessage
OBPv1.4.0: getTransactionRequestTypes
OBPv2.0.0: getPrivateAccountsAtOneBank
OBPv2.0.0: corePrivateAccountsAtOneBank
OBPv2.0.0: privateAccountsAtOneBank
OBPv2.0.0: publicAccountsAtOneBank
OBPv2.0.0: getKycDocuments
OBPv2.0.0: getKycMedia
OBPv2.0.0: getKycChecks
OBPv2.0.0: getKycStatuses
OBPv2.0.0: addKycDocument
OBPv2.0.0: addKycMedia
OBPv2.0.0: addKycCheck
OBPv2.0.0: addKycStatus
OBPv2.0.0: getPermissionsForBankAccount
OBPv2.0.0: getTransactionTypes
OBPv2.0.0: addEntitlement
OBPv2.0.0: deleteEntitlement
OBPv2.0.0: getAllEntitlements
OBPv2.1.0: createTransactionRequestSandboxTan
OBPv2.1.0: createTransactionRequestCounterparty
OBPv2.1.0: createTransactionRequestSepa
OBPv2.1.0: createTransactionRequestFreeForm
OBPv2.1.0: answerTransactionRequestChallenge
OBPv2.1.0: getRoles
OBPv2.1.0: getEntitlementsByBankAndUser
OBPv2.1.0: addCardsForBank
OBPv2.1.0: getUsers
OBPv2.1.0: getCustomersForCurrentUserAtBank
OBPv2.1.0: getMetrics
OBPv2.2.0: getViewsForBankAccount
OBPv2.2.0: getCurrentFxRate
OBPv2.2.0: getExplictCounterpartiesForAccount
OBPv2.2.0: getExplictCounterpartyById
OBPv2.2.0: createAccount
OBPv2.2.0: config
OBPv2.2.0: getConnectorMetrics
OBPv2.2.0: createCounterparty
OBPv3.0.0: getViewsForBankAccount
OBPv3.0.0: createViewForBankAccount
OBPv3.0.0: getPermissionForUserForBankAccount
OBPv3.0.0: updateViewForBankAccount
OBPv3.0.0: getPrivateAccountById
OBPv3.0.0: getCoreAccountById
OBPv3.0.0: corePrivateAccountsAllBanks
OBPv3.0.0: getFirehoseAccountsAtOneBank
OBPv3.0.0: getFirehoseTransactionsForBankAccount
OBPv3.0.0: getCoreTransactionsForBankAccount
OBPv3.0.0: getTransactionsForBankAccount
OBPv3.0.0: dataWarehouseSearch
OBPv3.0.0: dataWarehouseStatistics
OBPv3.0.0: getUser
OBPv3.0.0: getUserByUserId
OBPv3.0.0: getUserByUsername
OBPv3.0.0: getAdapterInfoForBank
OBPv3.0.0: getBranch
OBPv3.0.0: getBranches
OBPv3.0.0: getAtm
OBPv3.0.0: getAtms
OBPv3.0.0: getUsers
OBPv3.0.0: getCustomersForUser
OBPv3.0.0: getCurrentUser
OBPv3.0.0: privateAccountsAtOneBank
OBPv3.0.0: getPrivateAccountIdsbyBankId
OBPv3.0.0: getOtherAccountsForBankAccount
OBPv3.0.0: getOtherAccountByIdForBankAccount
OBPv3.0.0: addEntitlementRequest
OBPv3.0.0: getAllEntitlementRequests
OBPv3.0.0: getEntitlementRequests
OBPv3.0.0: getEntitlementRequestsForCurrentUser
OBPv3.0.0: deleteEntitlementRequest
OBPv3.0.0: getEntitlementsForCurrentUser
OBPv3.0.0: getApiGlossary
OBPv3.0.0: getAccountsHeld
OBPv3.0.0: getAggregateMetrics
OBPv3.0.0: addScope
OBPv3.0.0: deleteScope
OBPv3.0.0: getScopes
OBPv3.0.0: getBanks
OBPv3.1.0: getCheckbookOrders
OBPv3.1.0: getStatusOfCreditCardOrder
OBPv3.1.0: createCreditLimitRequest
OBPv3.1.0: getCreditLimitRequests
OBPv3.1.0: getCreditLimitRequestByRequestId
OBPv3.1.0: getTopAPIs
OBPv3.1.0: getMetricsTopConsumers
OBPv3.1.0: getFirehoseCustomers
OBPv3.1.0: getBadLoginStatus
OBPv3.1.0: unlockUser
OBPv3.1.0: callsLimit
OBPv3.1.0: getCallsLimit
OBPv3.1.0: checkFundsAvailable
OBPv3.1.0: getConsumer
OBPv3.1.0: getConsumersForCurrentUser
OBPv3.1.0: getConsumers
OBPv3.1.0: createAccountWebhook
OBPv3.1.0: enableDisableAccountWebhook
OBPv3.1.0: getAccountWebhooks
OBPv3.1.0: config
OBPv3.1.0: getAdapterInfo
OBPv3.1.0: getTransactionByIdForBankAccount
OBPv3.1.0: getTransactionRequests
OBPv3.1.0: createCustomer
OBPv3.1.0: getRateLimitingInfo
OBPv3.1.0: getCustomerByCustomerId
OBPv3.1.0: getCustomerByCustomerNumber
OBPv3.1.0: createUserAuthContext
OBPv3.1.0: getUserAuthContexts
OBPv3.1.0: deleteUserAuthContexts
OBPv3.1.0: deleteUserAuthContextById
OBPv3.1.0: createTaxResidence
OBPv3.1.0: getTaxResidence
OBPv3.1.0: deleteTaxResidence
OBPv3.1.0: getAllEntitlements
OBPv3.1.0: createCustomerAddress
OBPv3.1.0: updateCustomerAddress
OBPv3.1.0: getCustomerAddresses
OBPv3.1.0: deleteCustomerAddress
OBPv3.1.0: getObpConnectorLoopback
OBPv3.1.0: refreshUser
OBPv3.1.0: createProductAttribute
OBPv3.1.0: getProductAttribute
OBPv3.1.0: updateProductAttribute
OBPv3.1.0: deleteProductAttribute
OBPv3.1.0: createAccountApplication
OBPv3.1.0: getAccountApplications
OBPv3.1.0: getAccountApplication
OBPv3.1.0: updateAccountApplicationStatus
OBPv3.1.0: createProduct
OBPv3.1.0: getProduct
OBPv3.1.0: getProductTree
OBPv3.1.0: getProducts
OBPv3.1.0: createAccountAttribute
OBPv3.1.0: updateAccountAttribute
OBPv3.1.0: createProductCollection
OBPv3.1.0: getProductCollection
OBPv3.1.0: deleteBranch
OBPv3.1.0: createMeeting
OBPv3.1.0: getMeetings
OBPv3.1.0: getMeeting
OBPv3.1.0: getServerJWK
OBPv3.1.0: getMessageDocsSwagger
OBPv3.1.0: createConsentEmail
OBPv3.1.0: createConsentSms
OBPv3.1.0: answerConsentChallenge
OBPv3.1.0: getConsents
OBPv3.1.0: revokeConsent
OBPv3.1.0: createUserAuthContextUpdateRequest
OBPv3.1.0: answerUserAuthContextUpdateChallenge
OBPv3.1.0: getSystemView
OBPv3.1.0: createSystemView
OBPv3.1.0: deleteSystemView
OBPv3.1.0: updateSystemView
OBPv3.1.0: getOAuth2ServerJWKsURIs
OBPv3.1.0: getMethodRoutings
OBPv3.1.0: createMethodRouting
OBPv3.1.0: updateMethodRouting
OBPv3.1.0: deleteMethodRouting
OBPv3.1.0: updateCustomerEmail
OBPv3.1.0: updateCustomerNumber
OBPv3.1.0: updateCustomerMobileNumber
OBPv3.1.0: updateCustomerIdentity
OBPv3.1.0: updateCustomerCreditLimit
OBPv3.1.0: updateCustomerCreditRatingAndSource
OBPv3.1.0: updateAccount
OBPv3.1.0: addCardForBank
OBPv3.1.0: updatedCardForBank
OBPv3.1.0: getCardsForBank
OBPv3.1.0: getCardForBank
OBPv3.1.0: deleteCardForBank
OBPv3.1.0: createCardAttribute
OBPv3.1.0: updateCardAttribute
OBPv3.1.0: updateCustomerBranch
OBPv3.1.0: updateCustomerData
OBPv3.1.0: createAccount
OBPv3.1.0: getPrivateAccountByIdFull
OBPv3.1.0: saveHistoricalTransaction
OBPv3.1.0: getWebUiProps
OBPv3.1.0: createWebUiProps
OBPv3.1.0: deleteWebUiProps
OBPv3.1.0: getBankAccountsBalances
OBPv3.1.0: enableDisableConsumers
OBPv4.0.0: dynamicEntity_getTESTINGList
OBPv4.0.0: dynamicEntity_getSingleTESTING
OBPv4.0.0: dynamicEntity_createTESTING
OBPv4.0.0: dynamicEntity_updateTESTING
OBPv4.0.0: dynamicEntity_deleteTESTING
OBPv4.0.0: dynamicEntity_getcreditApplicationFormList
OBPv4.0.0: dynamicEntity_getSinglecreditApplicationForm
OBPv4.0.0: dynamicEntity_createcreditApplicationForm
OBPv4.0.0: dynamicEntity_updatecreditApplicationForm
OBPv4.0.0: dynamicEntity_deletecreditApplicationForm
OBPv4.0.0: dynamicEndpoint_GET_banks
OBPv4.0.0: dynamicEndpoint_POST_save
OBPv4.0.0: dynamicEndpoint_GET_getById_USER_ID
OBPv4.0.0: dynamicEndpoint_GET_listUsers
OBPv4.0.0: dynamicEndpoint_PUT_updateUser
OBPv4.0.0: dynamicEndpoint_DELETE_delete_USER_ID
OBPv4.0.0: root
OBPv4.0.0: getMapperDatabaseInfo
OBPv4.0.0: getLogoutLink
OBPv4.0.0: getBanks
OBPv4.0.0: ibanChecker
OBPv4.0.0: getDoubleEntryTransaction
OBPv4.0.0: createSettlementAccount
OBPv4.0.0: getSettlementAccounts
OBPv4.0.0: createTransactionRequestAccount
OBPv4.0.0: createTransactionRequestAccountOtp
OBPv4.0.0: createTransactionRequestCounterparty
OBPv4.0.0: createTransactionRequestSepa
OBPv4.0.0: createTransactionRequestRefund
OBPv4.0.0: createTransactionRequestFreeForm
OBPv4.0.0: answerTransactionRequestChallenge
OBPv4.0.0: createTransactionRequestAttribute
OBPv4.0.0: getTransactionRequestAttributeById
OBPv4.0.0: getTransactionRequestAttributes
OBPv4.0.0: updateTransactionRequestAttribute
OBPv4.0.0: createOrUpdateTransactionRequestAttributeDefinition
OBPv4.0.0: getTransactionRequestAttributeDefinition
OBPv4.0.0: deleteTransactionRequestAttributeDefinition
OBPv4.0.0: getDynamicEntities
OBPv4.0.0: getBankLevelDynamicEntities
OBPv4.0.0: deleteDynamicEntity
OBPv4.0.0: getMyDynamicEntities
OBPv4.0.0: deleteMyDynamicEntity
OBPv4.0.0: resetPasswordUrl
OBPv4.0.0: addAccount
OBPv4.0.0: getCallContext
OBPv4.0.0: updateAccountLabel
OBPv4.0.0: lockUser
OBPv4.0.0: getEntitlements
OBPv4.0.0: getEntitlementsForBank
OBPv4.0.0: addTagForViewOnAccount
OBPv4.0.0: deleteTagForViewOnAccount
OBPv4.0.0: getTagsForViewOnAccount
OBPv4.0.0: getCoreAccountById
OBPv4.0.0: getPrivateAccountByIdFull
OBPv4.0.0: getAccountByAccountRouting
OBPv4.0.0: getBankAccountsBalances
OBPv4.0.0: getFirehoseAccountsAtOneBank
OBPv4.0.0: getCustomersByCustomerPhoneNumber
OBPv4.0.0: createBank
OBPv4.0.0: createDirectDebit
OBPv4.0.0: createDirectDebitManagement
OBPv4.0.0: createStandingOrder
OBPv4.0.0: createStandingOrderManagement
OBPv4.0.0: grantUserAccessToView
OBPv4.0.0: revokeUserAccessToView
OBPv4.0.0: revokeGrantUserAccessToViews
OBPv4.0.0: createCustomerAttribute
OBPv4.0.0: updateCustomerAttribute
OBPv4.0.0: getCustomerAttributes
OBPv4.0.0: getCustomerAttributeById
OBPv4.0.0: getCustomersByAttributes
OBPv4.0.0: createTransactionAttribute
OBPv4.0.0: updateTransactionAttribute
OBPv4.0.0: getTransactionAttributes
OBPv4.0.0: getTransactionAttributeById
OBPv4.0.0: getTransactionRequest
OBPv4.0.0: getPrivateAccountsAtOneBank
OBPv4.0.0: createConsumer
OBPv4.0.0: deleteCustomerAttribute
OBPv4.0.0: createDynamicEndpoint
OBPv4.0.0: getDynamicEndpoint
OBPv4.0.0: getDynamicEndpoints
OBPv4.0.0: deleteDynamicEndpoint
OBPv4.0.0: getMyDynamicEndpoints
OBPv4.0.0: deleteMyDynamicEndpoint
OBPv4.0.0: createOrUpdateCustomerAttributeAttributeDefinition
OBPv4.0.0: createOrUpdateAccountAttributeDefinition
OBPv4.0.0: createOrUpdateProductAttributeDefinition
OBPv4.0.0: createOrUpdateTransactionAttributeDefinition
OBPv4.0.0: createOrUpdateCardAttributeDefinition
OBPv4.0.0: deleteTransactionAttributeDefinition
OBPv4.0.0: deleteCustomerAttributeDefinition
OBPv4.0.0: deleteAccountAttributeDefinition
OBPv4.0.0: deleteProductAttributeDefinition
OBPv4.0.0: deleteCardAttributeDefinition
OBPv4.0.0: getProductAttributeDefinition
OBPv4.0.0: getCustomerAttributeDefinition
OBPv4.0.0: getAccountAttributeDefinition
OBPv4.0.0: getTransactionAttributeDefinition
OBPv4.0.0: getCardAttributeDefinition
OBPv4.0.0: deleteUserCustomerLink
OBPv4.0.0: getUserCustomerLinksByUserId
OBPv4.0.0: getUserCustomerLinksByCustomerId
OBPv4.0.0: deleteTransactionCascade
OBPv4.0.0: deleteAccountCascade
OBPv4.0.0: deleteProductCascade
OBPv4.0.0: createCounterparty
OBPv4.0.0: createCounterpartyForAnyAccount
OBPv4.0.0: getExplictCounterpartiesForAccount
OBPv4.0.0: getExplictCounterpartyById
OBPv4.0.0: getCounterpartyByNameForAnyAccount
OBPv4.0.0: addConsentUser
OBPv4.0.0: updateConsentStatus
OBPv4.0.0: getScannedApiVersions
OBPv4.0.0: createJsonSchemaValidation
OBPv4.0.0: updateJsonSchemaValidation
OBPv4.0.0: deleteJsonSchemaValidation
OBPv4.0.0: getJsonSchemaValidation
OBPv4.0.0: getAllJsonSchemaValidation
OBPv4.0.0: createAuthenticationTypeValidation
OBPv4.0.0: updateAuthenticationTypeValidation
OBPv4.0.0: deleteAuthenticationTypeValidation
OBPv4.0.0: getAuthenticationTypeValidation
OBPv4.0.0: getAllAuthenticationTypeValidation
OBPv4.0.0: createDynamicEntity
OBPv4.0.0: updateDynamicEntity
OBPv4.0.0: updateMyDynamicEntity

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
                                OutBoundGetTransactions
                                InBoundGetTransactions

                                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"
          }]
        }
      }]
    }
  },
  "bankId":{
    "value":"gh.29.uk"
  },
  "accountId":{
    "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
  },
  "limit":100,
  "offset":100,
  "fromDate":"2017-09-19",
  "toDate":"2017-09-19"
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":[{
    "id":{
      "value":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub"
    },
    "thisAccount":{
      "accountId":{
        "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
      },
      "accountType":"AC",
      "balance":"50.89",
      "currency":"EUR",
      "name":"felixsmith",
      "label":"My Account",
      "number":"546387432",
      "bankId":{
        "value":"gh.29.uk"
      },
      "lastUpdate":"2022-06-14T07:58:41Z",
      "branchId":"DERBY6",
      "accountRoutings":[{
        "scheme":"IBAN",
        "address":"DE91 1000 0000 0123 4567 89"
      }],
      "accountRules":[],
      "accountHolder":""
    },
    "otherAccount":{
      "kind":"",
      "counterpartyId":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh",
      "counterpartyName":"John Smith Ltd.",
      "thisBankId":{
        "value":"gh.29.uk"
      },
      "thisAccountId":{
        "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
      },
      "isBeneficiary":true
    },
    "transactionType":"DEBIT",
    "amount":"50.89",
    "currency":"EUR",
    "description":"For the piano lesson in June 2018 - Invoice No: 68",
    "startDate":"2017-09-19T00:00:00Z",
    "finishDate":"2017-09-19T00:00:00Z",
    "balance":"50.89"
  }]
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                BGv1.3: getCardAccountTransactionList
BGv1.3: getTransactionList
UKv3.1: getAccountsAccountIdTransactions
OBPv3.0.0: getTransactionsForBankAccount

obp.getTransaction

                            
                                Get a single Transaction specified by bankId, accountId and transactionId
    
                                Kafka/Akka
                                Outbound
                                Inbound
    
                                Topic
                                OutBoundGetTransaction
                                InBoundGetTransaction

                                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"
          }]
        }
      }]
    }
  },
  "bankId":{
    "value":"gh.29.uk"
  },
  "accountId":{
    "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
  },
  "transactionId":{
    "value":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub"
  }
}
                                {
  "inboundAdapterCallContext":{
    "correlationId":"1flssoftxq0cr1nssr68u0mioj",
    "sessionId":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50",
    "generalContext":[{
      "key":"CustomerNumber",
      "value":"5987953"
    }]
  },
  "status":{
    "errorCode":"Status errorCode",
    "backendMessages":[{
      "source":"String",
      "status":"String",
      "errorCode":"String",
      "text":"String"
    }]
  },
  "data":{
    "id":{
      "value":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub"
    },
    "thisAccount":{
      "accountId":{
        "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
      },
      "accountType":"AC",
      "balance":"50.89",
      "currency":"EUR",
      "name":"felixsmith",
      "label":"My Account",
      "number":"546387432",
      "bankId":{
        "value":"gh.29.uk"
      },
      "lastUpdate":"2022-06-14T07:58:41Z",
      "branchId":"DERBY6",
      "accountRoutings":[{
        "scheme":"IBAN",
        "address":"DE91 1000 0000 0123 4567 89"
      }],
      "accountRules":[],
      "accountHolder":""
    },
    "otherAccount":{
      "kind":"",
      "counterpartyId":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh",
      "counterpartyName":"John Smith Ltd.",
      "thisBankId":{
        "value":"gh.29.uk"
      },
      "thisAccountId":{
        "value":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
      },
      "isBeneficiary":true
    },
    "transactionType":"DEBIT",
    "amount":"50.89",
    "currency":"EUR",
    "description":"For the piano lesson in June 2018 - Invoice No: 68",
    "startDate":"2017-09-19T00:00:00Z",
    "finishDate":"2017-09-19T00:00:00Z",
    "balance":"50.89"
  }
}

                                Required 
Fields
                                
                                {
  
}

                                Dependent
Endpoints
                                BGv1.3: getTransactionDetails
OBPv3.1.0: getTransactionByIdForBankAccount
OBPv4.0.0: getDoubleEntryTransaction
OBPv4.0.0: createTransactionRequestAccount
OBPv4.0.0: createTransactionRequestAccountOtp
OBPv4.0.0: createTransactionRequestCounterparty
OBPv4.0.0: createTransactionRequestSepa
OBPv4.0.0: createTransactionRequestRefund
OBPv4.0.0: createTransactionRequestFreeForm
OBPv4.0.0: createTransactionAttribute
OBPv4.0.0: updateTransactionAttribute
OBPv4.0.0: getTransactionAttributes
OBPv4.0.0: getTransactionAttributeById
OBPv4.0.0: deleteTransactionCascade