Get VRP consent.

get https://api-sandbox.modulrfinance.com/api-sandbox-token/vrp-consents/{consentId}

Returns information about a given Variable Recurring Payment consent.

time	status	user agent
Retrieving recent requests…

Loading…

Responses

Response body

object

aspspId

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.

type

string

required

Indicates the type of destination. Can be one of ACCOUNT, SCAN

ACCOUNT SCAN

string

Identifier of the destination account if using ACCOUNT type

accountNumber

string

Account Number of destination account if using SCAN type

sortCode

string

Sort Code of destination account if using SCAN type

name

string

length between 0 and 70

Name of destination account if using SCAN type (this may be truncated)

paymentConstraints

object

required

Limits that will apply to payments initiated using this consent.

maximumIndividualAmount

object

required

Maximum amount of any single payment initiated using this consent.

periodicLimits

array of objects

Maximum amount of all payments that can be initiated using this consent in a given period. If the periodAlignment is “Calendar”, the limit is pro-rated in the first period to the remaining number of days.

periodicLimits

object

currency

string

required

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

amount

number

The maximum amount of all payments initiated using this consent in the specified period. At least one periodic limit is required - '1' = 1.00 GBP

periodAlignment

string

required

Specifies whether the period starts on the date of consent creation or lines up with a calendar.

periodType

string

required

Period type. Must be one of “DAY”,”WEEK”,”FORTNIGHT”,”MONTH”,”HALF_YEAR”,”YEAR”.

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.

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

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.

status

string

required

The current status of vrp consent. Must be one of “AWAITING_AUTHORISATION”,“AUTHORISED”,“REJECTED”,“REVOKED”,“ER_GENERAL”,“ER_EXTSYS”

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api-sandbox.modulrfinance.com/api-sandbox-token/vrp-consents/ \
3
     --header 'accept: application/json'

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

application/json

*/*

200OK

400The consent details cannot be retrieved as it does not exist