Get Commercial VRP Consent Details
curl --request GET \
--url https://api.yapily.com/variable-recurring-payments/commercial/consents/{consentId} \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api.yapily.com/variable-recurring-payments/commercial/consents/{consentId}"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api.yapily.com/variable-recurring-payments/commercial/consents/{consentId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.yapily.com/variable-recurring-payments/commercial/consents/{consentId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.yapily.com/variable-recurring-payments/commercial/consents/{consentId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.yapily.com/variable-recurring-payments/commercial/consents/{consentId}")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yapily.com/variable-recurring-payments/commercial/consents/{consentId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"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_COMMERCIAL",
"VARIABLE_RECURRING_PAYMENT_FUNDS_CONFIRMATION",
"INITIATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_COMMERCIAL"
],
"consentToken": "...",
"state": "...",
"institutionConsentId": "...",
"controlParameters": {
"psuAuthenticationMethods": [
"SCA_NOT_REQUIRED"
],
"maxAmountPerPayment": {
"amount": 10,
"currency": "GBP"
},
"periodicLimits": [
{
"frequency": "MONTHLY",
"alignment": "CONSENT",
"totalMaxAmount": {
"amount": 50,
"currency": "GBP"
}
}
],
"validFrom": "2026-01-01T00:00:00.000Z",
"validTo": "2027-02-02T11:59:59.000Z"
},
"initiationDetails": {
"reference": "Own Account Commercial",
"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"
}
]
}
},
"riskDetails": {
"paymentContextCode": "TransferToThirdParty",
"paymentPurposeCode": "OTHR",
"categoryPurposeCode": "OTHR",
"merchantCustomerId": "00000000-0000-0000-0000-000000000000",
"isContractPresent": false,
"isPayeePrepopulated": false,
"payeeAccountType": "Personal"
}
}
}{
"error": {
"tracingId": "0c2d0973bdd24224a65e5d0f7d1b6154",
"code": 401,
"status": "UNAUTHORIZED",
"supportUrl": "https://support.yapily.com/",
"source": "YAPILY",
"issues": [
{
"type": "CREDENTIALS",
"code": "CREDENTIALS_MISSING",
"message": "Authentication header not present"
}
]
}
}{
"error": {
"tracingId": "0c2d0973bdd24224a65e5d0f7d1b6154",
"code": 400,
"status": "BAD_REQUEST",
"supportUrl": "https://support.yapily.com/",
"source": "YAPILY",
"issues": [
{
"type": "BAD_REQUEST",
"code": "BAD_REQUEST",
"message": "The server could not understand the request due to invalid syntax"
}
]
}
}Variable Recurring Payments
Get Commercial VRP Consent Details
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 Commercial VRP Consent Details
curl --request GET \
--url https://api.yapily.com/variable-recurring-payments/commercial/consents/{consentId} \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api.yapily.com/variable-recurring-payments/commercial/consents/{consentId}"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api.yapily.com/variable-recurring-payments/commercial/consents/{consentId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.yapily.com/variable-recurring-payments/commercial/consents/{consentId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.yapily.com/variable-recurring-payments/commercial/consents/{consentId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.yapily.com/variable-recurring-payments/commercial/consents/{consentId}")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yapily.com/variable-recurring-payments/commercial/consents/{consentId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"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_COMMERCIAL",
"VARIABLE_RECURRING_PAYMENT_FUNDS_CONFIRMATION",
"INITIATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_COMMERCIAL"
],
"consentToken": "...",
"state": "...",
"institutionConsentId": "...",
"controlParameters": {
"psuAuthenticationMethods": [
"SCA_NOT_REQUIRED"
],
"maxAmountPerPayment": {
"amount": 10,
"currency": "GBP"
},
"periodicLimits": [
{
"frequency": "MONTHLY",
"alignment": "CONSENT",
"totalMaxAmount": {
"amount": 50,
"currency": "GBP"
}
}
],
"validFrom": "2026-01-01T00:00:00.000Z",
"validTo": "2027-02-02T11:59:59.000Z"
},
"initiationDetails": {
"reference": "Own Account Commercial",
"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"
}
]
}
},
"riskDetails": {
"paymentContextCode": "TransferToThirdParty",
"paymentPurposeCode": "OTHR",
"categoryPurposeCode": "OTHR",
"merchantCustomerId": "00000000-0000-0000-0000-000000000000",
"isContractPresent": false,
"isPayeePrepopulated": false,
"payeeAccountType": "Personal"
}
}
}{
"error": {
"tracingId": "0c2d0973bdd24224a65e5d0f7d1b6154",
"code": 401,
"status": "UNAUTHORIZED",
"supportUrl": "https://support.yapily.com/",
"source": "YAPILY",
"issues": [
{
"type": "CREDENTIALS",
"code": "CREDENTIALS_MISSING",
"message": "Authentication header not present"
}
]
}
}{
"error": {
"tracingId": "0c2d0973bdd24224a65e5d0f7d1b6154",
"code": 400,
"status": "BAD_REQUEST",
"supportUrl": "https://support.yapily.com/",
"source": "YAPILY",
"issues": [
{
"type": "BAD_REQUEST",
"code": "BAD_REQUEST",
"message": "The server could not understand the request due to invalid syntax"
}
]
}
}Learn more: VRP Consent Details
Authorizations
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.
Was this page helpful?
⌘I