Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Yapily Data Plus API

Transaction enrichment endpoints providing merchant detection, MCC categorisation, and spending insights across consumer and business accounts.

Yapily Data Plus API is one of 16 APIs that Yapily publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Enrichment, Categorisation, Merchant Detection, Insights, and Open Banking. The published artifact set on APIs.io includes API documentation and an OpenAPI specification.

This API exposes 5 operations across 5 paths, and defines 4 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 operations 5 paths 4 schemas 3 GET2 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
Resource Areas
1

Authentication & Security 1

Yapily Data Plus 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 — 3 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Data Plus 5

Data Plus endpoints enable our customers to enrich transaction data.

POST
/accounts/{accountId}/transactions/categorisation
Transactions and Enrichment
post-accounts-accountId-transactions-categorisation 6 params body → 201400401500
GET
/accounts/{accountId}/transactions/categorisation/{categorisationId}deprecated
Get Categorised Transactions (deprecated)
get-accounts-transactions-categorised 6 params → 200400401404500
POST
/transactions/categorisation
Enrichment
post-transactions-categorisation 1 param body → 201400401500
GET
/transactions/categorisation/{categorisationId}
Get Enrichment Results
get-transactions-categorised 4 params → 200400401404500
GET
/transactions/categorisation/categories/{accountType}
Get Enrichment Labels
get-categorisation-accountType 2 params → 200400401404500

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are ApiResponseOfGetCategorisedTransactionsRequest (3 properties), ApiResponseOfCreateTransactionsCategorisationRequest (2 properties), GetCategoriesResponse (1 property), ApiErrorResponseV2 (1 property). Each schema is shown below with its type and property counts.

ApiResponseOfGetCategorisedTransactionsRequest
object
3 properties
ApiErrorResponseV2
object
API Error Response
1 property
ApiResponseOfCreateTransactionsCategorisationRequest
object
2 properties
GetCategoriesResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yapily-data-plus-api-openapi.yml Raw ↑

Other APIs Yapily publishes across the network.

Yapily Institutions API
Yapily Consents and Authorisations API
Yapily Payments API (PIS)
Yapily Application Beneficiaries API
Yapily Application Management API
Yapily Authorisations API
Yapily Constraints API
Yapily Financial Data API
Yapily Hosted Consent Pages API
Yapily Hosted Payment Pages API
Yapily Notifications API
Yapily User Beneficiaries API