Yapily

Yapily Hosted Payment Pages API

Hosted Payment Pages endpoints for payments products

Documentation GitHub OpenAPI

Operations 10

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 #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/yapily-hosted-payment-pages-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Yapily Beneficiaries Application Beneficiaries Hosted Payment Pages API
  description: Application and User Beneficiaries endpoints for managing reusable payment counterparties.
  version: 12.4.0
  contact:
    name: Yapily Support
    url: https://docs.yapily.com/resources/support
    email: support@yapily.com
servers:
- url: https://api.yapily.com
security:
- basicAuth: []
tags:
- description: Hosted Payment Pages endpoints for payments products
  name: Hosted Payment Pages
paths:
  /hosted/payment-requests:
    post:
      description: Used to initiate a payment request using Yapily Hosted Pages.
      x-beta: true
      operationId: createHostedPaymentRequest
      parameters:
      - $ref: '#/components/parameters/SubAppHeader'
      requestBody:
        content:
          application/json;charset=UTF-8:
            examples:
              Create Hosted Payment Request:
                $ref: '#/components/examples/create-hosted-payment-request'
            schema:
              $ref: '#/components/schemas/CreateHostedPaymentRequest'
        required: true
      responses:
        '201':
          content:
            application/json;charset=UTF-8:
              examples:
                Create Hosted Payment Request Response:
                  $ref: '#/components/examples/create-hosted-payment-request-response'
              schema:
                $ref: '#/components/schemas/ApiResponseOfCreateHostedPaymentRequest'
          description: Created
        '400':
          content:
            application/json;charset=UTF-8:
              examples:
                400 Error Response:
                  $ref: '#/components/examples/400-error-response'
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Bad Request
        '401':
          content:
            application/json;charset=UTF-8:
              examples:
                401 Error Response:
                  $ref: '#/components/examples/401-error-response'
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Unauthorized. Credentials are missing or invalid
        '500':
          content:
            application/json;charset=UTF-8:
              examples:
                500 Error Response:
                  $ref: '#/components/examples/500-error-response'
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Unexpected Error
        default:
          content:
            application/json;charset=UTF-8:
              examples:
                Error Response:
                  $ref: '#/components/examples/error-response-code-401'
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Error Response
      summary: Create Hosted Payment Request
      tags:
      - Hosted Payment Pages
      x-mint:
        content: '<Info>Learn more: [Hosted Payment Pages](/tools-and-services/hosted-pages/overview)</Info>'
  /hosted/payment-requests/links:
    post:
      description: Used to created a long lived payment request for Pay By Link
      x-beta: true
      operationId: createHostedPaymentRequestLink
      requestBody:
        content:
          application/json;charset=UTF-8:
            examples:
              Create Hosted Payment Request:
                $ref: '#/components/examples/create-hosted-payment-request-link'
            schema:
              $ref: '#/components/schemas/CreateHostedPaymentRequestLink'
        required: true
      responses:
        '201':
          content:
            application/json;charset=UTF-8:
              examples:
                Create Hosted Payment Request Response:
                  $ref: '#/components/examples/create-hosted-payment-request-link-response'
              schema:
                $ref: '#/components/schemas/ApiResponseOfCreateHostedPaymentRequestLink'
          description: Created
        '400':
          content:
            application/json;charset=UTF-8:
              examples:
                400 Error Response:
                  $ref: '#/components/examples/400-error-response'
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Bad Request
        '401':
          content:
            application/json;charset=UTF-8:
              examples:
                401 Error Response:
                  $ref: '#/components/examples/401-error-response'
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Unauthorized. Credentials are missing or invalid
        '500':
          content:
            application/json;charset=UTF-8:
              examples:
                500 Error Response:
                  $ref: '#/components/examples/500-error-response'
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Unexpected Error
        default:
          content:
            application/json;charset=UTF-8:
              examples:
                Error Response:
                  $ref: '#/components/examples/error-response-code-401'
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Error Response
      summary: Create Pay by Link
      tags:
      - Hosted Payment Pages
      x-mint:
        content: '<Info>Learn more: [Pay By Link](/tools-and-services/pay-by-link/overview)</Info>'
  /hosted/payment-requests/{paymentRequestId}:
    get:
      description: Used to get details of a payment request
      x-beta: true
      operationId: getHostedPaymentRequest
      parameters:
      - description: Unique Identifier of the payment request
        in: path
        name: paymentRequestId
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/SubAppHeader'
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              examples:
                Get Hosted Payment Request Response:
                  $ref: '#/components/examples/get-hosted-payment-request-response'
              schema:
                $ref: '#/components/schemas/ApiResponseOfGetHostedPaymentRequest'
          description: Ok
        '401':
          content:
            application/json;charset=UTF-8:
              examples:
                401 Error Response:
                  $ref: '#/components/examples/401-error-response'
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Unauthorized
        '404':
          content:
            application/json;charset=UTF-8:
              examples:
                404 Error Response:
                  $ref: '#/components/examples/404-error-response'
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Not Found
        '500':
          content:
            application/json;charset=UTF-8:
              examples:
                500 Error Response:
                  $ref: '#/components/examples/500-error-response'
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Unexpected Error
        default:
          content:
            application/json;charset=UTF-8:
              examples:
                Error Response:
                  $ref: '#/components/examples/error-response-code-401'
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Error Response
      summary: Get Hosted Payment Request
      tags:
      - Hosted Payment Pages
  /hosted/vrp/consent-requests:
    post:
      description: Used to initiate a VRP consent / mandate request through Yapily Hosted Pages
      operationId: createHostedVRPConsentRequest
      x-beta: true
      parameters:
      - description: __Mandatory__. The unique identifier of the sub application the request is being submitted on behalf of (e.g. an underlying merchant)
        in: header
        name: sub-application
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              $ref: '#/components/schemas/CreateHostedVRPConsentRequest'
            examples:
              Create Hosted VRP Consent Request:
                $ref: '#/components/examples/create-hosted-vrp-consent-request'
        required: true
      responses:
        '201':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ApiResponseOfCreateHostedVRPConsentRequest'
              examples:
                Create Hosted VRP Consent Response:
                  $ref: '#/components/examples/create-hosted-vrp-consent-response'
          description: Created
        '400':
          content:
            application/json;charset=UTF-8:
              examples:
                400 Error Response:
                  $ref: '#/components/examples/400-error-response'
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Bad Request
        '401':
          content:
            application/json;charset=UTF-8:
              examples:
                401 Error Response:
                  $ref: '#/components/examples/401-error-response'
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Unauthorized. Credentials are missing or invalid
        '500':
          content:
            application/json;charset=UTF-8:
              examples:
                500 Error Response:
                  $ref: '#/components/examples/500-error-response'
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Unexpected Error
      summary: Create Vrp Consent
      tags:
      - Hosted Payment Pages
    get:
      description: Used to get all VRP consent requests initiated through Yapily Hosted Pages
      operationId: getHostedVRPConsentRequests
      x-beta: true
      parameters:
      - description: __Mandatory__. The unique identifier of the sub application the request is being submitted on behalf of (e.g. an underlying merchant)
        in: header
        name: sub-application
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ApiResponseOfGetHostedVRPConsentsRequest'
              examples:
                Get Hosted VRP Consents Response:
                  $ref: '#/components/examples/get-hosted-vrp-consents-response'
          description: Ok
        '400':
          content:
            application/json;charset=UTF-8:
              examples:
                400 Error Response:
                  $ref: '#/components/examples/400-error-response'
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Bad Request
        '401':
          content:
            application/json;charset=UTF-8:
              examples:
                401 Error Response:
                  $ref: '#/components/examples/401-error-response'
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Unauthorized. Credentials are missing or invalid
        '500':
          content:
            application/json;charset=UTF-8:
              examples:
                500 Error Response:
                  $ref: '#/components/examples/500-error-response'
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Unexpected Error
      summary: Get Hosted Vrp Consent Requests
      tags:
      - Hosted Payment Pages
  /hosted/vrp/consent-requests/{consentRequestId}:
    get:
      description: Used to get details of a VRP Consent Request
      operationId: getHostedVrpConsentRequest
      x-beta: true
      parameters:
      - description: The unique identifier of the sub application the request is being submitted on behalf of (e.g. an underlying merchant)
        in: header
        name: sub-application
        schema:
          type: string
      - description: Unique Identifier of the Consent Request
        in: path
        name: consentRequestId
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ApiResponseOfGetHostedVRPConsentRequest'
              examples:
                Get Hosted VRP Consent Response:
                  $ref: '#/components/examples/get-hosted-vrp-consent-response'
          description: Ok
        '401':
          content:
            application/json;charset=UTF-8:
              examples:
                401 Error Response:
                  $ref: '#/components/examples/401-error-response'
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Unauthorized
        '404':
          content:
            application/json;charset=UTF-8:
              examples:
                404 Error Response:
                  $ref: '#/components/examples/404-error-response'
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Not Found
        '500':
          content:
            application/json;charset=UTF-8:
              examples:
                500 Error Response:
                  $ref: '#/components/examples/500-error-response'
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Unexpected Error
      summary: Get Hosted Vrp Consent Request
      tags:
      - Hosted Payment Pages
  /hosted/vrp/consent-requests/{consentRequestId}/revoke:
    post:
      description: Revoke Hosted VRP Consent Request
      operationId: revokeHostedConsentRequest
      x-beta: true
      parameters:
      - description: The unique identifier of the sub application the request is being submitted on behalf of (e.g. an underlying merchant)
        in: header
        name: sub-application
        schema:
          type: string
      - description: Unique Identifier of the Consent Request
        in: path
        name: consentRequestId
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ApiResponseOfRevokeHostedVRPConsentRequest'
              examples:
                Revoke Hosted VRP Consent Response:
                  $ref: '#/components/examples/revoke-hosted-vrp-consent-response'
          description: Ok
        '401':
          content:
            application/json;charset=UTF-8:
              examples:
                401 Error Response:
                  $ref: '#/components/examples/401-error-response'
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Unauthorized
        '404':
          content:
            application/json;charset=UTF-8:
              examples:
                404 Error Response:
                  $ref: '#/components/examples/404-error-response'
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Not Found
        '500':
          content:
            application/json;charset=UTF-8:
              examples:
                500 Error Response:
                  $ref: '#/components/examples/500-error-response'
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Unexpected Error
      summary: Revoke Hosted Vrp Consent Request
      tags:
      - Hosted Payment Pages
  /hosted/vrp/consent-requests/{consentRequestId}/payments:
    post:
      description: Creates a Variable Recurring Payment
      operationId: createHostedVrpPayment
      x-beta: true
      parameters:
      - description: Unique Identifier of the Consent Request
        in: path
        name: consentRequestId
        required: true
        schema:
          type: string
          format: uuid
      - description: __Mandatory__. The `consent-token` containing the user's authorisation to make the request.
        example: '{consentToken}'
        in: header
        name: consent-token
        required: true
        schema:
          type: string
      - description: The unique identifier of the sub application the request is being submitted on behalf of (e.g. an underlying merchant)
        in: header
        name: sub-application
        schema:
          type: string
      requestBody:
        content:
          application/json;charset=UTF-8:
            examples:
              Hosted VRP Payment Request:
                $ref: '#/components/examples/create-hosted-vrp-payment-request'
            schema:
              $ref: '#/components/schemas/CreateHostedVRPPaymentRequest'
        required: true
      responses:
        '201':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ApiResponseOfCreateHostedVRPPaymentRequest'
              examples:
                Hosted VRP Payment Response:
                  $ref: '#/components/examples/create-hosted-vrp-payment-response'
          description: Created
        '401':
          content:
            application/json;charset=UTF-8:
              examples:
                401 Error Response:
                  $ref: '#/components/examples/401-error-response'
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Error Response
        default:
          content:
            application/json;charset=UTF-8:
              examples:
                400 Error Response:
                  $ref: '#/components/examples/400-error-response'
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Error Response
      summary: Create Vrp Payment
      tags:
      - Hosted Payment Pages
  /hosted/vrp/consent-requests/{consentRequestId}/payments/{paymentId}:
    get:
      description: Used to get details of a VRP Payment
      operationId: getHostedVRPPaymentRequest
      x-beta: true
      parameters:
      - description: Unique Identifier of the Consent Request
        in: path
        name: consentRequestId
        required: true
        schema:
          type: string
          format: uuid
      - description: Unique Identifier of the Consent Request
        in: path
        name: paymentId
        required: true
        schema:
          type: string
      - description: The unique identifier of the sub application the request is being submitted on behalf of (e.g. an underlying merchant)
        in: header
        name: sub-application
        schema:
          type: string
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ApiResponseOfGetHostedVRPPaymentRequest'
              examples:
                UK Domestic VRP Payment Example Response:
                  $ref: '#/components/examples/get-hosted-vrp-payment-response'
          description: Ok
        '401':
          content:
            application/json;charset=UTF-8:
              examples:
                401 Error Response:
                  $ref: '#/components/examples/401-error-response'
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Unauthorized
        '404':
          content:
            application/json;charset=UTF-8:
              examples:
                404 Error Response:
                  $ref: '#/components/examples/404-error-response'
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Not Found
        '500':
          content:
            application/json;charset=UTF-8:
              examples:
                500 Error Response:
                  $ref: '#/components/examples/500-error-response'
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Unexpected Error
      summary: Get Vrp Payment
      tags:
      - Hosted Payment Pages
  /hosted/vrp/consent-requests/{consentRequestId}/funds-confirmation:
    post:
      description: "Confirms whether there are available funds on the Payer account to execute a Variable Recurring Payment after obtaining the user's authorisation. \n\nFeatures:\n\n- `VARIABLE_RECURRING_PAYMENT_FUNDS_CONFIRMATION`"
      operationId: createHostedVrpFundsConfirmation
      x-beta: true
      parameters:
      - description: Unique Identifier of the Consent Request
        in: path
        name: consentRequestId
        required: true
        schema:
          type: string
          format: uuid
      - description: __Mandatory__. The `consent-token` containing the user's authorisation to make the request.
        example: '{consentToken}'
        in: header
        name: consent-token
        required: true
        schema:
          type: string
      - description: The unique identifier of the sub application the request is being submitted on behalf of (e.g. an underlying merchant)
        in: header
        name: sub-application
        schema:
          type: string
      requestBody:
        content:
          application/json;charset=UTF-8:
            examples:
              Hosted VRP Payment Request:
                $ref: '#/components/examples/create-hosted-vrp-fund-confirmation'
            schema:
              $ref: '#/components/schemas/VrpFundsConfirmationRequest'
        required: true
      responses:
        '201':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ApiResponseOfVrpFundsConfirmationResponse'
              examples:
                Hosted VRP Payment Response:
                  $ref: '#/components/examples/create-hosted-vrp-fund-confirmation-response'
          description: Created
        '401':
          content:
            application/json;charset=UTF-8:
              examples:
                401 Error Response:
                  $ref: '#/components/examples/401-error-response'
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Error Response
        default:
          content:
            application/json;charset=UTF-8:
              examples:
                400 Error Response:
                  $ref: '#/components/examples/400-error-response'
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Error Response
      summary: Check Funds Availability
      tags:
      - Hosted Payment Pages
components:
  schemas:
    Payer:
      title: Payer Details
      required:
      - accountIdentifications
      type: object
      properties:
        name:
          title: Payer Name
          type: string
          description: The account holder name of the Payer.
          example: John Doe
        accountIdentifications:
          uniqueItems: true
          type: array
          description: __Mandatory__. The account identifications that identify the `Payer` bank account.
          items:
            $ref: '#/components/schemas/AccountIdentification'
        address:
          $ref: '#/components/schemas/Address'
      description: __Conditional__. Details of the benefactor [person or business].
    UserSettings:
      description: Specifies the language and location preferences of the user.
      type: object
      properties:
        language:
          type: string
          description: 2 letter ISO Language code which denotes the language preference for the `User`.
          example: en
        location:
          type: string
          description: 2 letter ISO Country code which denotes the location preference for the `User`.
          example: GB
    VrpFundsConfirmationRequest:
      type: object
      required:
      - paymentAmount
      properties:
        paymentAmount:
          $ref: '#/components/schemas/Amount'
        reference:
          type: string
          description: __Optional__. The reference/description associated with the VRP consent. Limited to a maximum of 18 characters long.
    HostedNonSweepingPeriodicLimits:
      required:
      - maxAmount
      - frequency
      - alignment
      type: object
      properties:
        maxAmount:
          allOf:
          - $ref: '#/components/schemas/Amount'
          description: __Mandatory__. Maximum amount that can be specified in all payment instructions in a given period under this VRP consent. If the Alignment is Calendar, the limit is pro-rated in the first period to the remaining number of days.
        frequency:
          type: string
          description: __Mandatory__. Frequency for which the payment limits are enforced. Allowed values are [MONTHLY].
        alignment:
          type: string
          description: __Mandatory__. Period alignment for which the payment limits are enforced. Allowed values are [CONSENT, CALENDAR]. If CONSENT, then period starts on consent creation date. If CALENDAR, then period lines up with the frequency e.g. WEEKLY period will begin at start of the week in question.
    ApiResponseOfRevokeHostedVRPConsentRequest:
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/ResponseMeta'
        data:
          $ref: '#/components/schemas/HostedVRPConsentDetails'
    PayeeDetailsResponse:
      title: Payee Details
      type: object
      description: ' Details of the beneficiary [person or business].'
      properties:
        name:
          title: Payee Name
          type: string
          description: The account holder name of the beneficiary.
          example: Jane Doe
        accountIdentifications:
          uniqueItems: true
          type: array
          description: The account identifications that identify the `Payee` bank account.
          example:
          - identification: '401016'
            type: SORT_CODE
          - identification: '71518920'
            type: ACCOUNT_NUMBER
          items:
            $ref: '#/components/schemas/AccountIdentificationResponse'
        address:
          $ref: '#/components/schemas/AddressResponse'
        merchantId:
          title: Merchant Id
          type: string
          description: The merchant ID is a unique code provided by the payment processor to the merchant.
          example: '24589303'
        merchantCategoryCode:
          title: Merchant Category
          type: string
          description: The category code of the merchant in case the `Payee` is a business. Specified as a 3-letter ISO 18245 code.
          example: '5551'
    HostedVRPConsentRequestResponse:
      required:
      - id
      - applicationId
      - hostedUrl
      - authToken
      - createdAt
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Represents the Unique Id of the VRP consent request
        userId:
          type: string
          format: uuid
          description: Represents the Unique Id for the `User` assigned by Yapily.
        applicationUserId:
          type: string
          description: Represents the user-friendly reference to the `User`.
        applicationId:
          type: string
          format: uuid
          description: Represents the Unique Id of the `Application` the user is associated with.
        institutionIdentifiers:
          $ref: '#/components/schemas/InstitutionIdentifiers'
        userSettings:
          $ref: '#/components/schemas/UserSettings'
        redirectUrl:
          type: string
          description: URL of client's server to redirect the PSU after completion of the consent authorisation.
          example: https://tpp-application.com
        vrpSetup:
          $ref: '#/components/schemas/VRPSetupRequest'
        hostedUrl:
          type: string
          description: "Represents the URL of Hosted UI page for the applicationId which initiates the user journey for the Consent. \n\n URL would be appended with authToken, applicationId and userSettings."
        authToken:
          type: string
          description: Represents the JWT Token signed by the certificate-vault using Yapily's keys.
        createdAt:
          type: string
          format: date-time
          description: Represents the date and time at which the Consent was created.
        authorisationExpiresAt:
          type: string
          format: date-time
          description: Represents the date and time at which the auth Token will expire.
    HostedVrpRefundAccount:
      type: object
      description: The account to which funds should be returned if the payment is to be later refunded.
      properties:
        name:
          type: string
        accountIdentifications:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/HostedVrpAccountIdentification'
    ApiResponseOfGetHostedPaymentRequest:
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/ResponseMeta'
        data:
          $ref: '#/components/schemas/HostedPaymentDetails'
    CreateHostedPaymentRequest:
      required:
      - redirectUrl
      - paymentRequestDetails
      - institutionIdentifiers
      type: object
      properties:
        userId:
          type: string
          format: uuid
          description: __Conditional__. Yapily Identifier for the `User` returned by the create user step POST /users. You must provide either a `userId` or `applicationUserId`.
        applicationUserId:
          type: string
          description: __Conditional__. Your own `User` reference. This field allows you to use your own unique references for individual users. Where the `User` reference doesn't have an associated Yapily `userId`, a new `userId` is created and linked to it. You must provide either a `userId` or `applicationUserId`.
        institutionIdentifiers:
          $ref: '#/components/schemas/InstitutionIdentifiers'
        userSettings:
          $ref: '#/components/schemas/UserSettings'
        redirectUrl:
          type: string
          description: URL of your server to redirect the user after completion of the payment flow.
          example: https://tpp-application.com
        paymentRequestDetails:
          $ref: '#/components/schemas/HostedPaymentRequestDetails'
    AccountIdentification:
      title: Account Identifications
      required:
      - type
      - identification
      type: object
      properties:
        type:
          $ref: '#/components/schemas/AccountIdentificationType'
        identification:
          title: Account Identification
          type: string
          description: "__Mandatory__. The value associated with the account identification type.\n\n See [Account Identification Combinations](/payments/payment-resources/intro-to-payment-execution#account-identifications-combinations) for more information on the format of the values."
          example: '401016'
    RawResponse:
      deprecated: true
      type: object
      description: '[DEPRECATED] Interaction (raw request and response) that occurred with the `Institution` in order to fulfil a request.'
      properties:
        request:
          $ref: '#/components/schemas/RawRequest'
        duration:
          type: string
          format: iso8601
        headers:
          type: object
          additionalProperties:
            type: string
        resultCode:
          type: integer
          format: int32
        result:
          type: object
    InstitutionIdentifiersResponse:
      description: Specifies the institution selected for making the payment.
      type: object
      properties:
        institutionId:
          type: string
          description: Yapily identifier which identifies the `Institution` the payment request is sent to.
        institutionCountryCode:
          type: string
          description: 2 letter ISO Country code of the `Institution` the payment request is sent to.
          example: GB
    CreateHostedVRPPayment

# --- truncated at 32 KB (124 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/yapily/refs/heads/main/openapi/yapily-hosted-payment-pages-api-openapi.yml

Yapily Hosted Payment Pages API

Operations 10

Documentation

Specifications

Schemas & Data

Other Resources