Skip to main content
Yapily API Documentation home page
Search...
⌘K
Ask AI
Support
Changelog
Login to Console
Login to Console
Search...
Navigation
Page Not Found
Documentation
API Reference
Getting Started
API Reference
Authentication
Authorisations
PUT
Update Account Pre-authorisation
POST
Create Account Authorisation
PATCH
Re-authorise Account Consent
POST
Create Bulk Payment Authorisation
POST
Create Embedded Account Authorisation
PUT
Update Embedded Account Authorisation
POST
Create Embedded Bulk Payment Authorisation
PUT
Update Embedded Bulk Payment Authorisation
POST
Create Embedded Payment Authorisation
PUT
Update Embedded Payment Authorisation
PUT
Update Payment Pre-authorisation
POST
Create Payment Authorisation
POST
Create Pre-authorisation
POST
Create Payment Pre-authorisation
Financial Data
GET
Get Accounts
GET
Get Account
GET
Get Account Balances
GET
Get Account Beneficiaries
GET
Get Account Direct Debits
GET
Get Account Periodic Payments
GET
Get Account Scheduled Payments
GET
Get Account Statements
GET
Get Account Statement
GET
Get Account Statement File
GET
Get Account Transactions
GET
Get Identity
GET
Get Real Time Account Transactions
Payments
POST
Create Bulk Payment
GET
Get Bulk Payment File Status
POST
Create Payment
GET
Get Payment Details
Consents
POST
Exchange OAuth2 Code
POST
Exchange One Time Token
GET
Get Consents
GET
Get Consent
DEL
Delete Consent
POST
Extend Consent
Institutions
GET
Get Institutions
GET
Get Institution
Users
GET
Get Users
POST
Create User
GET
Get User
DEL
Delete User
PATCH
Update User
Notifications
GET
Get Event Subscriptions
POST
Create Event Subscription
GET
Get Event Subscription
DEL
Delete Event Subscription
Variable Recurring Payments
POST
Create Sweeping Variable Recurring Payment Authorisation
POST
Create Variable Recurring Payment
GET
Get Sweeping Variable Recurring Payment Consent Details
POST
Confirm Funds for Variable Recurring Payment
GET
Get Variable Recurring Payment Details
Data Plus
POST
Transactions and Enrichment
GET
Get Categorised Transactions (Deprecated)
deprecated
POST
Enrichment
GET
Get Enrichment Results
GET
Get Enrichment Labels
Hosted Consent Pages
POST
Create Hosted Consent Request
GET
Get Hosted Consent Request
Hosted Payment Pages
POST
Create Hosted payment request
POST
Create Pay By Link
GET
Get Hosted payment request
GET
Get Hosted VRP Consent Requests
POST
Create VRP Consent
GET
Get Hosted VRP Consent Request
POST
Revoke Hosted VRP Consent Request
POST
Create VRP Payment
GET
Get VRP payment
POST
Check Funds Availability
Constraints
GET
Get Payment Constraints Rules
GET
Get Data Constraints Rules
Application Management
GET
Retrieve sub-applications for the root application provided in the authentication token.
POST
Creates a sub-application for the root application id provided in the authentication token
GET
Get application details
PUT
Update an Application
DEL
Delete an application
GET
Get application VRP configuration by Application Id
PUT
Update application VRP configuration by Application Id
POST
Create application VRP configuration by Application Id
Webhooks
GET
Get Webhook Categories
GET
Retrieve All Webhook Events
POST
Register Webhook Event
DEL
Delete Webhook Event
POST
Reset Webhook Secret
Application Beneficiaries
GET
Get all application beneficiaries
POST
Create application beneficiary
GET
Get application beneficiary by id
DEL
Delete application beneficiary by id
User Beneficiaries
GET
Get all users beneficiaries
POST
Create Beneficiary
GET
Get beneficiary by id
DEL
Delete user beneficiary by id.
PATCH
Patch User Beneficiary
POST
Approve Beneficiary
POST
Reject Beneficiary
404
Page Not Found
We couldn't find the page. Maybe you were looking for one of these pages below?
API Reference
Understanding Consents
Create Payment Authorisation
Assistant
Responses are generated using AI and may contain mistakes.
Contact support