MOmoneyhubenterprise
payments

Retrieve all recurring payments created by an API client

Changed on

Requires recurring-payment:read scope.

get/recurring-payments

Request

  • Base URL
    https://identity.moneyhub.co.uk
  • URL
    https://identity.moneyhub.co.uk/recurring-payments
  • Auth
    API key in header Authorization

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 Recurring Payment 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",
      "revokedAt": "2020-07-10T12:00:00+00:00",
      "recurringPayment": {
        "validFromDate": "2020-12-02T00:00:00.000Z",
        "validToDate": "2021-01-02T00:00:00.000Z",
        "maximumIndividualAmount": 2000,
        "currency": "GBP",
        "periodicLimits": [
          {
            "amount": 100,
            "currency": "GBP"
          }
        ]
      }
    }
  ]
}

Changes

  • e004d9ee1fdbRevision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status