Initiate authorisation for a Sweeping VRP consent.
The response will contain an Authorisation URL and the associated Consent ID. The user will have to complete authorisation of the consent at their institution via Redirect Flows, after which you will be able to use the authorised consent to create payments.
Feature:
INITIATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_SWEEPINGDocumentation Index
Fetch the complete documentation index at: https://docs.yapily.com/llms.txt
Use this file to discover all available pages before exploring further.
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 Institution ID which will carry out authorisation.
The definition of VRP parameters.
The definition of the payer and payee.
Conditional. The Yapily User UUID. One of userUuid or applicationUserId must be present in the request.
Conditional. The Application User ID. One of userUuid or applicationUserId must be present in the request.
Optional. The server to redirect the user to after the user complete the authorisation at the Institution.
See Using a callback (Optional) for more information.
Optional. The server to redirect the user to after the user complete the authorisation at the Institution.
Any parameters that you may want to get forwarded in the callback request after the PSU is redirected.
Conditional. Set to true to receive a oneTimeToken instead of consentToken at the callback. This is used for additional security and can only be used when the callback is set.
See Using a One-Time Token for more information.
Conditional. Information needed to complete compliance checks. Mandatory for Yapily Connect customers.