Variable Recurring Payments enables transfer of money between accounts held by the same person or transfer of money for business payments. In order to make Sweeping Variable Recurring Payments on behalf of a user, you are required to request an [Consent](#tag/Authorisations) from the user by calling the Sweeping Consent endpoint to authorise the user's account to make the payment. Once a `consent-token` is obtained, you can call the Payments endpoint to execute the Sweeping Variable Recurring Payments transaction. Before executing the payment, you have the option to confirm availability of funds in the user's account by calling the Funds Confirmation endpoint. See [VRP Payments](/payments/vrps/additional-information) for more information.
Yapily Variable Recurring Payments API is one of 16 APIs that Yapily publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 4 JSON Schema definitions.
Tagged areas include Variable Recurring Payments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 4 JSON Schemas.
This API exposes
5 operations
across 5 paths,
and defines 47 schemas.
It is described by OpenAPI 3.0.1, at version 12.4.0.
Requests are made against a single base URL, https://api.yapily.com.
5 operations5 paths47 schemas2 GET3 POST
Metadata
The identity and technical contract details declared by the specification.
Yapily Variable Recurring Payments API declares
1 security scheme
for authenticating requests.
It accepts HTTP basic authentication (basicAuth).
By default, every request must be authenticated.
basicAuth — Use HTTP Basic Authentication with your Application ID as username and Application Secret as password. Manage credentials in the [Yapily Console](https://conso…
Paths & Operations 5
Across 5 paths, the API surfaces 5 operations — 2 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.
Variable Recurring Payments 5
Variable Recurring Payments enables transfer of money between accounts held by the same person or transfer of money for business payments. In order to make Sweeping Variable Recur…
The contract defines 47 schemas that model the data the API accepts and returns. The most detailed are VrpSweepingAuthorisationResponse (17 properties), VrpSubmissionResponse (13 properties), Address (10 properties), VrpSweepingAuthorisationRequest (10 properties). Each schema is shown below with its type and property counts.
ApiErrorResponse
object
Used to return errors from the bank from each request - 400 - Returned by any POST endpoint when the body does not conform to the contract - 401 - Returned by…
1 property
ResponseMeta
object
1 property
VrpSweepingAuthorisationResponse
object
17 properties
PaymentStatus
string
The status of the Payment. For more information, see [Payment Status](/guides/payments/payment-status/)
RawResponse
object
[DEPRECATED] Interaction (raw request and response) that occurred with the Institution in order to fulfil a request.
Used to describe what functions are supported by the associated Institution. For more information on each feature, see the following links: - [Financial Data F…
RefundAccount
object
The account to which funds should be returned if the payment is to be later refunded.
2 properties
VrpComplianceDataBusiness
object
Conditional. Mandatory if the type is BUSINESS.
4 properties3 required
VrpFundsAvailable
object
2 properties2 required
InstitutionError
object
Raw error details provided by the Institution, when it was the error source.
2 properties
VrpComplianceDataAddress
object
This is the registered company or trading address of your end user.
5 properties4 required
VrpInitiationDetails
object
The definition of the payer and payee.
5 properties
Payee
object
Mandatory. Details of the beneficiary [person or business].
6 properties2 required
AuthorisationStatus
string
Current status of the embedded authorisation request in code form.
VrpPeriodicLimits
object
3 properties3 required
VrpSubmissionRequest
object
Mandatory. The payment request object defining the details of the payment for execution under the Variable Recurring Payment consent.
3 properties3 required
ErrorDetails
object
6 properties3 required
Payer
object
Conditional. Details of the benefactor [person or business].
3 properties1 required
ResponseForwardedData
object
2 properties
VrpComplianceData
object
Conditional. Information needed to complete compliance checks. Mandatory for Yapily Connect customers.
1 property
PaymentIsoStatusCodeEnum
string
The ISO 20022 PaymentStatusCode.
RedirectRequest
object
Optional. The server to redirect the user to after the user complete the authorisation at the Institution.
1 property1 required
VrpFundsConfirmationResponse
object
4 properties2 required
ErrorIssue
object
Detailed information regarding the issue that was experienced during processing of the request
5 properties2 required
VrpControlParameters
object
The definition of VRP parameters.
5 properties3 required
ApiResponseOfVrpSweepingAuthorisationResponse
object
6 properties
MultiAuthorisation
object
Details the additional levels of authorisation which are required from, and being managed by, the Institution.
5 properties
Amount
object
Mandatory. Monetary Amount.
2 properties2 required
AccountIdentificationType
string
Mandatory. Used to describe the format of the account. See [Account Identification Combinations](/payments/payment-resources/intro-to-payment-executionaccount-…
PaymentIsoStatus
object
The payment status code, as denoted by a 3-letter ISO 20022 code.
2 properties
AddressTypeEnum
string
Optional. The type of address
VrpComplianceDataPayer
object
Conditional. Payer details required for compliance checks.
3 properties1 required
VrpFundsConfirmationRequest
object
2 properties1 required
VrpSubmissionDetails
object
Mandatory. The payment submission object defining the details of the payment instruction to be executed under the Variable Recurring Payment.
3 properties2 required
VrpUltimatePayer
object
4 properties
Address
object
Conditional. The address of the Payee or Payer. - payee.address is mandatory when the paymentType is an INTERNATIONAL payment - An Institution may require you…
10 properties
VrpSweepingRiskDetails
object
The details required by the institutions to detect and prevent fraud.
1 property
ApiResponseOfVrpFundsConfirmationResponse
object
6 properties
VrpSubmissionResponse
object
13 properties2 required
VrpComplianceDataIndividual
object
Conditional. Mandatory if the type is INDIVIDUAL.
2 properties2 required
RawRequest
object
8 properties
PaymentStatusDetails
object
6 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
