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 Constraints API

The constraints endpoints can be used to retrieve institution specific data requirements and rules that will apply when performing other operations.

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

This API exposes 2 operations across 2 paths, and defines 19 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.

2 operations 2 paths 19 schemas 2 GET

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 Constraints 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 2

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

Constraints 2

The constraints endpoints can be used to retrieve institution specific data requirements and rules that will apply when performing other operations.

GET
/institutions/constraints/payments
Get Payment Constraints Rules
getPaymentConstraintsRulesByInstitution 5 params → 200400401404500
GET
/institutions/constraints/data
Get Data Constraints Rules
getAccountConstraintsRulesByInstitution 4 params → 200400401404500

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are Schema (31 properties), RawRequest (8 properties), ApiError (6 properties), PaymentConstraintsResponse (6 properties). Each schema is shown below with its type and property counts.

PaymentConstraintsResponse
object
6 properties 4 required
ResponseMeta
object
1 property
ApiError
object
Provides details of the error that has occurred.
6 properties
RawResponse
object
[DEPRECATED] Interaction (raw request and response) that occurred with the Institution in order to fulfil a request.
5 properties
ApiListResponseOfDataConstraints
object
2 properties
SchemaType
string
InstitutionError
object
Raw error details provided by the Institution, when it was the error source.
2 properties
ApiResponseError
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…
2 properties
Schema
object
31 properties
PaymentTypeOfConstraints
string
Payment type associated with constraints.
DataConstraintsResponse
object
5 properties 3 required
Pagination
object
3 properties
ApiListResponseOfPaymentConstraints
object
2 properties
Next
object
4 properties
FilterAndSort
object
6 properties
RequestConstraints
object
Object defining the constraints rules applicable for a given requests.
2 properties 1 required
ResponseListMeta
object
3 properties
RawRequest
object
8 properties
SortEnum
string
The attribute on which resources / records returned should be sorted. Valid options for the sort parameter.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yapily-constraints-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 Application Management API
Yapily Authorisations API
Yapily Financial Data API
Yapily Hosted Consent Pages API
Yapily Hosted Payment Pages API
Yapily Notifications API
Yapily User Beneficiaries API