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

Before calling [Financial Data](#yapily-api-financial-data) or [Payments](#yapily-api-payments) endpoints, a consent from an end-user must be obtained.Consents are valid for up to 90 days for Financial Data endpoints and have a single-use for Payment endpoints i.e. a new consent must be obtained for each payment.NOTE: A user consent is also referred to as an 'Authorisation'.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

This API exposes 14 operations across 11 paths, and defines 58 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.

14 operations 11 paths 58 schemas 1 PATCH8 POST5 PUT

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 Authorisations 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 14

Across 11 paths, the API surfaces 14 operations — 1 PATCH, 8 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

Authorisations 14

Before calling Financial Data or Payments endpoints, a consent from an end-user must be obtained. Consents are valid for up to 90 days for Financial Data endpoints and have a sing…

PATCH
/account-auth-requests
Re-authorise Account Consent
reAuthoriseAccount 5 params → 201default
POST
/account-auth-requests
Create Account Authorisation
initiateAccountRequest 4 params body → 201default
PUT
/account-auth-requests
Update Account Pre-authorisation
updatePreAuthoriseAccountConsent 5 params body → 200default
POST
/bulk-payment-auth-requests
Create Bulk Payment Authorisation
createBulkPaymentAuthorisation 3 params body → 201default
POST
/embedded-account-auth-requests
Create Embedded Account Authorisation
initiateEmbeddedAccountRequest 4 params body → 201default
PUT
/embedded-account-auth-requests/{consentId}
Update Embedded Account Authorisation
updateEmbeddedAccountRequest 5 params body → 201default
POST
/embedded-bulk-payment-auth-requests
Create Embedded Bulk Payment Authorisation
createEmbeddedBulkPaymentAuthorisation 3 params body → 201default
PUT
/embedded-bulk-payment-auth-requests/{consentId}
Update Embedded Bulk Payment Authorisation
updateEmbeddedBulkPaymentAuthorisation 4 params body → 200default
POST
/embedded-payment-auth-requests
Create Embedded Payment Authorisation
createEmbeddedPaymentAuthorisation 4 params body → 201default
PUT
/embedded-payment-auth-requests/{consentId}
Update Embedded Payment Authorisation
updateEmbeddedPaymentAuthorisation 5 params body → 200default
POST
/payment-auth-requests
Create Payment Authorisation
createPaymentAuthorisation 4 params body → 201default
PUT
/payment-auth-requests
Update Payment Pre-authorisation
updatePaymentAuthorisation 4 params body → 200default
POST
/pre-auth-requests
Create Pre-authorisation
createPreAuthorisationRequest 5 params body → 201default
POST
/payment-pre-auth-requests
Create Payment Pre-authorisation
createPaymentPreAuthorisationRequest 3 params body → 201default

Schemas 58

The contract defines 58 schemas that model the data the API accepts and returns. The most detailed are PaymentEmbeddedAuthorisationRequestResponse (24 properties), PaymentAuthorisationRequestResponse (22 properties), AccountAuthorisationResponse (21 properties), EmbeddedAccountAuthorisationResponse (21 properties). Each schema is shown below with its type and property counts.

Payee
object
Mandatory. Details of the beneficiary [person or business].
6 properties 2 required
PaymentEmbeddedAuthorisationRequestResponse
object
24 properties
RedirectRequest
object
Optional. The server to redirect the user to after the user complete the authorisation at the Institution.
1 property 1 required
PaymentEmbeddedAuthorisationRequest
object
The request body containing an PaymentEmbeddedAuthorisationRequest json payload
10 properties 2 required
PayerDetails
object
Conditional. Details of the benefactor [person or business].
1 property 1 required
PaymentAuthorisationRequestResponse
object
22 properties
PaymentPurposeCode
string
Optional. The payment purpose code. Allowed values: INTP, DEPT, BEXP, LICF, SERV, SUPP, TRAD, SUBS, GDSV, ROYA, COMT, CHAR, ECPR, CLPR, INTE, LOAN, LOAR, INPC,…
AccountIdentification
object
2 properties 2 required
AddressTypeEnum
string
Optional. The type of address
AccountAuthorisationResponse
object
21 properties
ExchangeRateInformation
object
Optional. Used to provide details on the currency exchange rate and contract.
4 properties 2 required
BulkPaymentEmbeddedAuthorisationRequest
object
The request body containing a BulkPaymentEmbeddedAuthorisationRequest json payload
10 properties 1 required
InternationalPaymentRequest
object
Conditional. Used to specify properties to define an international payment. Must be specified when the payment type is one of the following: - INTERNATIONALSIN…
5 properties 1 required
ChargeBearerType
string
Conditional. Depending on the bank and payment type for international Euro payments. The field ChargeBearer specifies which party/parties will bear the charges…
PaymentContextType
string
Optional. The payment context code. This defaults to OTHER if not specified.
RawRequest
object
8 properties
PayeeAccountType
string
Optional. The payee account type. Allowed values: BUSINESS, BUSINESSSAVING, CHARITY, COLLECTION, CORPORATE, EWALLET, GOVERNMENT, INVESTMENT, INVESTMENTISA, JOI…
Address
object
Conditional. The address of the Payee or Payer. - payee.address is mandatory when the paymentType is an INTERNATIONAL payment - An Institution may require you…
10 properties
Payer
object
Conditional. Details of the benefactor [person or business].
3 properties 1 required
PreAuthorisationResponse
object
19 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
PayeeDetails
object
Mandatory. Details of the beneficiary [person or business].
4 properties 3 required
AccountAuthorisationRequest
object
8 properties 1 required
ApiResponseOfPreAuthorisationResponse
object
6 properties
PreAuthorisationRequest
object
8 properties 2 required
PaymentAuthorisationRequest
object
The request body containing an PaymentAuthorisationRequest json payload
8 properties 2 required
PaymentRequest
object
Mandatory. The payment request object defining the details of the payment.
12 properties 4 required
ScaMethod
object
Conditional. Used to update the authorisation with the sca method of the user's choice for the Institution that uses the embedded authorisation flow. If the us…
5 properties 1 required
ApiResponseOfPaymentEmbeddedAuthorisationRequestResponse
object
6 properties
ApiError
object
Provides details of the error that has occurred.
6 properties
InstitutionError
object
Raw error details provided by the Institution, when it was the error source.
2 properties
ResponseForwardedData
object
2 properties
ApiResponseOfPaymentAuthorisationRequestResponse
object
6 properties
ExchangeRateInformationResponse
object
5 properties 2 required
AuthorisationStatus
string
Current status of the embedded authorisation request in code form.
AccountIdentificationType
string
Mandatory. Used to describe the format of the account. See [Account Identification Combinations](/payments/payment-resources/intro-to-payment-executionaccount-…
RawResponse
object
[DEPRECATED] Interaction (raw request and response) that occurred with the Institution in order to fulfil a request.
5 properties
FrequencyRequest
object
Mandatory. Defines the intervals at which payment should be made.
4 properties 1 required
ApiResponseOfAccountAuthorisationResponse
object
6 properties
AccountInfo
object
Conditional. Used to create a request for the balance of the account specified. Once the user authorises the request, only the balance can be obtained by execu…
2 properties 1 required
AccountRequest
object
Conditional. Used to further specify details of the Consent to request Conditions: 1. Mandatory to specify the individual scopes to request from the user at th…
7 properties
PriorityCodeEnum
string
UserCredentials
object
Conditional. Used to capture the user's credentials to allow them to login to an Institution that uses the embedded account authorisation flow. This is the fir…
3 properties 2 required
FeatureEnum
string
Used to describe what functions are supported by the associated Institution. For more information on each feature, see the following links: - [Financial Data F…
ApiResponseOfEmbeddedAccountAuthorisationResponse
object
6 properties
PaymentType
string
Mandatory. Used to specify which of the [payment types](/payments/payment-resources/intro-to-payment-executionpayment-types) to execute. See [European Payments…
EmbeddedAccountAuthorisationResponse
object
21 properties
Amount
object
Mandatory. Monetary Amount.
2 properties 2 required
BulkPaymentAuthorisationRequest
object
8 properties 1 required
BulkPaymentRequest
object
The payment request object defining the details of the bulk payment
3 properties 1 required
FrequencyEnumExtended
string
Mandatory. See [payment frequency](/guides/payments/payment-execution/periodic-payments/payment-frequency) for more information
Type
string
The SCA method type available for the user
PeriodicPaymentRequest
object
Conditional. Used to specify properties to define a periodic payment. Must be specified when the payment type is one of the following: - DOMESTICPERIODICPAYMEN…
6 properties 1 required
EmbeddedAccountAuthorisationRequest
object
11 properties 1 required
PaymentPreAuthorisationRequest
object
Mandatory. The payment pre authorisation request object defining the details of the payment and pre auth.
12 properties 6 required
PaymentChargeDetails
object
Details the charges that will apply to the payment.
3 properties
RateTypeEnum
string
Mandatory. The type used to complete the currency exchange.
ResponseMeta
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yapily-authorisations-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 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 Notifications API
AE Profile APIs.io
Yapily User Beneficiaries API
AE Profile APIs.io
#Authorisations
← Back to Y APIs
API Details
ID
yapily:yapily-authorisations-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-authorisations-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/yapily-authorisations-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 Authorisations 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.