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 Application Management API

Application Management endpoints help with creating and managing client sub-applications.

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

This API exposes 8 operations across 3 paths, and defines 18 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.

8 operations 3 paths 18 schemas 1 DELETE3 GET2 POST2 PUT

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 Application Management 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 8

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

Application Management 8

Application Management endpoints help with creating and managing client sub-applications.

POST
/applications
Creates a Sub-application for the Root Application Id Provided in the Authentication Token
createSubApplication body → 201400401403404500
GET
/applications
Retrieve Sub-applications for the Root Application Provided in the Authentication Token.
searchApplications 1 param → 200400401403500
GET
/applications/{applicationId}
Get Application Details
getApplicationById 1 param → 200401403404500
PUT
/applications/{applicationId}
Update an Application
updateApplication 1 param body → 200400401403500
DELETE
/applications/{applicationId}
Delete an Application
deleteApplication 1 param → 204401403404500
POST
/applications/{applicationId}/vrp
Create Application Vrp Configuration by Application Id
createApplicationVRPConfigurationByApplicationId 1 param body → 201400401403404500
PUT
/applications/{applicationId}/vrp
Update Application Vrp Configuration by Application Id
updateApplicationVRPConfigurationByApplicationId 1 param body → 201400401403404500
GET
/applications/{applicationId}/vrp
Get Application Vrp Configuration by Application Id
getApplicationVRPConfigurationByApplicationId 1 param → 200400401403404500

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are ApplicationResponse (7 properties), ErrorDetails (6 properties), VrpConfiguration (5 properties), ApplicationRequest (5 properties). Each schema is shown below with its type and property counts.

ApiResponseOfApplicationResponse
object
2 properties
ApplicationResponseListMeta
object
3 properties
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
ErrorIssue
object
Detailed information regarding the issue that was experienced during processing of the request
5 properties 2 required
VrpConfiguration
object
5 properties
ValidationError
object
2 properties 2 required
ValidationErrorResponse
object
1 property
EnumError
string
ApplicationRequest
object
5 properties 4 required
InstitutionError
object
Raw error details provided by the Institution, when it was the error source.
2 properties
ResponseMeta
object
1 property
AlignmentEnum
string
Mandatory. Period alignment for which the payment limits are enforced. Allowed values are [CONSENT, CALENDAR]. If CONSENT, then period starts on consent creati…
ApiListOfApplicationResponse
object
2 properties
Amount
object
Mandatory. Monetary Amount.
2 properties 2 required
FrequencyEnum
string
Mandatory. Frequency for which the payment limits are enforced. Allowed values are [MONTHLY].
ApplicationResponse
object
7 properties
ErrorDetails
object
6 properties 3 required
VrpPeriodicLimit
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yapily-application-management-api-openapi.yml Raw ↑

Other APIs Yapily publishes across the network.

Yapily Institutions API
Yapily Consents and Authorisations API
Yapily Payments API (PIS)
Yapily Data Plus API
Yapily Application Beneficiaries 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