accounts

Update a single account

Requires accounts:read and accounts:write:all scopes.

patch/accounts/{accountId}

Request

  • Base URL
    https://api.moneyhub.co.uk/v3
  • URL
    https://api.moneyhub.co.uk/v3/accounts/{accountId}
  • Auth
    API key in header Authorization

Path parameters

accountIdstring uuid required

The Account Id

Request body

accountNamestring required

The name of the account

providerNamestring required

The name of the provider of the account.

Example request

{
  "accountName": "Account name",
  "providerName": "Provider name",
  "details": {
    "AER": 1.3,
    "APR": 13.1,
    "creditLimit": 150000,
    "endDate": "2020-01-01",
    "fixedDate": "2019-01-01",
    "interestFreePeriod": 12,
    "interestType": "fixed",
    "linkedProperty": "ac9bd177-d01e-449c-9f29-d3656d2edc2e",
    "monthlyRepayment": 60000,
    "overdraftLimit": 150000,
    "postcode": "bs1 1aa",
    "runningCost": 20000,
    "runningCostPeriod": "month",
    "term": 13,
    "yearlyAppreciation": -10
  }
}

Response

Successful Account Response

metaobject

Example response

{
  "data": {
    "accountName": "Cash ISA",
    "currency": "GBP",
    "balance": {
      "date": "2018-08-12",
      "amount": {
        "value": 300023,
        "majorUnits": 3000,
        "minorUnits": 23,
        "currency": "GBP"
      },
      "type": "InterimAvailable"
    },
    "details": {
      "AER": 1.3,
      "APR": 13.1,
      "sortCodeAccountNumber": "60161331926819",
      "iban": "GB2960161331926819",
      "pan": "5498572687746087",
      "creditLimit": 150000,
      "endDate": "2020-01-01",
      "fixedDate": "2019-01-01",
      "interestFreePeriod": 12,
      "interestType": "fixed",
      "linkedProperty": "ac9bd177-d01e-449c-9f29-d3656d2edc2e",
      "monthlyRepayment": 60000,
      "overdraftLimit": 150000,
      "postcode": "bs1 1aa",
      "runningCost": 20000,
      "runningCostPeriod": "month",
      "term": 13,
      "yearlyAppreciation": -10
    },
    "transactionData": {
      "count": 6,
      "earliestDate": "2017-11-28T00:00:00.000Z",
      "lastDate": "2018-05-28T00:00:00.000Z"
    },
    "dateAdded": "2018-07-10T11:39:44.000Z",
    "dateModified": "2018-07-10T11:39:44.000Z",
    "id": "ac9bd177-d01e-449c-9f29-d3656d2edc2e",
    "providerName": "HSBC",
    "providerReference": "hsbc",
    "connectionId": "049c10ab871e8d60aa891c0ae368322d:639cf079-a585-4852-8b4d-1ebd17f4d2cb",
    "providerId": "049c10ab871e8d60aa891c0ae368322d",
    "providerAccountId": "3572357243",
    "providerParentAccountId": "3572357243",
    "providerAccountName": "Account Name",
    "accountReference": "3201",
    "accountHolderName": "Mr Rob Ike",
    "accountOpeningDate": "2002-03-07T00:00:00.000Z",
    "accountType": "personal",
    "productName": "Personal Supercharged Savings Account",
    "providerAccountIdentifications": [
      {
        "identification": "SAVINGR12345678",
        "type": "UK.Santander.SavingsRollNumber"
      }
    ],
    "type": "cash:current",
    "performanceScore": {
      "totals": {
        "openingBalance": {
          "date": "2018-08-12",
          "amount": {
            "value": 300023,
            "majorUnits": 3000,
            "minorUnits": 23,
            "currency": "GBP"
          }
        },
        "currentBalance": {
          "date": "2018-08-12",
          "amount": {
            "value": 300023,
            "majorUnits": 3000,
            "minorUnits": 23,
            "currency": "GBP"
          }
        },
        "contributions": 240098,
        "withdrawals": 20067,
        "nonContributionGrowth": 340054,
        "growthRate": 35.98,
        "annualisedGrowthRate": 60.98
      },
      "months": [
        {
          "date": "2018-08",
          "openingBalance": 300023,
          "nonContributionGrowth": 1567,
          "aer": 35.98
        }
      ]
    },
    "additionalBalances": [
      {
        "date": "2018-08-12",
        "amount": {
          "value": 300023,
          "majorUnits": 3000,
          "minorUnits": 23,
          "currency": "GBP"
        },
        "type": "InterimAvailable"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.