Skip to main content
Get Sweeping VRP Consent Details
curl --request GET \
  --url https://api.yapily.com/variable-recurring-payments/sweeping/consents/{consentId} \
  --header 'Authorization: Basic <encoded-value>'
{
  "meta": {
    "tracingId": "12345678901234567890123456789012"
  },
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "userUuid": "00000000-0000-0000-0000-000000000000",
    "institutionId": "mock-sandbox",
    "status": "AUTHORIZED",
    "createdAt": "2026-01-01T00:00:00Z",
    "authorizedAt": "2026-01-01T00:00:00.000Z",
    "featureScope": [
      "EXISTING_PAYMENTS_DETAILS",
      "EXISTING_PAYMENT_INITIATION_DETAILS",
      "CREATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_SWEEPING",
      "VARIABLE_RECURRING_PAYMENT_FUNDS_CONFIRMATION",
      "INITIATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_SWEEPING"
    ],
    "consentToken": "...",
    "state": "...",
    "institutionConsentId": "...",
    "controlParameters": {
      "psuAuthenticationMethods": [
        "SCA_NOT_REQUIRED"
      ],
      "maxAmountPerPayment": {
        "amount": 10,
        "currency": "GBP"
      },
      "periodicLimits": [
        {
          "frequency": "MONTHLY",
          "alignment": "CONSENT",
          "totalMaxAmount": {
            "amount": 50,
            "currency": "GBP"
          }
        }
      ]
    },
    "initiationDetails": {
      "reference": "Own Account Sweeping",
      "payee": {
        "name": "Payee",
        "accountIdentifications": [
          {
            "type": "ACCOUNT_NUMBER",
            "identification": "12345678"
          },
          {
            "type": "SORT_CODE",
            "identification": "112233"
          }
        ]
      },
      "payer": {
        "name": "Payer",
        "accountIdentifications": [
          {
            "type": "ACCOUNT_NUMBER",
            "identification": "87654321"
          },
          {
            "type": "SORT_CODE",
            "identification": "332211"
          }
        ]
      }
    }
  }
}

Authorizations

Authorization
string
header
required

Use HTTP Basic Authentication with your Application ID as username and Application Secret as password. Manage credentials in the Yapily Console. See Authentication for details.

Path Parameters

The Consent ID to retrieve.

Response

OK

meta
object
data
object
forwardedData
object[]
raw
object[]
deprecated