YAyapily
Variable Recurring Payments

Get Commercial VRP Consent Details

Changed on

Get Commercial VRP consent details from the Consent ID.

Feature: CREATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_COMMERCIAL

Note that Commercial VRP authorisation/initiation is currently only available through a Hosted VRP flow (specifically, POST /hosted/vrp-requests).

get/variable-recurring-payments/commercial/consents/{consentId}

Request

  • Base URL
    https://api.yapily.com
  • Auth
    HTTP basic

Path parameters

consentIdstring uuid required

The Consent ID to retrieve.

Response

OK

linksobject
tracingIdstring

Example response

{
  "data": {
    "controlParameters": {
      "maxAmountPerPayment": {
        "amount": 10,
        "currency": "GBP"
      },
      "periodicLimits": [
        {
          "totalMaxAmount": {
            "amount": 10,
            "currency": "GBP"
          }
        }
      ]
    },
    "initiationDetails": {
      "payer": {
        "name": "John Doe",
        "accountIdentifications": [
          {
            "type": "SORT_CODE",
            "identification": "401016"
          }
        ],
        "address": {
          "country": "GB"
        }
      },
      "ultimatePayer": {
        "accountIdentifications": [
          {
            "type": "SORT_CODE",
            "identification": "401016"
          }
        ],
        "address": {
          "country": "GB"
        }
      },
      "payee": {
        "name": "Jane Doe",
        "accountIdentifications": [
          {
            "identification": "401016",
            "type": "SORT_CODE"
          },
          {
            "identification": "71518920",
            "type": "ACCOUNT_NUMBER"
          }
        ],
        "address": {
          "country": "GB"
        },
        "merchantId": "24589303",
        "merchantCategoryCode": "0742"
      },
      "ultimatePayee": {
        "accountIdentifications": [
          {
            "type": "SORT_CODE",
            "identification": "401016"
          }
        ],
        "address": {
          "country": "GB"
        }
      }
    }
  }
}

Changes