curl --request POST \
--url https://api.yapily.com/hosted/vrp/consent-requests/{consentRequestId}/revoke \
--header 'Authorization: Basic <encoded-value>'{
"meta": {
"tracingId": "2dbfd85b4f2940c6a206e96dd90e52d0"
},
"data": {
"id": "ad4bfe58-6352-11ee-8c99-0242ac120002",
"applicationUserId": "45cf7ffe-6350-11ee-8c99-0242ac120002",
"applicationId": "ea4cdf01ee-278f-4e3e-8b30-695515aa4cdf01d64",
"institutionIdentifiers": {
"institutionId": "modelo-sandbox",
"institutionCountryCode": "GB"
},
"userSettings": {
"language": "en",
"location": "GB"
},
"redirectUrl": "https://tpp-application.com",
"vrpSetup": {
"payee": {
"name": "Merchant Doe",
"accountIdentifications": [
{
"identification": "401016",
"type": "SORT_CODE"
},
{
"identification": "71518920",
"type": "ACCOUNT_NUMBER"
}
]
},
"reference": "Test Payment",
"limits": {
"periodicLimits": [
{
"maxAmount": {
"amount": 100,
"currency": "GBP"
},
"frequency": "MONTHLY",
"alignment": "CALENDAR"
}
],
"maxAmountPerPayment": {
"amount": 10,
"currency": "GBP"
}
},
"validFrom": "2023-10-04T16:41:17.870Z",
"validTo": "2024-10-04T16:41:17.870Z",
"risk": {
"contextType": "ECOMMERCE_MERCHANT"
}
},
"createdAt": "2023-10-05T07:56:44.552Z",
"authorisationExpiresAt": "2023-10-05T07:56:44.552Z",
"consentStatus": "REVOKED",
"phases": [
{
"phaseName": "INITIATED",
"phaseCreatedAt": "2023-05-10T07:56:54.887Z"
},
{
"phaseName": "INPUT_CAPTURED",
"phaseCreatedAt": "2023-05-10T07:57:05.123Z"
},
{
"phaseName": "VALIDATION_COMPLETED",
"phaseCreatedAt": "2023-05-10T07:57:05.223Z"
},
{
"phaseName": "AUTHORISATION_CREATED",
"phaseCreatedAt": "2023-05-10T07:57:06.637Z"
},
{
"phaseName": "AUTHORISED",
"phaseCreatedAt": "2023-05-10T07:57:10.637Z"
},
{
"phaseName": "SUBMITTED",
"phaseCreatedAt": "2023-05-10T07:57:10.654Z"
},
{
"phaseName": "ACCEPTED",
"phaseCreatedAt": "2023-05-10T07:57:11.867Z"
},
{
"phaseName": "REVOKED",
"phaseCreatedAt": "2023-05-11T09:57:11.867Z"
}
]
}
}Revoke Hosted VRP Consent Request
curl --request POST \
--url https://api.yapily.com/hosted/vrp/consent-requests/{consentRequestId}/revoke \
--header 'Authorization: Basic <encoded-value>'{
"meta": {
"tracingId": "2dbfd85b4f2940c6a206e96dd90e52d0"
},
"data": {
"id": "ad4bfe58-6352-11ee-8c99-0242ac120002",
"applicationUserId": "45cf7ffe-6350-11ee-8c99-0242ac120002",
"applicationId": "ea4cdf01ee-278f-4e3e-8b30-695515aa4cdf01d64",
"institutionIdentifiers": {
"institutionId": "modelo-sandbox",
"institutionCountryCode": "GB"
},
"userSettings": {
"language": "en",
"location": "GB"
},
"redirectUrl": "https://tpp-application.com",
"vrpSetup": {
"payee": {
"name": "Merchant Doe",
"accountIdentifications": [
{
"identification": "401016",
"type": "SORT_CODE"
},
{
"identification": "71518920",
"type": "ACCOUNT_NUMBER"
}
]
},
"reference": "Test Payment",
"limits": {
"periodicLimits": [
{
"maxAmount": {
"amount": 100,
"currency": "GBP"
},
"frequency": "MONTHLY",
"alignment": "CALENDAR"
}
],
"maxAmountPerPayment": {
"amount": 10,
"currency": "GBP"
}
},
"validFrom": "2023-10-04T16:41:17.870Z",
"validTo": "2024-10-04T16:41:17.870Z",
"risk": {
"contextType": "ECOMMERCE_MERCHANT"
}
},
"createdAt": "2023-10-05T07:56:44.552Z",
"authorisationExpiresAt": "2023-10-05T07:56:44.552Z",
"consentStatus": "REVOKED",
"phases": [
{
"phaseName": "INITIATED",
"phaseCreatedAt": "2023-05-10T07:56:54.887Z"
},
{
"phaseName": "INPUT_CAPTURED",
"phaseCreatedAt": "2023-05-10T07:57:05.123Z"
},
{
"phaseName": "VALIDATION_COMPLETED",
"phaseCreatedAt": "2023-05-10T07:57:05.223Z"
},
{
"phaseName": "AUTHORISATION_CREATED",
"phaseCreatedAt": "2023-05-10T07:57:06.637Z"
},
{
"phaseName": "AUTHORISED",
"phaseCreatedAt": "2023-05-10T07:57:10.637Z"
},
{
"phaseName": "SUBMITTED",
"phaseCreatedAt": "2023-05-10T07:57:10.654Z"
},
{
"phaseName": "ACCEPTED",
"phaseCreatedAt": "2023-05-10T07:57:11.867Z"
},
{
"phaseName": "REVOKED",
"phaseCreatedAt": "2023-05-11T09:57:11.867Z"
}
]
}
}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.
The unique identifier of the sub application the request is being submitted on behalf of (e.g. an underlying merchant)
Unique Identifier of the Consent Request
Was this page helpful?