---
title: "Initiate a Variable Recurring Payment."
method: POST
path: "/vrp"
tags: ["Variable Recurring Payments"]
---

# Initiate a Variable Recurring Payment.

`POST /vrp`

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

## Request body

- PispgatewayVrpPaymentRequest
  - `consentId` string, required — The unique identifier of the VRP consent initiation request at Modulr.
  - `payment` PispgatewayPayment, required
    - `currency` string, required — Currency of the payment amount. Must be specified in ISO 4217 format.
    - `amount` number — Payment amount
    - `reference` string, required — A reference used to unambiguously refer to the payment transaction. Min 6 to max 18 characters. Can contain alphanumeric, '-', '.', '&', '/' and space.
  - `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).

## Response `201`

Variable Recurring Payment initiated.

- PispgatewayVrpPaymentResponse
  - `id` string — 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”

## Other responses

- `400` — The consent cannot be processed as it does not exist.

---

[API](https://skmtc.net/modulrfinance/apis/modulr-api.md) · [All operations](https://skmtc.net/modulrfinance/apis/modulr-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/modulrfinance/modulr-api/versions/cbd52524c8ef/schema)
