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.0.1, 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.
PriorityCodeEnum
string
ResponseMeta
object
1 property
PaymentResponse
object
32 properties
ApiResponseOfPaymentResponse
object
6 properties
ApiError
object
Provides details of the error that has occurred.
6 properties
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
PaymentRequest
object
Mandatory. The payment request object defining the details of the payment.
12 properties4 required
ApiResponseOfPaymentResponses
object
6 properties
FrequencyRequest
object
Mandatory. Defines the intervals at which payment should be made.
4 properties1 required
PaymentContextType
string
Optional. The payment context code. This defaults to OTHER if not specified.
Details the charges that will apply to the payment.
3 properties
RefundAccount
object
The account to which funds should be returned if the payment is to be later refunded.
2 properties
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 properties1 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 properties2 required
BulkPaymentDetailsResponse
object
2 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
ApiErrorResponseV2
object
API Error Response
1 property
ExchangeRateInformationResponse
object
5 properties2 required
BulkPaymentStatusDetails
object
6 properties
Payer
object
Conditional. Details of the benefactor [person or business].
3 properties1 required
ResponseForwardedData
object
2 properties
PaymentIsoStatusCodeEnum
string
The ISO 20022 PaymentStatusCode.
PaymentResponses
object
1 property
ExchangeRateInformation
object
Optional. Used to provide details on the currency exchange rate and contract.
4 properties2 required
FrequencyEnumExtended
string
Mandatory. See [payment frequency](/guides/payments/payment-execution/periodic-payments/payment-frequency) for more information
SubmitBulkPaymentRequest
object
The payment request object defining the details of the bulk payment
4 properties1 required
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
PaymentType
string
Mandatory. Used to specify which of the [payment types](/payments/payment-resources/intro-to-payment-executionpayment-types) to execute. See [European Payments…
BulkPaymentIndividualStatus
object
3 properties2 required
MultiAuthorisation
object
Details the additional levels of authorisation which are required from, and being managed by, the Institution.
5 properties
Amount
object
Mandatory. Monetary Amount.
2 properties2 required
AccountIdentificationType
string
Mandatory. Used to describe the format of the account. See [Account Identification Combinations](/payments/payment-resources/intro-to-payment-executionaccount-…
FrequencyResponse
object
Mandatory. Defines the intervals at which payment should be made.
The payment status code, as denoted by a 3-letter ISO 20022 code.
2 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…
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
RawRequest
object
8 properties
RateTypeEnum
string
Mandatory. The type used to complete the currency exchange.
PaymentStatusDetails
object
6 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
