Yapily Financial Data API
In order to access a user's Financial Data, you are required to request an [Authorisation](#tag/Authorisations) from the user to share the account information the bank has. Once a `consent-token` is obtained, you can call the necessary Financial Data endpoint(s) to retrieve the user's data.
Yapily Financial Data 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 Financial Data. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 4 JSON Schemas.
This API exposes 13 operations across 13 paths, and defines 84 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.
13 operations
13 paths
84 schemas
13 GET
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Yapily Financial Data 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 13
Across 13 paths, the API surfaces 13 operations — 13 GET. Each is listed below with its method, path, parameters, and response codes.
Financial Data 13
In order to access a user's Financial Data, you are required to request an [Authorisation](tag/Authorisations) from the user to share the account information the bank has. Once a…
GET
/accounts
Get Accounts
GET
/accounts/{accountId}
Get Account
GET
/accounts/{accountId}/balances
Get Account Balances
GET
/accounts/{accountId}/beneficiaries
Get Account Beneficiaries
GET
/accounts/{accountId}/direct-debits
Get Account Direct Debits
GET
/accounts/{accountId}/periodic-payments
Get Account Periodic Payments
GET
/accounts/{accountId}/scheduled-payments
Get Account Scheduled Payments
GET
/accounts/{accountId}/statements
Get Account Statements
GET
/accounts/{accountId}/statements/{statementId}
Get Account Statement
GET
/accounts/{accountId}/statements/{statementId}/file
Get Account Statement File
GET
/accounts/{accountId}/transactions
Get Account Transactions
GET
/identity
Get Identity
GET
/accounts/{accountId}/real-time/transactions
Get Real Time Account Transactions
Schemas 84
The contract defines 84 schemas that model the data the API accepts and returns. The most detailed are PaymentResponse (32 properties), Transaction (25 properties), RealTimeTransaction (21 properties), Account (13 properties). Each schema is shown below with its type and property counts.
ApiListResponseOfTransaction
object
7 properties
PaymentResponse
object
32 properties
ApiListResponseOfRealTimeTransaction
object
6 properties
ExchangeRateInformationResponse
object
5 properties
2 required
IsoBankTransactionCode
object
Defines the underlying transaction type (e.g. Card or Debit Transactions, Loans or Mortages). Conforms to ISO standards - ISO 20022.
3 properties
PaymentIsoStatusCodeEnum
string
The ISO 20022 PaymentStatusCode.
IdentityAddress
object
8 properties
FilteredClientPayloadListTransaction
object
6 properties
FrequencyResponse
object
Mandatory. Defines the intervals at which payment should be made.
4 properties
AddressTypeEnum
string
Optional. The type of address
RateTypeEnum
string
Mandatory. The type used to complete the currency exchange.
IsoCodeDetails
object
Mandatory. Details the identification of the ISO code.
2 properties
ApiError
object
Provides details of the error that has occurred.
6 properties
ApiListResponseOfBeneficiary
object
6 properties
AccountBalance
object
5 properties
Account
object
13 properties
PaymentChargeDetails
object
Details the charges that will apply to the payment.
3 properties
Categorisation
object
Income and Expense categorisation that the Yapily categorisation engine has determined for the transaction.
2 properties
RefundAccount
object
The account to which funds should be returned if the payment is to be later refunded.
2 properties
RealTimeTransaction
object
21 properties
FilteredClientPayloadListAccountStatement
object
6 properties
ApiListResponseOfAccountStatement
object
7 properties
FilteredClientPayloadListAccount
object
6 properties
MultiAuthorisation
object
Details the additional levels of authorisation which are required from, and being managed by, the Institution.
5 properties
AccountIdentificationType
string
Mandatory. Used to describe the format of the account. See [Account Identification Combinations](/payments/payment-resources/intro-to-payment-executionaccount-…
Merchant
object
Details of the merchant involved in the transaction.
2 properties
CurrencyExchange
object
Provides details on the currrency exchange.
4 properties
Next
object
4 properties
StatementReference
object
Unique reference for a statement period. This may be optionally populated if available.
1 property
FilterAndSort
object
6 properties
AccountName
object
1 property
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
AccountApiListResponse
object
7 properties
SortEnum
string
The attribute on which resources / records returned should be sorted. Valid options for the sort parameter.
FilteredClientPayloadListPaymentResponse
object
6 properties
ResponseMeta
object
1 property
TransactionChargeDetails
object
Details the charges that will apply to the transaction.
1 property
ProprietaryBankTransactionCode
object
Transaction code that is proprietary to the Institution.
2 properties
EnrichmentMerchant
object
Details of the merchant, identified by Yapily data services.
2 properties
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
ConsolidatedAccountInformation
object
Summary information regarding account balances of the overall account provided by the bank
2 properties
Payer
object
Conditional. Details of the benefactor [person or business].
3 properties
1 required
ResponseForwardedData
object
2 properties
AccountType
string
The type of account e.g. (Credit Card, Savings).
FrequencyEnumExtended
string
Mandatory. See [payment frequency](/guides/payments/payment-execution/periodic-payments/payment-frequency) for more information
DirectDebitResponse
object
6 properties
Beneficiary
object
Account information belonging to the target beneficiary (person/ business).
4 properties
TransactionStatusEnum
string
PaymentIsoStatus
object
The payment status code, as denoted by a 3-letter ISO 20022 code.
2 properties
ApiCall
object
Transaction
object
Details of a transaction (credit or debit) that has occurred on the account.
25 properties
ApiResponseOfIdentity
object
6 properties
ResponseListMeta
object
3 properties
AddressDetails
object
1 property
ApiListResponseOfDirectDebitResponse
object
7 properties
Enrichment
object
Enriched data that has been derived by Yapily using it's data processing and machine learning techniques.
7 properties
PriorityCodeEnum
string
PaymentStatus
string
The status of the Payment. For more information, see [Payment Status](/guides/payments/payment-status/)
RawResponse
object
[DEPRECATED] Interaction (raw request and response) that occurred with the Institution in order to fulfil a request.
5 properties
TransactionBalance
object
2 properties
Identity
object
Identification details of a party associated with an account e.g. (account owner or operator).
9 properties
AccountIdentification
object
2 properties
2 required
PayeeAccountType
string
Optional. The payee account type. Allowed values: BUSINESS, BUSINESSSAVING, CHARITY, COLLECTION, CORPORATE, EWALLET, GOVERNMENT, INVESTMENT, INVESTMENTISA, JOI…
ApiResponseOfAccountStatement
object
6 properties
AccountBalanceType
string
Specifies the type of the stated account balance.
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
AccountStatement
object
Statement information belonging to the account.
4 properties
UsageType
string
The customer segment of the account.
DirectDebitPayee
object
1 property
ResponseMetaWithCount
object
2 properties
Pagination
object
3 properties
ApiListResponseOfPaymentResponse
object
7 properties
Amount
object
Mandatory. Monetary Amount.
2 properties
2 required
CreditLineType
string
Mandatory. The type of credit that has been provided.
TransactionHash
object
An unique identifier for the transaction that was generated by Yapily. This is a hash of transaction attributes and may be useful an id is not present (and the…
1 property
Balances
object
2 properties
BeneficiaryPayee
object
Mandatory. Account details belonging to the Beneficiary Payee (person/ business). You must define this in your payment request along with all of the nested man…
3 properties
1 required
RawRequest
object
8 properties
FilteredClientPayloadListDirectDebitResponse
object
6 properties
PaymentStatusDetails
object
6 properties
ApiResponseOfBalances
object
6 properties
CreditLine
object
Mandatory. Details whether the account has access to a credit line from an Institution.
2 properties
ApiResponseOfAccount
object
6 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Yapily 12
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 Constraints API
Yapily Hosted Consent Pages API
Yapily Hosted Payment Pages API
Yapily Notifications API
Yapily User Beneficiaries API
#Financial Data