Yapily Hosted Payment Pages 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 Hosted Payment Pages. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 4 JSON Schemas.
This API exposes
10 operations
across 9 paths,
and defines 73 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.
Payee
object
Mandatory. Details of the beneficiary [person or business].
6 properties
2 required
PaymentContextTypeV2
string
Optional. The payment context code. Allowed values are [BILLINADVANCE, BILLINARREARS, ECOMMERCEMERCHANT, FACETOFACEPOS, TRANSFERTOSELF,TRANSFERTOTHIRDPARTY, PI…
ApiResponseOfVrpFundsConfirmationResponse
object
6 properties
AccountIdentificationTypeResponse
string
Used to describe the format of the account. See [Account Identification Combinations](/payments/payment-resources/intro-to-payment-executionaccount-identificat…
PaymentContextTypeResponse
string
The payment context code.
ApiResponseOfCreateHostedVRPPaymentRequest
object
3 properties
InstitutionIdentifiers
object
Specifies the institution requirements for making the payment. Skips the bank selection screen in payment flow if the institutionId and institutionCountryCode…
2 properties
1 required
AccountIdentification
object
2 properties
2 required
AddressTypeEnum
string
Optional. The type of address
AddressResponse
object
The address of the Payee or Payer.
10 properties
PayerDetailsResponse
object
Details of the benefactor [person or business].
3 properties
HostedVrpAccountIdentification
object
2 properties
2 required
HostedPaymentPhase
object
The phase of the payment.
2 properties
HostedVRPLimits
object
The restrictions and limits for payments executed under the VRP consent
5 properties
AccountIdentificationResponse
object
2 properties
VrpFundsAvailable
object
2 properties
2 required
PaymentContextType
string
Optional. The payment context code. This defaults to OTHER if not specified.
PaymentRisk
object
Additional information about the payment that may be used for risk scoring
1 property
RawRequest
object
8 properties
HostedPaymentRequestDetails
object
Details of the payment.
8 properties
4 required
UserSettings
object
Specifies the language and location preferences of the user.
2 properties
PayeeAccountType
string
Optional. The payee account type. Allowed values: BUSINESS, BUSINESSSAVING, CHARITY, COLLECTION, CORPORATE, EWALLET, GOVERNMENT, INVESTMENT, INVESTMENTISA, JOI…
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
Payer
object
Conditional. Details of the benefactor [person or business].
3 properties
1 required
HostedPayment
object
16 properties
CreateHostedPaymentRequest
object
6 properties
3 required
CreateHostedVRPConsentRequest
object
7 properties
3 required
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
HostedAmountDetails
object
The payment amount and currency
2 properties
2 required
CreateHostedVRPPaymentRequest
object
Mandatory. The payment request object defining the details of the payment for execution under the Variable Recurring Payment consent.
2 properties
2 required
HostedVrpPayerResponse
object
Conditional. Details of the benefactor [person or business].
3 properties
1 required
VrpFundsConfirmationResponse
object
4 properties
2 required
HostedVrpAccountIdentificationType
string
Used to describe the format of the account. Allowed values: MASKEDACCOUNTNUMBER SORTCODE ACCOUNTNUMBER
HostedVRPPhase
object
The phase of the VRP Consent Request.
2 properties
ApiResponseOfCreateHostedVRPConsentRequest
object
2 properties
HostedNonSweepingPeriodicLimits
object
3 properties
3 required
PaymentTypeResponse
string
Specifies which of the [payment types](/payments/payment-resources/intro-to-payment-executionpayment-types) to execute.
HostedPaymentRequestResponse
object
12 properties
AmountDetailsResponse
object
Monetary Amount.
2 properties
ApiResponseOfGetHostedPaymentRequest
object
2 properties
HostedPaymentIsoStatus
object
The ISO status of the payment.
2 properties
ApiError
object
Provides details of the error that has occurred.
6 properties
InstitutionError
object
Raw error details provided by the Institution, when it was the error source.
2 properties
ResponseForwardedData
object
2 properties
PaymentStatus
string
The status of the Payment. For more information, see [Payment Status](/guides/payments/payment-status/)
ApiResponseOfGetHostedVRPPaymentRequest
object
3 properties
ApiResponseOfGetHostedVRPConsentsRequest
object
2 properties
HostedVrpRefundAccount
object
The account to which funds should be returned if the payment is to be later refunded.
2 properties
AccountIdentificationType
string
Mandatory. Used to describe the format of the account. See [Account Identification Combinations](/payments/payment-resources/intro-to-payment-executionaccount-…
AddressTypeEnumResponse
string
The type of address
RawResponse
object
[DEPRECATED] Interaction (raw request and response) that occurred with the Institution in order to fulfil a request.
5 properties
ApiResponseOfCreateHostedPaymentRequestLink
object
2 properties
ApiResponseOfCreateHostedPaymentRequest
object
2 properties
VRPSetup
object
9 properties
1 required
PayeeDetailsResponse
object
Details of the beneficiary [person or business].
5 properties
InstitutionIdentifiersResponse
object
Specifies the institution selected for making the payment.
2 properties
HostedPaymentRequestDetailsLink
object
7 properties
PaymentType
string
Mandatory. Used to specify which of the [payment types](/payments/payment-resources/intro-to-payment-executionpayment-types) to execute. See [European Payments…
CreateHostedPaymentRequestLink
object
7 properties
3 required
HostedPaymentStatusDetails
object
The status of the payment.
3 properties
Amount
object
Mandatory. Monetary Amount.
2 properties
2 required
HostedVRPConsentDetails
object
13 properties
4 required
ApiResponseOfRevokeHostedVRPConsentRequest
object
2 properties
ApiResponseOfGetHostedVRPConsentRequest
object
2 properties
HostedVRPLimitsRequest
object
The restrictions and limits for payments executed under the VRP consent
4 properties
HostedVRPPaymentResponse
object
13 properties
VrpFundsConfirmationRequest
object
2 properties
1 required
VRPSetupRequest
object
9 properties
1 required
GetHostedVRPConsentsResponse
array
HostedPaymentDetails
object
12 properties
ResponseMeta
object
1 property
HostedPaymentResponseDetails
object
Details of the payment.
8 properties
HostedVRPConsentRequestResponse
object
12 properties
5 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Yapily publishes across the network.
