openapi: 3.1.1
info:
  title: PaymentTerm
  version: 2.0.0
  description: "A single payment instruction for an order. Represents one line item\
    \ in the paymentTerms array of an Order \u2014 e.g., a pre-order UPI payment,\
    \ a cash-on-delivery amount, or an instalment.\n"
  license:
    name: CC-BY-NC-SA 4.0 International
  contact:
    name: Beckn Labs
    url: https://beckn.io
components:
  schemas:
    PaymentTerm:
      x-iri: https://schema.nfh.global/PaymentTerm/v2.0
      description: "A single payment instruction for an order. Represents one line\
        \ item in the paymentTerms array of an Order \u2014 e.g., a pre-order UPI\
        \ payment, a cash-on-delivery amount, or an instalment.\n"
      title: PaymentTerm
      x-tags:
      - common
      type: object
      properties:
        id:
          description: Unique identifier for this payment term within the order.
          type: string
          x-jsonld:
            '@id': schema:identifier
        type:
          description: Payment lifecycle stage.
          type: string
          enum:
          - PRE_ORDER
          - ON_FULFILLMENT
          - POST_FULFILLMENT
          - INSTALLMENT
        method:
          description: Payment instrument or rail to use.
          type: string
          enum:
          - UPI
          - CREDIT_CARD
          - DEBIT_CARD
          - WALLET
          - BANK_TRANSFER
          - CASH
          - APPLE_PAY
          - BNPL
          - OTHER
        amount:
          description: Amount due under this payment term.
          type: object
          properties:
            currency:
              type: string
              description: ISO 4217 currency code.
            value:
              type: number
              description: Monetary amount.
          required:
          - currency
          - value
          additionalProperties: false
        due:
          description: ISO 8601 date-time by which this payment is due.
          type: string
          format: date-time
        payTo:
          description: Payee details for this payment term.
          type: object
          properties:
            upiId:
              type: string
              description: UPI Virtual Payment Address of the payee.
            accountName:
              type: string
              description: Legal name of the payee account holder.
            bankAccount:
              type: string
              description: Bank account number (masked if required).
            ifsc:
              type: string
              description: IFSC code of the payee bank branch (India).
            walletId:
              type: string
              description: Wallet identifier of the payee.
          additionalProperties: true
        status:
          description: Payment status.
          type: string
          enum:
          - NOT_PAID
          - PAID
          - PENDING
          - FAILED
          - REFUNDED
          - PARTIALLY_PAID
        transactionId:
          description: Payment gateway or bank transaction reference ID.
          type: string
      required: []
      additionalProperties: false