v1

latestOpenAPI 3.0.12026-08-0674476716.0 KB

Variable Recurring Payments

Get payments under a VRP consent

The GET /vrp-consents/{id}/payments endpoint retrieves the payments under a given VRP consent.

get/vrp-consents/{id}/payments

Path parameters

idstring required

Example:vc:12345abcd:abcde

VRP consent id

Query parameters

limitinteger required

The maximum number of records to return.

offsetstring

The offset from the previous page.

Response

Successful response

Example response

{
  "vrps": [
    {
      "id": "vrp:12345abcd:abcd",
      "memberId": "m:123456abcd:abcd",
      "initiation": {
        "consentId": "vc:12345abcd:abcd",
        "refId": "9htio4a1sp2akdr1aa",
        "remittanceInformationPrimary": "Sweepco",
        "remittanceInformationSecondary": "Secondary remittance information.",
        "amount": {
          "value": "10.23",
          "currency": "EUR"
        },
        "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"
          }
        }
      },
      "createdDateTime": "2017-04-05T10:43:07.123Z",
      "updatedDateTime": "2017-04-05T10:45:07.123Z",
      "status": "INITIATION_COMPLETED",
      "bankVrpId": "4vn6aDyMiwBYbPDN",
      "bankVrpStatus": "AcceptedCreditSettlementCompleted",
      "statusReasonInformation": "The payment is settled on the debtor's side.",
      "refundDetails": {
        "refundAccount": {
          "iban": "GB29NWBK60161331926819",
          "bic": "BOFIIE2D",
          "name": "John Smith"
        },
        "paymentRefundStatus": "NONE",
        "settledRefundAmount": {
          "value": "10.23",
          "currency": "EUR"
        },
        "remainingRefundAmount": {
          "value": "10.23",
          "currency": "EUR"
        }
      }
    }
  ],
  "pageInfo": {
    "limit": 20,
    "offset": "LerV6Jmex",
    "nextOffset": "KgwG8Qkat"
  }
}