Sign in

v1

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

Get VRP consent.

Returns information about a given Variable Recurring Payment consent.

get/vrp-consents/{consentId}

Path parameters

consentIdstring required

Vrp consent id

Response

OK

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).

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.

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.

status'AWAITING_AUTHORISATION' | 'AUTHORISED' | 'REJECTED' | 'REVOKED' | 'ER_GENERAL' | 'ER_EXTSYS' required

The current status of the VRP consent.

interactionTypesstring[]

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

Example response

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