Yapily Hosted Payment Pages API
Hosted Payment Pages endpoints for payments products
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.0.1, at version 12.4.0.
Requests are made against a single base URL, https://api.yapily.com.
10 operations
9 paths
73 schemas
4 GET6 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Yapily Hosted Payment Pages 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 10
Across 9 paths, the API surfaces 10 operations — 4 GET, 6 POST. Each is listed below with its method, path, parameters, and response codes.
Hosted Payment Pages 10
Hosted Payment Pages endpoints for payments products
POST
/hosted/payment-requests
Create Hosted Payment Request
POST
/hosted/payment-requests/links
Create Pay by Link
GET
/hosted/payment-requests/{paymentRequestId}
Get Hosted Payment Request
POST
/hosted/vrp/consent-requests
Create Vrp Consent
GET
/hosted/vrp/consent-requests
Get Hosted Vrp Consent Requests
GET
/hosted/vrp/consent-requests/{consentRequestId}
Get Hosted Vrp Consent Request
POST
/hosted/vrp/consent-requests/{consentRequestId}/revoke
Revoke Hosted Vrp Consent Request
POST
/hosted/vrp/consent-requests/{consentRequestId}/payments
Create Vrp Payment
GET
/hosted/vrp/consent-requests/{consentRequestId}/payments/{paymentId}
Get Vrp Payment
POST
/hosted/vrp/consent-requests/{consentRequestId}/funds-confirmation
Check Funds Availability
Schemas 73
The contract defines 73 schemas that model the data the API accepts and returns. The most detailed are HostedPayment (16 properties), HostedVRPPaymentResponse (13 properties), HostedVRPConsentDetails (13 properties), HostedPaymentDetails (12 properties). Each schema is shown below with its type and property counts.
HostedVRPPaymentResponse
object
13 properties
HostedNonSweepingPeriodicLimits
object
3 properties
3 required
PaymentContextTypeV2
string
Optional. The payment context code. Allowed values are [BILLINADVANCE, BILLINARREARS, ECOMMERCEMERCHANT, FACETOFACEPOS, TRANSFERTOSELF,TRANSFERTOTHIRDPARTY, PI…
CreateHostedVRPConsentRequest
object
7 properties
3 required
ResponseMeta
object
1 property
GetHostedVRPConsentsResponse
array
ApiError
object
Provides details of the error that has occurred.
6 properties
AddressTypeEnumResponse
string
The type of address
PaymentStatus
string
The status of the Payment. For more information, see [Payment Status](/guides/payments/payment-status/)
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
RawResponse
object
[DEPRECATED] Interaction (raw request and response) that occurred with the Institution in order to fulfil a request.
5 properties
ApiResponseOfRevokeHostedVRPConsentRequest
object
2 properties
PaymentContextTypeResponse
string
The payment context code.
HostedVrpRefundAccount
object
The account to which funds should be returned if the payment is to be later refunded.
2 properties
PaymentContextType
string
Optional. The payment context code. This defaults to OTHER if not specified.
VRPSetupRequest
object
9 properties
1 required
AccountIdentification
object
2 properties
2 required
HostedPaymentIsoStatus
object
The ISO status of the payment.
2 properties
PayeeAccountType
string
Optional. The payee account type. Allowed values: BUSINESS, BUSINESSSAVING, CHARITY, COLLECTION, CORPORATE, EWALLET, GOVERNMENT, INVESTMENT, INVESTMENTISA, JOI…
ApiResponseOfCreateHostedPaymentRequestLink
object
2 properties
HostedVrpAccountIdentification
object
2 properties
2 required
VrpFundsAvailable
object
2 properties
2 required
HostedVrpPayerResponse
object
Conditional. Details of the benefactor [person or business].
3 properties
1 required
HostedVRPLimits
object
The restrictions and limits for payments executed under the VRP consent
5 properties
InstitutionError
object
Raw error details provided by the Institution, when it was the error source.
2 properties
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
Payee
object
Mandatory. Details of the beneficiary [person or business].
6 properties
2 required
HostedPaymentRequestDetailsLink
object
7 properties
HostedPaymentRequestResponse
object
12 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
PaymentTypeResponse
string
Specifies which of the [payment types](/payments/payment-resources/intro-to-payment-executionpayment-types) to execute.
ApiResponseOfCreateHostedVRPPaymentRequest
object
3 properties
CreateHostedPaymentRequest
object
6 properties
3 required
HostedVRPConsentDetails
object
13 properties
4 required
AmountDetailsResponse
object
Monetary Amount.
2 properties
Payer
object
Conditional. Details of the benefactor [person or business].
3 properties
1 required
ResponseForwardedData
object
2 properties
HostedVrpAccountIdentificationType
string
Used to describe the format of the account. Allowed values: MASKEDACCOUNTNUMBER SORTCODE ACCOUNTNUMBER
PayeeDetailsResponse
object
Details of the beneficiary [person or business].
5 properties
ApiResponseOfCreateHostedVRPConsentRequest
object
2 properties
ApiResponseOfGetHostedPaymentRequest
object
2 properties
HostedPayment
object
16 properties
VrpFundsConfirmationResponse
object
4 properties
2 required
CreateHostedPaymentRequestLink
object
7 properties
3 required
HostedPaymentResponseDetails
object
Details of the payment.
8 properties
AddressResponse
object
The address of the Payee or Payer.
10 properties
HostedAmountDetails
object
The payment amount and currency
2 properties
2 required
HostedVRPLimitsRequest
object
The restrictions and limits for payments executed under the VRP consent
4 properties
PaymentRisk
object
Additional information about the payment that may be used for risk scoring
1 property
PayerDetailsResponse
object
Details of the benefactor [person or business].
3 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…
Amount
object
Mandatory. Monetary Amount.
2 properties
2 required
VRPSetup
object
9 properties
1 required
AccountIdentificationType
string
Mandatory. Used to describe the format of the account. See [Account Identification Combinations](/payments/payment-resources/intro-to-payment-executionaccount-…
ApiResponseOfCreateHostedPaymentRequest
object
2 properties
HostedPaymentRequestDetails
object
Details of the payment.
8 properties
4 required
AddressTypeEnum
string
Optional. The type of address
ApiResponseOfGetHostedVRPPaymentRequest
object
3 properties
HostedVRPConsentRequestResponse
object
12 properties
5 required
VrpFundsConfirmationRequest
object
2 properties
1 required
HostedPaymentDetails
object
12 properties
UserSettings
object
Specifies the language and location preferences of the user.
2 properties
ApiResponseOfGetHostedVRPConsentRequest
object
2 properties
AccountIdentificationResponse
object
2 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
HostedPaymentPhase
object
The phase of the payment.
2 properties
HostedPaymentStatusDetails
object
The status of the payment.
3 properties
InstitutionIdentifiersResponse
object
Specifies the institution selected for making the payment.
2 properties
ApiResponseOfVrpFundsConfirmationResponse
object
6 properties
HostedVRPPhase
object
The phase of the VRP Consent Request.
2 properties
ApiResponseOfGetHostedVRPConsentsRequest
object
2 properties
RawRequest
object
8 properties
AccountIdentificationTypeResponse
string
Used to describe the format of the account. See [Account Identification Combinations](/payments/payment-resources/intro-to-payment-executionaccount-identificat…
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 Financial Data API
Yapily Hosted Consent Pages API
Yapily Notifications API
Yapily User Beneficiaries API
#Hosted Payment Pages