v1

latestOpenAPI 3.0.02026-07-2412592575.3 KB
standing orders

Retrieve the standing orders for an account

Requires accounts:read and either of standing_orders:read or standing_orders_detail:read scopes.

get/accounts/{accountId}/standing-orders

Path parameters

accountIdstring uuid required

The Account Id

Response

Successful Standing Orders Response

metaobject

Example response

{
  "data": [
    {
      "id": "d4c69cda-cd58-4bd3-b950-b085d97cc629",
      "frequency": {
        "repeat": "Daily",
        "day": 1,
        "week": 1,
        "month": 1
      },
      "numberOfPayments": 5,
      "firstPaymentDate": "2020-11-02T00:00:00.000Z",
      "nextPaymentDate": "2020-12-02T00:00:00.000Z",
      "finalPaymentDate": "2021-01-02T00:00:00.000Z",
      "firstPaymentAmount": {
        "value": 2000,
        "majorUnits": 20,
        "currency": "GBP"
      },
      "nextPaymentAmount": {
        "value": 1000,
        "majorUnits": 10,
        "currency": "GBP"
      },
      "finalPaymentAmount": {
        "value": 999,
        "majorUnits": 99,
        "minorUnits": 9,
        "currency": "GBP"
      },
      "currency": "GBP",
      "payee": {
        "name": "Payee Name",
        "sortCodeAccountNumber": "60161331926819",
        "iban": "GB2960161331926819",
        "pan": "1234567812345678"
      }
    }
  ]
}