{ "opencollection": "1.0.0", "info": { "name": "Account and Transaction API Specification Account Access Consents Domestic VRP Consents API", "version": "4.0.1" }, "items": [ { "info": { "name": "Domestic VRP Consents", "type": "folder" }, "items": [ { "info": { "name": "Create a domestic VRP consent", "type": "http" }, "http": { "method": "POST", "url": "/open-banking/v4.0/aisp/domestic-vrp-consents", "headers": [ { "name": "x-fapi-auth-date", "value": "" }, { "name": "x-fapi-customer-ip-address", "value": "" }, { "name": "x-fapi-interaction-id", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "x-idempotency-key", "value": "" }, { "name": "x-jws-signature", "value": "" }, { "name": "x-customer-user-agent", "value": "" }, { "name": "x-client-id", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://authserver.example/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Enables a PISP to ask an ASPSP to create a new domestic-vrp-consent resource, by sending a copy of the consent to the ASPSP." }, { "info": { "name": "Get a Domestic VRP Consent", "type": "http" }, "http": { "method": "GET", "url": "/open-banking/v4.0/aisp/domestic-vrp-consents/:ConsentId", "headers": [ { "name": "x-fapi-auth-date", "value": "" }, { "name": "x-fapi-customer-ip-address", "value": "" }, { "name": "x-fapi-interaction-id", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "x-customer-user-agent", "value": "" }, { "name": "x-client-id", "value": "" } ], "params": [ { "name": "ConsentId", "value": "", "type": "path", "description": "ConsentId" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://authserver.example/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Enables a PISP to retrieve the status of a Domestic VRP Consent." }, { "info": { "name": "Replace an existing domestic VRP consent", "type": "http" }, "http": { "method": "PUT", "url": "/open-banking/v4.0/aisp/domestic-vrp-consents/:ConsentId", "headers": [ { "name": "x-fapi-auth-date", "value": "" }, { "name": "x-fapi-customer-ip-address", "value": "" }, { "name": "x-fapi-interaction-id", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "x-idempotency-key", "value": "" }, { "name": "x-jws-signature", "value": "" }, { "name": "x-customer-user-agent", "value": "" }, { "name": "x-client-id", "value": "" } ], "params": [ { "name": "ConsentId", "value": "", "type": "path", "description": "ConsentId" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://authserver.example/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Enables a PISP to replace an existing Domestic VRP Consent resource. \n\nThis endpoint **must** only be used for the migration of Domestic VRP Consent resource data across API Standard versions where the ASPSP supports this PUT function.\n" }, { "info": { "name": "Update an existing domestic VRP consent", "type": "http" }, "http": { "method": "PATCH", "url": "/open-banking/v4.0/aisp/domestic-vrp-consents/:ConsentId", "headers": [ { "name": "x-fapi-auth-date", "value": "" }, { "name": "x-fapi-customer-ip-address", "value": "" }, { "name": "x-fapi-interaction-id", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "x-idempotency-key", "value": "" }, { "name": "x-jws-signature", "value": "" }, { "name": "x-customer-user-agent", "value": "" }, { "name": "x-client-id", "value": "" } ], "params": [ { "name": "ConsentId", "value": "", "type": "path", "description": "ConsentId" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://authserver.example/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Enables a PISP to update an existing Domestic VRP Consent resource by submitting a JSON Patch payload.\n\nThis endpoint **must** only be used for the migration of Domestic VRP Consent resource data across API Standard versions where the ASPSP supports this PATCH function.\n" }, { "info": { "name": "Delete a Domestic VRP Consent", "type": "http" }, "http": { "method": "DELETE", "url": "/open-banking/v4.0/aisp/domestic-vrp-consents/:ConsentId", "headers": [ { "name": "x-fapi-auth-date", "value": "" }, { "name": "x-fapi-customer-ip-address", "value": "" }, { "name": "x-fapi-interaction-id", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "x-customer-user-agent", "value": "" }, { "name": "x-client-id", "value": "" } ], "params": [ { "name": "ConsentId", "value": "", "type": "path", "description": "ConsentId" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://authserver.example/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Enables a PISP to ask an ASPSP to delete a previously consented Domestic VRP Consent resource." }, { "info": { "name": "Confirm Funds Availability for a Domestic VRP", "type": "http" }, "http": { "method": "POST", "url": "/open-banking/v4.0/aisp/domestic-vrp-consents/:ConsentId/funds-confirmation", "headers": [ { "name": "x-fapi-auth-date", "value": "" }, { "name": "x-fapi-customer-ip-address", "value": "" }, { "name": "x-fapi-interaction-id", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "x-jws-signature", "value": "" }, { "name": "x-customer-user-agent", "value": "" }, { "name": "x-client-id", "value": "" } ], "params": [ { "name": "ConsentId", "value": "", "type": "path", "description": "ConsentId" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://authserver.example/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Enables a PISP to check whether a PSU has sufficient available funds for a Domestic VRP Payment." } ] } ], "bundled": true }