Sign in

v1

latestOpenAPI 3.1.0© Modulr Finance2026-08-04207430590.4 KB
Variable Recurring Payments

Create a VRP consent

Create a Variable Recurring Payment (VRP) consent for authorisation by the payment service user. The consent can then be used to initiate one or more payments within the payment constraints specified.

post/vrp-consents

Request body

aspspIdstring required

Identifier of the payer’s ASPSP where the consent will be created. The ASPSP must have the "SWEEPING" or "COMMERCIAL" capability enabled (which can be checked using our API).

validFromDatestring date-time

Start date time from which payments can be initiated using this consent. Must be specified using YYYY-MM-DDTHH:mm:ssZ format.

validToDatestring date-time

End date time after which payments cannot be initiated using this consent. Must be specified using YYYY-MM-DDTHH:mm:ssZ format.

type'SWEEPING' | 'CVRP1' required

Type of VRP consent that will be created.

referencestring required

Reference to be used for the Consent. This will appear on the Account statement/the recipient's bank account. Min 6 to max 18 characters. Can contain alphanumeric, '-', '.', '&', '/' and space.

interactionTypesstring[]

List of PSU interaction types permitted under this consent. Mandatory for CVRP consent type. Must be one or both of IN_SESSION (customer is present), OFF_SESSION (customer is not present)

Example request

{
  "aspspId": "H100000001",
  "destination": {
    "id": "A1100001",
    "accountNumber": "12345678",
    "sortCode": "000000",
    "name": "Test"
  },
  "validFromDate": "2022-01-31T20:16:01.90Z",
  "validToDate": "2022-07-31T20:16:01.90Z",
  "reference": "Invoice ABC123",
  "ultimateCreditor": {
    "postalAddress": {
      "country": "GB"
    }
  },
  "ultimateDebtor": {
    "postalAddress": {
      "country": "GB"
    }
  },
  "risk": {
    "deliveryAddress": {
      "country": "GB"
    }
  }
}

Response

Created

vrpConsentInitiationIdstring

The unique identifier of the VRP consent initiation request at Modulr

redirectUrlstring

A redirect URL for the user to authorise the payment initiation request at the ASPSP

Example response

{
  "vrpConsentInitiationId": "E210000004",
  "redirectUrl": "https://www.bankofmoney.com/authorize"
}