---
title: "Get VRP consent."
method: GET
path: "/vrp-consents/{consentId}"
tags: ["Variable Recurring Payments"]
---

# Get VRP consent.

`GET /vrp-consents/{consentId}`

Returns information about a given Variable Recurring Payment consent.

## Path parameters

- `consentId` string, required

## Response `200`

OK

- PispgatewayVrpConsentResponse — Response object of VRP Consent
  - `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` PispgatewayDestination, required — The destination account for the payment
    - `type` 'ACCOUNT' | 'SCAN', required — Indicates the type of destination. Can be one of ACCOUNT, SCAN
    - `id` 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 — Name of destination account if using SCAN type (this may be truncated)
  - `paymentConstraints` PispgatewayPaymentConstraints, required — Limits that will apply to payments initiated using this consent.
    - `maximumIndividualAmount` PispgatewayMaximumIndividualVrPayment, required — Maximum amount of any single payment initiated using this consent.
      - `currency` string, required — Currency of the maximum individual amount. Must be specified in ISO 4217 format.
      - `amount` number — Maximum amount of any single payment initiated using this consent - '1' = 1.00 GBP
    - `periodicLimits` PispgatewayPeriodicLimit[] — 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.
      - `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` string, 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` string, 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` 'SWEEPING' | 'CVRP1', required — Type of VRP consent that will be created.
  - `status` 'AWAITING_AUTHORISATION' | 'AUTHORISED' | 'REJECTED' | 'REVOKED' | 'ER_GENERAL' | 'ER_EXTSYS', required — The current status of the VRP consent.
  - `interactionTypes` string[] — List of PSU interaction types permitted under this consent. Must be one or both of IN_SESSION (customer is present), OFF_SESSION (customer is not present)
  - `ultimateCreditor` PispgatewayUltimateParty
    - `name` string — Name by which a party is known and which is usually used to identify that party.
    - `identification` string — Identification assigned by an institution.
    - `lei` string — Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).
    - `postalAddress` PispgatewayPostalAddress
      - `addressType` 'BIZZ' | 'DLVY' | 'MLTO' | 'PBOX' | 'ADDR' | 'HOME' | 'CORR' | 'STAT' — Identifies the nature of the postal address. BIZZ (Business), DLVY (Delivery), MLTO (Mail To), PBOX (PO Box), ADDR (Postal), HOME (Residential), CORR (Correspondence), STAT (Statement).
      - `department` string — Identification of a division of a large organisation or building.
      - `subDepartment` string — Identification of a sub-division of a large organisation or building.
      - `streetName` string — Name of a street or thoroughfare.
      - `buildingNumber` string — Number that identifies the position of a building on a street.
      - `buildingName` string — Name of a referenced building.
      - `floor` string — Number that identifies the level within a building.
      - `unitNumber` string — Number that identifies the unit of a specific address.
      - `room` string — Information that locates and identifies a room to form part of an address.
      - `postBox` string — Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
      - `townLocationName` string — Name of a built-up area, with defined boundaries, and a local government.
      - `districtName` string — Number that of the regional area, known as a district, which forms part of an address.
      - `careOf` string — The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
      - `postCode` string — Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
      - `townName` string — Name of a built-up area, with defined boundaries, and a local government.
      - `countrySubDivision` string — Identifies a subdivision of a country such as state, region, county.
      - `country` string — Nation with its own government, as an ISO 3166-1 alpha-2 country code.
      - `addressLine` string[] — Information that locates and identifies a specific address, as defined by postal services, presented in free format text. Maximum 7 lines, each up to 70 characters.
  - `ultimateDebtor` PispgatewayUltimateParty
    - `name` string — Name by which a party is known and which is usually used to identify that party.
    - `identification` string — Identification assigned by an institution.
    - `lei` string — Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).
    - `postalAddress` PispgatewayPostalAddress
      - `addressType` 'BIZZ' | 'DLVY' | 'MLTO' | 'PBOX' | 'ADDR' | 'HOME' | 'CORR' | 'STAT' — Identifies the nature of the postal address. BIZZ (Business), DLVY (Delivery), MLTO (Mail To), PBOX (PO Box), ADDR (Postal), HOME (Residential), CORR (Correspondence), STAT (Statement).
      - `department` string — Identification of a division of a large organisation or building.
      - `subDepartment` string — Identification of a sub-division of a large organisation or building.
      - `streetName` string — Name of a street or thoroughfare.
      - `buildingNumber` string — Number that identifies the position of a building on a street.
      - `buildingName` string — Name of a referenced building.
      - `floor` string — Number that identifies the level within a building.
      - `unitNumber` string — Number that identifies the unit of a specific address.
      - `room` string — Information that locates and identifies a room to form part of an address.
      - `postBox` string — Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
      - `townLocationName` string — Name of a built-up area, with defined boundaries, and a local government.
      - `districtName` string — Number that of the regional area, known as a district, which forms part of an address.
      - `careOf` string — The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
      - `postCode` string — Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
      - `townName` string — Name of a built-up area, with defined boundaries, and a local government.
      - `countrySubDivision` string — Identifies a subdivision of a country such as state, region, county.
      - `country` string — Nation with its own government, as an ISO 3166-1 alpha-2 country code.
      - `addressLine` string[] — Information that locates and identifies a specific address, as defined by postal services, presented in free format text. Maximum 7 lines, each up to 70 characters.
  - `risk` PispgatewayOBRisk
    - `merchantCategoryCode` string, required — Category code conforming to ISO 18245, related to the type of services or goods the merchant provides.
    - `merchantCustomerIdentification` string, required — The unique customer identifier of the PSU with the merchant.
    - `contractPresentIndicator` boolean, required — Indicates if Payee has a contractual relationship with the PISP.
    - `beneficiaryPrepopulatedIndicator` boolean, required — Indicates if PISP has immutably prepopulated payment details for the PSU.
    - `beneficiaryAccountType` 'Business' | 'BusinessSavingsAccount' | 'Charity' | 'Collection' | 'Corporate' | 'Ewallet' | 'Government' | 'Investment' | 'ISA' | 'JointPersonal' | 'Pension' | 'Personal' | 'PersonalSavingsAccount' | 'Premier' | 'Wealth' — Specifies the extended type of beneficiary account if known.
    - `deliveryAddress` PispgatewayPostalAddress
      - `addressType` 'BIZZ' | 'DLVY' | 'MLTO' | 'PBOX' | 'ADDR' | 'HOME' | 'CORR' | 'STAT' — Identifies the nature of the postal address. BIZZ (Business), DLVY (Delivery), MLTO (Mail To), PBOX (PO Box), ADDR (Postal), HOME (Residential), CORR (Correspondence), STAT (Statement).
      - `department` string — Identification of a division of a large organisation or building.
      - `subDepartment` string — Identification of a sub-division of a large organisation or building.
      - `streetName` string — Name of a street or thoroughfare.
      - `buildingNumber` string — Number that identifies the position of a building on a street.
      - `buildingName` string — Name of a referenced building.
      - `floor` string — Number that identifies the level within a building.
      - `unitNumber` string — Number that identifies the unit of a specific address.
      - `room` string — Information that locates and identifies a room to form part of an address.
      - `postBox` string — Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
      - `townLocationName` string — Name of a built-up area, with defined boundaries, and a local government.
      - `districtName` string — Number that of the regional area, known as a district, which forms part of an address.
      - `careOf` string — The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
      - `postCode` string — Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
      - `townName` string — Name of a built-up area, with defined boundaries, and a local government.
      - `countrySubDivision` string — Identifies a subdivision of a country such as state, region, county.
      - `country` string — Nation with its own government, as an ISO 3166-1 alpha-2 country code.
      - `addressLine` string[] — Information that locates and identifies a specific address, as defined by postal services, presented in free format text. Maximum 7 lines, each up to 70 characters.

## Other responses

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

---

[API](https://skmtc.net/modulrfinance/apis/modulr-api.md) · [All operations](https://skmtc.net/modulrfinance/apis/modulr-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/modulrfinance/modulr-api/versions/cbd52524c8ef/schema)