Get VRP consents

The GET /vrp-consents endpoint retrieves all VRP consents created by the calling member.

get/vrp-consents

Request

Base URL
https://api.token.io
URL
https://api.token.io/vrp-consents
Auth
- HTTP bearer
- or API key in header Authorization

Query parameters

limitinteger required

The maximum number of records to return.

offsetstring

The offset from the previous page.

createdAfterstring

Returns only Vrp consents created after this time (in <a href="https://www.iso.org/iso-8601-date-and-time-format.html" target="_blank">ISO 8601</a> format).

createdBeforestring

Returns only Vrp consents created before this time (in <a href="https://www.iso.org/iso-8601-date-and-time-format.html" target="_blank">ISO 8601</a> format).

statusesVrpConsentStatus[]

Filters Vrp consents by statuses

[
  "AUTHORIZED"
]

scheme'VRP_SWEEPING'

Vrp scheme, only VRP_SWEEPING is supported currently.

Example:VRP_SWEEPING

Filters Vrp consents by Vrp scheme (only VRP_SWEEPING is currently supported)

onBehalfOfIdstring

Filters Vrp consents by their onBehalfOfId value.

Response

Successful response

Example response

{
  "vrpConsents": [
    {
      "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"
      }
    }
  ],
  "pageInfo": {
    "limit": 20,
    "offset": "LerV6Jmex",
    "nextOffset": "KgwG8Qkat"
  }
}

Changes

No recorded changes to this operation across all 5 revisions of this API.