v1

latestOpenAPI 3.0.12026-08-0674476716.0 KB
Variable Recurring Payments
Get a VRP consent

The GET /vrp-consents/{id} endpoint retrieves the details for an individual VRP consent.
get/vrp-consents/{id}
Path parameters

idstring required
VRP consent id
Example:vc:12345abcd:abcde
Response

Successful response
Example response

{
  "vrpConsent": {
    "id": "vc:12345abcd:abcde",
    "memberId": "m:123456abcd:abcd",
    "initiation": {
      "bankId": "ob-modelo",
      "refId": "9htio4a1sp2akdr1aa",
      "remittanceInformationPrimary": "Sweepco",
      "remittanceInformationSecondary": "Secondary remittance information.",
      "startDateTime": "2017-04-05T10:43:07.123+01:00",
      "endDateTime": "2017-04-05T10:43:07.132+01:00",
      "onBehalfOfId": "6f34h397-b29h-23b0-s30g-hkd0d2dk4k1s",
      "scheme": "VRP_SWEEPING",
      "localInstrument": "FASTER_PAYMENTS",
      "debtor": {
        "accountNumber": "12345678",
        "sortCode": "123456",
        "name": "John Smith",
        "ultimateDebtorName": "John Smith",
        "address": {
          "addressLine": [
            "The Coach House"
          ],
          "streetName": "221B",
          "buildingNumber": "2C",
          "postCode": "TR26 1EZ",
          "townName": "Saint Ives",
          "state": "Cornwall",
          "country": "GB"
        }
      },
      "creditor": {
        "accountNumber": "12345678",
        "sortCode": "123456",
        "name": "Customer Inc.",
        "ultimateCreditorName": "Customer Inc.",
        "address": {
          "addressLine": [
            "The Coach House"
          ],
          "streetName": "221B",
          "buildingNumber": "2C",
          "postCode": "TR26 1EZ",
          "townName": "Saint Ives",
          "state": "Cornwall",
          "country": "GB"
        }
      },
      "currency": "EUR",
      "minimumIndividualAmount": "5.0",
      "maximumIndividualAmount": "10000.0",
      "periodicLimits": [
        {
          "maximumAmount": "100.00",
          "periodType": "DAY",
          "periodAlignment": "CALENDAR"
        }
      ],
      "maximumOccurrences": 3,
      "callbackUrl": "https://tpp.com/callback",
      "callbackState": "6242e45e-3063-4c42-8376",
      "returnRefundAccount": true,
      "risk": {
        "psuId": "0000789123",
        "paymentContextCode": "PISP_PAYEE",
        "paymentPurposeCode": "DVPM",
        "merchantCategoryCode": "4812",
        "beneficiaryAccountType": "BUSINESS",
        "contractPresentIndicator": true,
        "beneficiaryPrepopulatedIndicator": true,
        "deliveryAddress": {
          "addressLine": [
            "Flat 2, The Red Lodge, 1 High Street"
          ],
          "addressType": "BUSINESS",
          "buildingNumber": "1",
          "country": "GB",
          "countrySubDivision": [
            "North Yorkshire"
          ],
          "department": "1",
          "postCode": "YO62 5JB",
          "streetName": "High Street",
          "subDepartment": "Flat 2",
          "townName": "York"
        }
      },
      "flowType": "FULL_HOSTED_PAGES"
    },
    "createdDateTime": "2017-04-05T10:43:07.123Z",
    "updatedDateTime": "2017-04-05T10:45:07.123Z",
    "status": "AUTHORIZED",
    "bankVrpConsentId": "4jq34dwjgi9MCK2MXB9f7v",
    "bankVrpConsentStatus": "AwaitingAuthorization",
    "statusReasonInformation": "The consent resource is awaiting user authorization.",
    "authentication": {
      "redirectUrl": "http://psu-redirect.com"
    }
  }
}