Sign in

v1

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

Get Variable Recurring Payment

Fetch the details of a payment initiated using Variable Recurring Payment (VRP) based on a unique payment ID.

get/vrp/{vrpPaymentId}

Path parameters

vrpPaymentIdstring required

Vrp Payment Id

Response

OK

consentIdstring required

The unique identifier of the VRP consent 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 the VRP payment.

statusReasonCodesstring[]
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 response

{
  "consentId": "E210000004",
  "statusReasonCodes": [
    "ERIN"
  ]
}