API Explorer

obp.getBranch

Get Branch

Format Dec2018 Group Core Suggested order 1

Outbound message (OBP to adapter)
{
  "outboundAdapterCallContext": {
    "correlationId": "1flssoftxq0cr1nssr68u0mioj",
    "outboundAdapterAuthInfo": {
      "userId": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
      "username": "felixsmith",
      "linkedCustomers": [
        {
          "customerId": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
          "customerNumber": "5987953",
          "legalName": "Eveline Tripman"
        }
      ],
      "userAuthContext": [
        {
          "key": "CustomerNumber",
          "value": "5987953"
        }
      ],
      "authViews": [
        {
          "view": {
            "id": "owner",
            "name": "owner",
            "description": "This view is for the owner for the account."
          },
          "account": {
            "id": "8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
            "accountRoutings": [
              {
                "scheme": "IBAN",
                "address": "DE91 1000 0000 0123 4567 89"
              }
            ],
            "customerOwners": [
              {
                "bankId": "gh.29.uk",
                "customerId": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
                "customerNumber": "5987953",
                "legalName": "Eveline Tripman",
                "dateOfBirth": "2018-03-09T00:00:00Z"
              }
            ],
            "userOwners": [
              {
                "userId": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
                "emailAddress": "felixsmith@example.com",
                "name": "felixsmith"
              }
            ]
          }
        }
      ]
    },
    "outboundAdapterConsenterInfo": {
      "userId": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
      "username": "felixsmith",
      "linkedCustomers": [
        {
          "customerId": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
          "customerNumber": "5987953",
          "legalName": "Eveline Tripman"
        }
      ],
      "userAuthContext": [
        {
          "key": "CustomerNumber",
          "value": "5987953"
        }
      ],
      "authViews": [
        {
          "view": {
            "id": "owner",
            "name": "owner",
            "description": "This view is for the owner for the account."
          },
          "account": {
            "id": "8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
            "accountRoutings": [
              {
                "scheme": "IBAN",
                "address": "DE91 1000 0000 0123 4567 89"
              }
            ],
            "customerOwners": [
              {
                "bankId": "gh.29.uk",
                "customerId": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
                "customerNumber": "5987953",
                "legalName": "Eveline Tripman",
                "dateOfBirth": "2018-03-09T00:00:00Z"
              }
            ],
            "userOwners": [
              {
                "userId": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
                "emailAddress": "felixsmith@example.com",
                "name": "felixsmith"
              }
            ]
          }
        }
      ]
    }
  },
  "bankId": {
    "value": "gh.29.uk"
  },
  "branchId": {
    "value": "DERBY6"
  }
}
Inbound message (adapter to OBP)
{
  "inboundAdapterCallContext": {
    "correlationId": "1flssoftxq0cr1nssr68u0mioj"
  },
  "status": {
    "errorCode": "Status errorCode",
    "backendMessages": [
      {
        "source": "",
        "status": "",
        "errorCode": "",
        "text": "",
        "duration": "5.123"
      }
    ]
  },
  "data": {
    "branchId": {
      "value": "DERBY6"
    },
    "bankId": {
      "value": "gh.29.uk"
    },
    "name": "ACCOUNT_MANAGEMENT_FEE",
    "address": {
      "line1": "",
      "line2": "",
      "line3": "",
      "city": "",
      "county": "",
      "state": "",
      "postCode": "789",
      "countryCode": "1254"
    },
    "location": {
      "latitude": 38.8951,
      "longitude": -77.0364,
      "date": "2020-01-27T00:00:00Z",
      "user": {
        "userId": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
        "provider": "ETHEREUM",
        "username": "felixsmith"
      }
    },
    "lobbyString": {
      "hours": "string"
    },
    "driveUpString": {
      "hours": "string"
    },
    "meta": {
      "license": {
        "id": "ODbL-1.0",
        "name": "Open Database License"
      }
    },
    "branchRouting": {
      "scheme": "BRANCH-CODE",
      "address": "DERBY6"
    },
    "lobby": {
      "monday": [
        {
          "openingTime": "",
          "closingTime": "2020-01-27"
        }
      ],
      "tuesday": [
        {
          "openingTime": "",
          "closingTime": "2020-01-27"
        }
      ],
      "wednesday": [
        {
          "openingTime": "",
          "closingTime": "2020-01-27"
        }
      ],
      "thursday": [
        {
          "openingTime": "",
          "closingTime": "2020-01-27"
        }
      ],
      "friday": [
        {
          "openingTime": "",
          "closingTime": "2020-01-27"
        }
      ],
      "saturday": [
        {
          "openingTime": "",
          "closingTime": "2020-01-27"
        }
      ],
      "sunday": [
        {
          "openingTime": "",
          "closingTime": "2020-01-27"
        }
      ]
    },
    "driveUp": {
      "monday": {
        "openingTime": "",
        "closingTime": "2020-01-27"
      },
      "tuesday": {
        "openingTime": "",
        "closingTime": "2020-01-27"
      },
      "wednesday": {
        "openingTime": "",
        "closingTime": "2020-01-27"
      },
      "thursday": {
        "openingTime": "",
        "closingTime": "2020-01-27"
      },
      "friday": {
        "openingTime": "",
        "closingTime": "2020-01-27"
      },
      "saturday": {
        "openingTime": "",
        "closingTime": "2020-01-27"
      },
      "sunday": {
        "openingTime": "",
        "closingTime": "2020-01-27"
      }
    },
    "isAccessible": false,
    "accessibleFeatures": "string",
    "branchType": "",
    "moreInfo": "More information about this fee",
    "phoneNumber": "",
    "isDeleted": true
  }
}