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.2.0, 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.
Categorisation
object
Income and Expense categorisation that the Yapily categorisation engine has determined for the transaction.
2 properties
FilteredClientPayloadListPaymentResponse
object
6 properties
PaymentStatus
string
The status of the Payment. For more information, see [Payment Status](/guides/payments/payment-status/)
Account
object
13 properties
TransactionChargeDetails
object
Details the charges that will apply to the transaction.
1 property
ApiListResponseOfDirectDebitResponse
object
7 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
RefundAccount
object
The account to which funds should be returned if the payment is to be later refunded.
2 properties
ApiResponseOfIdentity
object
6 properties
AccountName
object
1 property
ResponseMeta
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
ConsolidatedAccountInformation
object
Summary information regarding account balances of the overall account provided by the bank
2 properties
ApiResponseOfBalances
object
6 properties
Enrichment
object
Enriched data that has been derived by Yapily using it's data processing and machine learning techniques.
7 properties
ApiResponseOfAccountStatement
object
6 properties
PaymentIsoStatus
object
The payment status code, as denoted by a 3-letter ISO 20022 code.
2 properties
IsoBankTransactionCode
object
Defines the underlying transaction type (e.g. Card or Debit Transactions, Loans or Mortages). Conforms to ISO standards - ISO 20022.
3 properties
FilteredClientPayloadListTransaction
object
6 properties
Pagination
object
3 properties
AccountIdentification
object
2 properties
2 required
CreditLineType
string
Mandatory. The type of credit that has been provided.
TransactionBalance
object
2 properties
ApiListResponseOfRealTimeTransaction
object
6 properties
FilteredClientPayloadListDirectDebitResponse
object
6 properties
CurrencyExchange
object
Provides details on the currrency exchange.
4 properties
AddressDetails
object
1 property
PaymentResponse
object
32 properties
AccountIdentificationType
string
Mandatory. Used to describe the format of the account. See [Account Identification Combinations](/payments/payment-resources/intro-to-payment-executionaccount-…
IdentityAddress
object
8 properties
MultiAuthorisation
object
Details the additional levels of authorisation which are required from, and being managed by, the Institution.
5 properties
ResponseListMeta
object
3 properties
ApiError
object
Provides details of the error that has occurred.
6 properties
Amount
object
Mandatory. Monetary Amount.
2 properties
2 required
Payee
object
Mandatory. Details of the beneficiary [person or business].
6 properties
2 required
FilterAndSort
object
6 properties
FilteredClientPayloadListAccountStatement
object
6 properties
AddressTypeEnum
string
Optional. The type of address
StatementReference
object
Unique reference for a statement period. This may be optionally populated if available.
1 property
Payer
object
Conditional. Details of the benefactor [person or business].
3 properties
1 required
Transaction
object
Details of a transaction (credit or debit) that has occurred on the account.
25 properties
RawResponse
object
[DEPRECATED] Interaction (raw request and response) that occurred with the Institution in order to fulfil a request.
5 properties
AccountBalanceType
string
Specifies the type of the stated account balance.
Identity
object
Identification details of a party associated with an account e.g. (account owner or operator).
9 properties
UsageType
string
The customer segment of the account.
Merchant
object
Details of the merchant involved in the transaction.
2 properties
ResponseMetaWithCount
object
2 properties
Balances
object
2 properties
ApiListResponseOfPaymentResponse
object
7 properties
ProprietaryBankTransactionCode
object
Transaction code that is proprietary to the Institution.
2 properties
FrequencyResponse
object
Mandatory. Defines the intervals at which payment should be made.
4 properties
PaymentChargeDetails
object
Details the charges that will apply to the payment.
3 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
TransactionStatusEnum
string
DirectDebitResponse
object
6 properties
PayeeAccountType
string
Optional. The payee account type. Allowed values: BUSINESS, BUSINESSSAVING, CHARITY, COLLECTION, CORPORATE, EWALLET, GOVERNMENT, INVESTMENT, INVESTMENTISA, JOI…
EnrichmentMerchant
object
Details of the merchant, identified by Yapily data services.
2 properties
CreditLine
object
Mandatory. Details whether the account has access to a credit line from an Institution.
2 properties
FilteredClientPayloadListAccount
object
6 properties
InstitutionError
object
Raw error details provided by the Institution, when it was the error source.
2 properties
RealTimeTransaction
object
21 properties
IsoCodeDetails
object
Mandatory. Details the identification of the ISO code.
2 properties
Beneficiary
object
Account information belonging to the target beneficiary (person/ business).
4 properties
ApiListResponseOfAccountStatement
object
7 properties
ExchangeRateInformationResponse
object
5 properties
2 required
ApiListResponseOfTransaction
object
7 properties
PaymentStatusDetails
object
6 properties
DirectDebitPayee
object
1 property
RawRequest
object
8 properties
RateTypeEnum
string
Mandatory. The type used to complete the currency exchange.
AccountType
string
The type of account e.g. (Credit Card, Savings).
ApiResponseOfAccount
object
6 properties
PaymentIsoStatusCodeEnum
string
The ISO 20022 PaymentStatusCode.
ApiListResponseOfBeneficiary
object
6 properties
SortEnum
string
The attribute on which resources / records returned should be sorted. Valid options for the sort parameter.
AccountApiListResponse
object
7 properties
FrequencyEnumExtended
string
Mandatory. See [payment frequency](/guides/payments/payment-execution/periodic-payments/payment-frequency) for more information
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
AccountStatement
object
Statement information belonging to the account.
4 properties
AccountBalance
object
5 properties
ResponseForwardedData
object
2 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Yapily publishes across the network.
