How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Yapily

Yapily Notifications API

The Notifications endpoints provide an interactive way for user to receive notifications according to different event-types. This feature is currently in private beta. Please reach out if you require access.

Documentation Provider Profile APIs.io OpenAPI GitHub

Yapily Notifications 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 Notification. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 4 JSON Schemas.

This API exposes 4 operations across 2 paths, and defines 37 schemas. It is described by OpenAPI 3.2.0, at version 12.4.0.

Requests are made against a single base URL, https://api.yapily.com.

4 operations 2 paths 37 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
12.4.0
Base URL
https://api.yapily.com
Authentication
HTTP Basic
Contact
Yapily Support
Resource Areas
1

Authentication & Security 1

Yapily Notifications 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 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Notifications 4

The Notifications endpoints provide an interactive way for user to receive notifications according to different event-types. This feature is currently in private beta. Please reac…

POST
/notifications/event-subscriptions
Create Event Subscription
createEventSubscription 1 param body → 201400401409
GET
/notifications/event-subscriptions
Get Event Subscriptions
getEventSubscriptions 1 param → 200401
GET
/notifications/event-subscriptions/{eventTypeId}
Get Event Subscription
getEventSubscriptionById 2 params → 200401404
DELETE
/notifications/event-subscriptions/{eventTypeId}
Delete Event Subscription
deleteEventSubscriptionById 2 params → 200401404

Schemas 37

The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are Transaction (25 properties), RawRequest (8 properties), ApiListResponseOfEventSubscriptionResponse (7 properties), Enrichment (7 properties). Each schema is shown below with its type and property counts.

Transaction
object
Details of a transaction (credit or debit) that has occurred on the account.
25 properties
Notification
object
Subscription details for how and where to receive notifications.
2 properties 2 required
ApiResponseOfEventSubscriptionDeleteResponse
object
6 properties
Categorisation
object
Income and Expense categorisation that the Yapily categorisation engine has determined for the transaction.
2 properties
Pagination
object
3 properties
IsoCodeDetails
object
Mandatory. Details the identification of the ISO code.
2 properties
DeleteStatusEnum
string
Indicates the outcome of the delete request.
EventSubscriptionResponse
object
4 properties 4 required
RawResponse
object
[DEPRECATED] Interaction (raw request and response) that occurred with the Institution in order to fulfil a request.
5 properties
AccountBalanceType
string
Specifies the type of the stated account balance.
EventSubscriptionDeleteResponse
object
4 properties 4 required
Merchant
object
Details of the merchant involved in the transaction.
2 properties
ApiCall
object
TransactionChargeDetails
object
Details the charges that will apply to the transaction.
1 property
TransactionBalance
object
2 properties
RawRequest
object
8 properties
CurrencyExchange
object
Provides details on the currrency exchange.
4 properties
AddressDetails
object
1 property
AccountIdentificationType
string
Mandatory. Used to describe the format of the account. See [Account Identification Combinations](/payments/payment-resources/intro-to-payment-executionaccount-…
ProprietaryBankTransactionCode
object
Transaction code that is proprietary to the Institution.
2 properties
ResponseMeta
object
1 property
ResponseListMeta
object
3 properties
TransactionStatusEnum
string
Amount
object
Mandatory. Monetary Amount.
2 properties 2 required
Next
object
4 properties
EventSubscriptionRequest
object
2 properties 2 required
SortEnum
string
The attribute on which resources / records returned should be sorted. Valid options for the sort parameter.
Enrichment
object
Enriched data that has been derived by Yapily using it's data processing and machine learning techniques.
7 properties
IsoBankTransactionCode
object
Defines the underlying transaction type (e.g. Card or Debit Transactions, Loans or Mortages). Conforms to ISO standards - ISO 20022.
3 properties
FilterAndSort
object
6 properties
EnrichmentMerchant
object
Details of the merchant, identified by Yapily data services.
2 properties
TransactionHash
object
An unique identifier for the transaction that was generated by Yapily. This is a hash of transaction attributes and may be useful an id is not present (and the…
1 property
FilteredClientPayloadListTransaction
object
6 properties
ApiResponseOfEventSubscriptionResponse
object
6 properties
ResponseForwardedData
object
2 properties
ApiListResponseOfEventSubscriptionResponse
object
7 properties
StatementReference
object
Unique reference for a statement period. This may be optionally populated if available.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yapily-notifications-api-openapi.yml Raw ↑

Other APIs Yapily publishes across the network.

Yapily Institutions API
AE Profile APIs.io
Yapily Consents and Authorisations API
AE Profile APIs.io
Yapily Payments API (PIS)
AE Profile APIs.io
Yapily Data Plus API
AE Profile APIs.io
Yapily Application Beneficiaries API
AE Profile APIs.io
Yapily Application Management API
AE Profile APIs.io
Yapily Authorisations API
AE Profile APIs.io
Yapily Constraints API
AE Profile APIs.io
Yapily Financial Data API
AE Profile APIs.io
Yapily Hosted Consent Pages API
AE Profile APIs.io
Yapily Hosted Payment Pages API
AE Profile APIs.io
Yapily User Beneficiaries API
AE Profile APIs.io
#Notification
← Back to Y APIs
API Details
ID
yapily:yapily-notifications-api
Base URL
https://api.yapily.com
Docs
https://docs.yapily.com/api/reference/
Provider
Yapily
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=yapily-notifications-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/yapily-notifications-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Yapily Notifications API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.