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.0.1, at version 12.4.0.
Requests are made against a single base URL, https://api.yapily.com.
The identity and technical contract details declared by the specification.
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
EmbeddedAccountAuthorisationRequest
object
11 properties
1 required
ResponseMeta
object
1 property
PayerDetails
object
Conditional. Details of the benefactor [person or business].
1 property
1 required
ApiError
object
Provides details of the error that has occurred.
6 properties
ApiResponseOfPaymentAuthorisationRequestResponse
object
6 properties
RawResponse
object
[DEPRECATED] Interaction (raw request and response) that occurred with the Institution in order to fulfil a request.
5 properties
PaymentRequest
object
Mandatory. The payment request object defining the details of the payment.
12 properties
4 required
PreAuthorisationResponse
object
19 properties
PaymentEmbeddedAuthorisationRequestResponse
object
24 properties
FrequencyRequest
object
Mandatory. Defines the intervals at which payment should be made.
4 properties
1 required
PaymentContextType
string
Optional. The payment context code. This defaults to OTHER if not specified.
AccountIdentification
object
2 properties
2 required
PaymentAuthorisationRequest
object
The request body containing an PaymentAuthorisationRequest json payload
8 properties
2 required
PayeeAccountType
string
Optional. The payee account type. Allowed values: BUSINESS, BUSINESSSAVING, CHARITY, COLLECTION, CORPORATE, EWALLET, GOVERNMENT, INVESTMENT, INVESTMENTISA, JOI…
PaymentChargeDetails
object
Details the charges that will apply to the payment.
3 properties
AccountAuthorisationRequest
object
8 properties
1 required
AccountAuthorisationResponse
object
21 properties
PayeeDetails
object
Mandatory. Details of the beneficiary [person or business].
4 properties
3 required
PaymentAuthorisationRequestResponse
object
22 properties
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…
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
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
InstitutionError
object
Raw error details provided by the Institution, when it was the error source.
2 properties
Payee
object
Mandatory. Details of the beneficiary [person or business].
6 properties
2 required
AuthorisationStatus
string
Current status of the embedded authorisation request in code form.
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
ExchangeRateInformationResponse
object
5 properties
2 required
Payer
object
Conditional. Details of the benefactor [person or business].
3 properties
1 required
ResponseForwardedData
object
2 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
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
ApiResponseOfAccountAuthorisationResponse
object
6 properties
RedirectRequest
object
Optional. The server to redirect the user to after the user complete the authorisation at the Institution.
1 property
1 required
ApiResponseOfPaymentEmbeddedAuthorisationRequestResponse
object
6 properties
ExchangeRateInformation
object
Optional. Used to provide details on the currency exchange rate and contract.
4 properties
2 required
FrequencyEnumExtended
string
Mandatory. See [payment frequency](/guides/payments/payment-execution/periodic-payments/payment-frequency) for more information
ApiResponseOfEmbeddedAccountAuthorisationResponse
object
6 properties
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
PaymentType
string
Mandatory. Used to specify which of the [payment types](/payments/payment-resources/intro-to-payment-executionpayment-types) to execute. See [European Payments…
Amount
object
Mandatory. Monetary Amount.
2 properties
2 required
Type
string
The SCA method type available for the user
AccountIdentificationType
string
Mandatory. Used to describe the format of the account. See [Account Identification Combinations](/payments/payment-resources/intro-to-payment-executionaccount-…
ApiResponseOfPreAuthorisationResponse
object
6 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,…
AddressTypeEnum
string
Optional. The type of address
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…
PreAuthorisationRequest
object
8 properties
2 required
EmbeddedAccountAuthorisationResponse
object
21 properties
BulkPaymentAuthorisationRequest
object
8 properties
1 required
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
PaymentPreAuthorisationRequest
object
Mandatory. The payment pre authorisation request object defining the details of the payment and pre auth.
12 properties
6 required
BulkPaymentRequest
object
The payment request object defining the details of the bulk payment
3 properties
1 required
PaymentEmbeddedAuthorisationRequest
object
The request body containing an PaymentEmbeddedAuthorisationRequest json payload
10 properties
2 required
RawRequest
object
8 properties
RateTypeEnum
string
Mandatory. The type used to complete the currency exchange.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Yapily publishes across the network.
