---
title: "Creates a payment against a recurring payment consent"
method: POST
path: "/recurring-payments/{recurringPaymentId}/pay"
tags: ["payments"]
---

# Creates a payment against a recurring payment consent

`POST /recurring-payments/{recurringPaymentId}/pay`

Requires **recurring-payment:create** scope.

## Path parameters

- `recurringPaymentId` string, uuid, required

## Request body

- PaymentsClaims
  - `amount` integer — Payment amount in minor units of the currency, eg. pennies for GBP.
  - `payeeId` string, uuid — Payee id
  - `payeeType` 'api-payee' | 'mh-user-account' — Type of payee
  - `payerId` string — Payer Id
  - `payerRef` string — Reference to display on payer's statement
  - `payerType` 'mh-user-account' | 'api-payer' — Payer Type
  - `payerName` string — Payer name
  - `payerEmail` string, email — Payer email
  - `readRefundAccount` boolean — Determines whether to read the refund account details
  - `endToEndId` string — Unique identifier relevant to the transaction - Allowed characters (a-zA-Z0-9 :-).

## Response `200`

Successful recurring payment submission response

- object
  - `data` RecurringPaymentSubmission
    - `paymentSubmissionId` string, required — ASPSP submission id for the recurring payment
    - `submittedAt` string, date-time, required — The date that the recurring payment was submitted
    - `status` 'inProgress' | 'pending' | 'completed' | 'cancelled' | 'rejected' | 'abandoned' | 'error:paymentSubmission' | 'error:redirect' | 'error:tokenGrant', required — The status of the payment
    - `providerStatus` string — The status of the payment as reported by the ASPSP
    - `authRequestId` string, uuid, required — Use with GET /payments/{authRequestId} to retrieve the full Payment resource
    - `vrpPaymentMetadata` object
      - `vrpSubmissionUrl` string — The VRP submission URL used for this payment
      - `openBankingApiVersion` string — The Open Banking API version used for this payment
  - `meta` object

## Other responses

- `401` — Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token
- `403` — Unsuccessful Response - Forbidden - Invalid scopes
- `404` — Unsuccessful Response - Resource Not found

---

[API](https://skmtc.net/moneyhubenterprise/apis/moneyhub-identity-service.md) · [All operations](https://skmtc.net/moneyhubenterprise/apis/moneyhub-identity-service/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/moneyhubenterprise/moneyhub-identity-service/revisions/8841721f7aae/schema)