> ## Documentation Index
> Fetch the complete documentation index at: https://developer.novacpayment.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Initiate pay-by-bank



## OpenAPI

````yaml post /api/v1/checkout/initiateopenbanking
openapi: 3.0.1
info:
  title: NOVAC API
  version: v1
servers:
  - url: https://api.novacpayment.com/
security:
  - Bearer: []
paths:
  /api/v1/checkout/initiateopenbanking:
    post:
      tags:
        - Open Banking
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InitiateOpenBankingRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/InitiateOpenBankingRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/InitiateOpenBankingRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InitiateOpenBankingResponse'
components:
  schemas:
    InitiateOpenBankingRequest:
      type: object
      required:
        - bankId
        - transactionReference
        - amount
        - currency
        - checkoutCustomerData
      properties:
        bankId:
          type: string
          description: >-
            The unique identifier of the bank selected by the customer, as
            returned by the bank list endpoint (e.g., lloyds)
        transactionReference:
          type: string
          description: The unique reference for the transaction
        amount:
          type: number
          format: double
          description: The amount to be paid (e.g., 10.00)
        currency:
          type: string
          description: The currency of the payment (Must be GBP)
        metaData:
          type: string
          nullable: true
          description: >-
            Additional data to attach to the transaction, passed as a JSON
            string (e.g., "{\"name\":\"test\"}")
        checkoutCustomerData:
          $ref: '#/components/schemas/openbankingCustomerData'
        checkoutCustomizationData:
          $ref: '#/components/schemas/openbankingCustomizationData'
      additionalProperties: false
    InitiateOpenBankingResponse:
      type: object
      properties:
        status:
          type: boolean
          description: Indicates whether the request was successful
        message:
          type: string
          nullable: true
          description: A message describing the result of the request
        data:
          $ref: '#/components/schemas/InitiateOpenBankingData'
      additionalProperties: false
    openbankingCustomerData:
      type: object
      required:
        - email
        - firstName
        - lastName
      properties:
        email:
          type: string
          format: email
          description: The email address of the customer making the payment
        firstName:
          type: string
          description: The first name of the customer
        lastName:
          type: string
          description: The last name of the customer
      additionalProperties: false
    openbankingCustomizationData:
      type: object
      nullable: true
      properties:
        logoUrl:
          type: string
          nullable: true
          description: The URL of the logo to display on the checkout
        paymentDescription:
          type: string
          nullable: true
          description: A short description of the payment
        checkoutModalTitle:
          type: string
          nullable: true
          description: The title displayed on the checkout modal
      additionalProperties: false
    InitiateOpenBankingData:
      type: object
      nullable: true
      properties:
        redirectUrl:
          type: string
          nullable: true
          description: >-
            The bank's authorization URL. Redirect the customer here to approve
            and complete the transaction
      additionalProperties: false
      example:
        redirectUrl: https://api.reflowzone.io/open-banking/authorize?sessionId=abc123
  securitySchemes:
    Bearer:
      type: apiKey
      description: >-
        Input your API key (e.g. your public key) as a Bearer token to access
        this API.
      name: Authorization
      in: header

````