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

# Loan Feature Query

> Query loan-feature information using access type, value, authorization, type, and encryption settings.



## OpenAPI

````yaml POST /api/v1/merchant/risk/loan-feature/query
openapi: 3.1.0
info:
  title: PayVessel API
  description: >-
    PayVessel API for accepting payments, sending money, verifying identities,
    and managing wallets
  version: 1.0.0
servers:
  - url: https://api.payvessel.com
  - url: https://sandbox.payvessel.com
security:
  - {}
paths:
  /api/v1/merchant/risk/loan-feature/query:
    post:
      tags:
        - Risk
      summary: Loan Feature Query
      description: >-
        Query loan-feature information using access type, value, authorization,
        type, and encryption settings.
      parameters:
        - name: api-key
          in: header
          description: Your Payvessel public API key
          required: true
          schema:
            type: string
        - name: api-secret
          in: header
          description: Your Payvessel secret
          required: true
          schema:
            type: string
        - name: Content-Type
          in: header
          description: Request content type
          required: true
          schema:
            type: string
            enum:
              - application/json
          example: application/json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LoanFeatureQueryRequest'
            examples:
              default:
                summary: Loan feature query request
                value:
                  access_type: bvn
                  value: '22123456789'
                  authorization: Bearer demo-token
                  type: 1
                  encrypt: '0'
      responses:
        '200':
          description: Loan feature query response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoanFeatureQueryResponse'
              examples:
                successfulQuery:
                  summary: Successful loan feature query
                  value:
                    success: true
                    message: Loan feature query completed successfully
                    data: {}
                    charges:
                      charged: false
                      charged_amount: '0.00'
        '402':
          description: >-
            Query could not be processed because the wallet balance is
            insufficient
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VerificationPaymentErrorResponse'
              examples:
                insufficientBalance:
                  summary: Insufficient wallet balance
                  value:
                    success: false
                    message: >-
                      Your wallet balance is insufficient for this request.
                      Required 25.00, available 0. Please fund your wallet and
                      try again.
                    details:
                      - >-
                        Your wallet balance is insufficient for this request.
                        Required 25.00, available 0. Please fund your wallet and
                        try again.
      servers:
        - url: https://api.payvessel.com/kyc
        - url: https://sandbox.payvessel.com/kyc
components:
  schemas:
    LoanFeatureQueryRequest:
      type: object
      required:
        - access_type
        - value
        - authorization
        - type
        - encrypt
      properties:
        access_type:
          type: string
          example: bvn
        value:
          type: string
          example: '22123456789'
        authorization:
          type: string
          example: Bearer demo-token
        type:
          type: integer
          example: 1
        encrypt:
          type: string
          example: '0'
    LoanFeatureQueryResponse:
      type: object
      required:
        - success
        - message
        - data
        - charges
      properties:
        success:
          type: boolean
          example: true
        message:
          type: string
          example: Loan feature query completed successfully
        data:
          type: object
          additionalProperties: true
          example: {}
        charges:
          $ref: '#/components/schemas/VerificationCharges'
    VerificationPaymentErrorResponse:
      type: object
      required:
        - success
        - message
        - details
      properties:
        success:
          type: boolean
          description: Whether the request completed successfully
          example: false
        message:
          type: string
          description: Reason the request could not be processed
          example: >-
            Your wallet balance is insufficient for this request. Required
            25.00, available 0. Please fund your wallet and try again.
        details:
          type: array
          description: Detailed error messages returned by the API
          items:
            type: string
          example:
            - >-
              Your wallet balance is insufficient for this request. Required
              25.00, available 0. Please fund your wallet and try again.
    VerificationCharges:
      type: object
      required:
        - charged
        - charged_amount
      properties:
        charged:
          type: boolean
          description: Whether the verification request was billed
        charged_amount:
          type: string
          description: Amount charged for the verification request
          example: '0.00'

````