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 Notifications. 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.0.1, 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.0.1

API Version

12.4.0

Base URL

https://api.yapily.com

Authentication

HTTP Basic

Contact

Yapily Support

Resource Areas

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.

EventSubscriptionDeleteResponse

object

4 properties 4 required

TransactionChargeDetails

object

Details the charges that will apply to the transaction.

1 property

ResponseMeta

object

1 property

RawResponse

object

[DEPRECATED] Interaction (raw request and response) that occurred with the Institution in order to fulfil a request.

5 properties

TransactionBalance

object

2 properties

ProprietaryBankTransactionCode

object

Transaction code that is proprietary to the Institution.

2 properties

EnrichmentMerchant

object

Details of the merchant, identified by Yapily data services.

2 properties

Categorisation

object

Income and Expense categorisation that the Yapily categorisation engine has determined for the transaction.

2 properties

ApiResponseOfEventSubscriptionResponse

object

6 properties

AccountBalanceType

string

Specifies the type of the stated account balance.

EventSubscriptionResponse

object

4 properties 4 required

ResponseForwardedData

object

2 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

Pagination

object

3 properties

FilteredClientPayloadListTransaction

object

6 properties

TransactionStatusEnum

string

Amount

object

Mandatory. Monetary Amount.

2 properties 2 required

AccountIdentificationType

string

Mandatory. Used to describe the format of the account. See [Account Identification Combinations](/payments/payment-resources/intro-to-payment-executionaccount-…

Merchant

object

Details of the merchant involved in the transaction.

2 properties

CurrencyExchange

object

Provides details on the currrency exchange.

4 properties

ApiResponseOfEventSubscriptionDeleteResponse

object

6 properties

ApiListResponseOfEventSubscriptionResponse

object

7 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

ApiCall

object

Transaction

object

Details of a transaction (credit or debit) that has occurred on the account.

25 properties

object

4 properties

StatementReference

object

Unique reference for a statement period. This may be optionally populated if available.

1 property

FilterAndSort

object

6 properties

DeleteStatusEnum

string

Indicates the outcome of the delete request.

ResponseListMeta

object

3 properties

AddressDetails

object

1 property

Enrichment

object

Enriched data that has been derived by Yapily using it's data processing and machine learning techniques.

7 properties

Notification

object

Subscription details for how and where to receive notifications.

2 properties 2 required

RawRequest

object

8 properties

SortEnum

string

The attribute on which resources / records returned should be sorted. Valid options for the sort parameter.

EventSubscriptionRequest

object

2 properties 2 required

IsoCodeDetails

object

Mandatory. Details the identification of the ISO code.

2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

#Notifications

← Back to Y APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Yapily Notifications API

Metadata

Authentication & Security 1

Paths & Operations 4

Schemas 37

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Yapily Notifications API

Metadata

Authentication & Security 1

Paths & Operations 4

Schemas 37

Specification

Source

More from Yapily 12

API Details

Provider

Explore more