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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request object to Initiate VRP Consent Creation

aspspId

string

required

Identifier of the payer’s ASPSP where the consent will be created. The ASPSP must have the "SWEEPING" or "COMMERCIAL" 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.

validFromDate

date-time

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

validToDate

date-time

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

type

string

enum

required

Type of VRP consent that will be created.

Allowed:

reference

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.

interactionTypes

array of strings

List of PSU interaction types permitted under this consent. Mandatory for CVRP consent type. Must be one or both of IN_SESSION (customer is present), OFF_SESSION (customer is not present)

interactionTypes

Allowed:

ultimateCreditor

object

The ultimate beneficiary of the payment, party to which an amount of money is due. To be provided if different from the immediate creditor.

ultimateDebtor

object

The ultimate payer, party that owes an amount of money to the (ultimate) creditor. To be provided if different from the account holder.

risk

object

It is used to specify additional details for risk scoring for Payments.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

*/*

201Created

400Bad Request