v1

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

Confirm the availability of funds in an account.

Confirm the availability of funds in account, prior to initiating a Variable Recurring Payment, using an authorised consent.

post/vrp-consents/{consentId}/funds-confirmation

Path parameters

consentIdstring required

Vrp consent id

Request body

currencystring required

Currency of the maximum individual amount. Must be specified in ISO 4217 format.

amountnumber

amount that will be confirmed for availability of funds - '1' = 1.00 GBP

Response

Confirmation of Funds successful.

fundsAvailableboolean

The result of funds availability check, can be one of 'true' or 'false'

fundsAvailabilityCheckDateTimestring date-time

The time that the funds availability check occurred