v1

latestOpenAPI 3.0.02026-07-2412592575.3 KB

payments

Retrieve all standing orders created by an API client

Requires payment:read scope.

get/standing-orders

Query parameters

limitinteger

The total number of records to retrieve

offsetinteger

The offset at which to start retrieving records

userIdstring

The ID of the user to filter transactions on

Response

Successful Standing Order Response

Example response

{
  "data": [
    {
      "id": "c390a94f-2309-4cdf-8d02-b0c5304d9f66",
      "createdAt": "2020-07-10T12:00:00+00:00",
      "updatedAt": "2020-07-10T12:00:00+00:00",
      "standingOrder": {
        "id": "d4c69cda-cd58-4bd3-b950-b085d97cc629",
        "frequency": {
          "repeat": "Daily",
          "day": 1,
          "week": 1,
          "month": 1
        },
        "numberOfPayments": 5,
        "firstPaymentDate": "2020-11-02T00:00:00.000Z",
        "recurringPaymentDate": "2020-12-02T00:00:00.000Z",
        "finalPaymentDate": "2021-01-02T00:00:00.000Z",
        "firstPaymentAmount": 2000,
        "recurringPaymentAmount": 1000,
        "finalPaymentAmount": 999,
        "currency": "GBP",
        "payee": {
          "name": "Payee Name",
          "sortCodeAccountNumber": "60161331926819",
          "iban": "GB2960161331926819",
          "pan": "1234567812345678"
        }
      }
    }
  ]
}