MOmoneyhubenterprise
payments

Creates a payment against a recurring payment consent

Changed on

Requires recurring-payment:create scope.

post/recurring-payments/{recurringPaymentId}/pay

Request

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

Path parameters

recurringPaymentIdstring uuid required

The recurring payment Id

Request body

amountinteger

Payment amount in minor units of the currency, eg. pennies for GBP.

payeeIdstring uuid

Payee id

payeeType'api-payee' | 'mh-user-account'

Type of payee

payerIdstring

Payer Id

payerRefstring

Reference to display on payer's statement

payerType'mh-user-account' | 'api-payer'

Payer Type

payerNamestring

Payer name

payerEmailstring email

Payer email

readRefundAccountboolean

Determines whether to read the refund account details

endToEndIdstring

Unique identifier relevant to the transaction - Allowed characters (a-zA-Z0-9 :-).

Example request

{
  "amount": 1500,
  "payeeId": "bb1c7ebf-24a3-4e06-afc7-599de43b7bad",
  "payeeType": "api-payee",
  "payerId": "5f50bf05ab5bf185d5c94fb5:0bcdf548-24e7-4ebe-bee5-ab4fd2b6b22b",
  "payerRef": "Payer ref",
  "payerName": "John Smith",
  "payerEmail": "john.smith@gmail.com",
  "endToEndId": "moneyhub-2023"
}

Response

Successful recurring payment submission response

metaobject

Example response

{
  "data": {
    "paymentSubmissionId": "1429d113-5ba2-452a-bcc4-2eb1c84a3f98",
    "submittedAt": "2020-07-10T12:10:32.362Z",
    "status": "complete",
    "providerStatus": "AcceptedSettlementInProcess",
    "authRequestId": "c390a94f-2309-4cdf-8d02-b0c5304d9f66"
  }
}

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

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status