Sign in

v1

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

Initiate a Variable Recurring Payment.

Initiates a new Variable Recurring Payment using an existing authorised consent.

post/vrp

Request body

consentIdstring required

The unique identifier of the VRP consent initiation request at Modulr.

interactionType'IN_SESSION' | 'OFF_SESSION'

PSU interaction type permitted under this consent. Must be one of: IN_SESSION (customer is present), OFF_SESSION (customer is not present).

Example request

{
  "consentId": "E210000004"
}

Response

Variable Recurring Payment initiated.

idstring

The unique identifier of the VRP payment initiation request at Modulr

status'SUBMITTED' | 'ACCEPTEDWITHOUTPOSTING' | 'ACCEPTEDSETTLEMENTINPROCESS' | 'PENDING' | 'REJECTED' | 'ACCEPTEDCREDITSETTLEMENTCOMPLETED' | 'ACCEPTEDSETTLEMENTCOMPLETED' | 'RECEIVED' | 'CANCELLED' | 'BLOCKED' | 'ACCEPTEDTECHNICALVALIDATION' | 'ACCEPTEDCUSTOMERPROFILE' | 'ACCEPTEDFUNDSCHECKED' | 'ACCEPTEDWITHCHANGE' | 'ACCEPTEDSETTLEMENTCOMPLETEDCREDITORACCOUNT' | 'ACCEPTEDSETTLEMENTCOMPLETEDDEBITORACCOUNT' | 'ER_GENERAL' | 'ER_EXTSYS' required

The current status of vrp payment. Must be one of “SUBMITTED”, “ACCEPTEDWITHOUTPOSTING”, “ACCEPTEDSETTLEMENTINPROCESS”, “PENDING”, “REJECTED”, “ACCEPTEDCREDITSETTLEMENTCOMPLETED”, “ACCEPTEDSETTLEMENTCOMPLETED”, “RECEIVED”, “CANCELLED”, “BLOCKED”, “ACCEPTEDTECHNICALVALIDATION”, “ACCEPTEDCUSTOMERPROFILE”, “ACCEPTEDFUNDSCHECKED”, “ACCEPTEDWITHCHANGE”, “ACCEPTEDSETTLEMENTCOMPLETEDCREDITORACCOUNT”, “ACCEPTEDSETTLEMENTCOMPLETEDDEBITORACCOUNT”, “ER_GENERAL”, “ER_EXTSYS”

Example response

{
  "id": "V21000001E"
}