Payment Initiation Service Provider (PISP) endpoints for initiating single, scheduled, periodic, bulk, and international payments directly from a customer's bank account. Single-use consent per payment.
Yapily Payments API (PIS) is one of 16 APIs that Yapily publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 2 JSON Schema definitions.
Tagged areas include Payments, PISP, Payment Initiation, Open Banking, and PSD2. The published artifact set on APIs.io includes API documentation, an OpenAPI specification, and 2 JSON Schemas.
This API exposes
5 operations
across 5 paths,
and defines 47 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.
5 operations5 paths47 schemas3 GET2 POST
Metadata
The identity and technical contract details declared by the specification.
Yapily Payments API (PIS) 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 5
Across 5 paths, the API surfaces 5 operations — 3 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.
Payments 5
In order to make a Payment on behalf of a user, you are required to request an [Authorisation](tag/Authorisations) from the user to authorise the user's account to make the paymen…
The contract defines 47 schemas that model the data the API accepts and returns. The most detailed are BulkPaymentResponse (34 properties), PaymentResponse (32 properties), PaymentRequest (12 properties), Address (10 properties). Each schema is shown below with its type and property counts.
Payer
object
Conditional. Details of the benefactor [person or business].
3 properties1 required
PriorityCodeEnum
string
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…
[DEPRECATED] Interaction (raw request and response) that occurred with the Institution in order to fulfil a request.
5 properties
SubmitBulkPaymentRequest
object
The payment request object defining the details of the bulk payment
4 properties1 required
ApiErrorResponseV2
object
API Error Response
1 property
PaymentStatus
string
The status of the Payment. For more information, see [Payment Status](/guides/payments/payment-status/)
ExchangeRateInformationResponse
object
5 properties2 required
PaymentRequest
object
Mandatory. The payment request object defining the details of the payment.
12 properties4 required
ApiResponseOfPaymentResponse
object
6 properties
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…
RefundAccount
object
The account to which funds should be returned if the payment is to be later refunded.
2 properties
BulkPaymentIndividualStatus
object
3 properties2 required
BulkPaymentStatusDetails
object
6 properties
PaymentResponses
object
1 property
PaymentStatusDetails
object
6 properties
RawRequest
object
8 properties
BulkPaymentDetailsResponse
object
2 properties
BulkPaymentResponse
object
34 properties
RateTypeEnum
string
Mandatory. The type used to complete the currency exchange.
FrequencyRequest
object
Mandatory. Defines the intervals at which payment should be made.
4 properties1 required
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-…
ResponseMeta
object
1 property
PaymentChargeDetails
object
Details the charges that will apply to the payment.
3 properties
MultiAuthorisation
object
Details the additional levels of authorisation which are required from, and being managed by, the Institution.
5 properties
FrequencyResponse
object
Mandatory. Defines the intervals at which payment should be made.
4 properties
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
ApiError
object
Provides details of the error that has occurred.
6 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
ExchangeRateInformation
object
Optional. Used to provide details on the currency exchange rate and contract.
Mandatory. See [payment frequency](/guides/payments/payment-execution/periodic-payments/payment-frequency) for more information
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 properties1 required
PaymentIsoStatus
object
The payment status code, as denoted by a 3-letter ISO 20022 code.
2 properties
Payee
object
Mandatory. Details of the beneficiary [person or business].
6 properties2 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…
AddressTypeEnum
string
Optional. The type of address
PaymentContextType
string
Optional. The payment context code. This defaults to OTHER if not specified.
InstitutionError
object
Raw error details provided by the Institution, when it was the error source.
2 properties
ResponseForwardedData
object
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
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.
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 Payments API (PIS), 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.
