API Reference
Service StatusModulr WebsiteShare FeedbackSandbox Portal Sign In

Create a VRP consent

post
https://api-sandbox.modulrfinance.com/api-sandbox-token/vrp-consents

Create a Variable Recurring Payment (VRP) consent for authorisation by the payment service user. The consent can then be used to initiate one or more payments within the payment constraints specified.

Body Params
string
required

Identifier of the payer’s ASPSP where the consent will be created. The ASPSP must have the “SWEEPING” capability enabled (which can be checked using our API).

destination
object
required

Destination account details that will receive variable recurring payments initiated using this consent.

paymentConstraints
object
required

Limits that will apply to payments initiated using this consent.

date-time

Start date time from which payments can be initiated using this consent. Must be specified using YYYY-MM-DDTHH:mm:ssZ format.

date-time

End date time after which payments cannot be initiated using this consent. Must be specified using YYYY-MM-DDTHH:mm:ssZ format.

string
required

Type of VRP consent that will be created. Must be one of “SWEEPING” or “NON_SWEEPING”. Note that “NON_SWEEPING” is not yet available.

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

string
enum
Allowed:
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 7 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*
Updated 7 months ago