payments

Retrieve a single recurring payment

Changed on Nov 3, 2026

Requires recurring-payment:read scope.

get/recurring-payments/{recurringPaymentId}

Request

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

Path parameters

recurringPaymentIdstring uuid required

The recurring payment Id

Response

Successful Recurring Payment response

metaobject

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

Nov 3, 2026e004d9ee1fdb Revision 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
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status

Operation history