Upstox · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OpenAPI definition PAYMENTS API

7 actions 7 updates phrasing extends openapi/upstox-payments-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Upstox's API. It is a proposal applied on top of the contract, not a document Upstox publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info

$.paths['/v2/user/payments/payout/{transaction_id}'].put

$.paths['/v2/user/payments/payout/{transaction_id}'].delete

$.paths['/v2/user/payments/payout'].get

$.paths['/v2/user/payments/payout'].post

$.paths['/v2/user/payments/payout/modes'].get

$.paths['/v2/user/payments/payin'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for OpenAPI definition PAYMENTS API
  version: 1.0.0
extends: openapi/upstox-payments-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/v2/user/payments/payout/{transaction_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change the amount of a pending withdrawal
      effect: write
      questions:
      - Can I change how much I'm withdrawing after I've requested a payout?
      - How do I edit a pending withdrawal amount?
      instructions:
      - text: Change payout {transaction_id} to {amount} rupees.
        slots:
          transaction_id: path.transaction_id
          amount: requestBody.amount
      - text: Update the withdrawal amount of {transaction_id} to INR {amount}.
        slots:
          transaction_id: path.transaction_id
          amount: requestBody.amount
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/user/payments/payout/{transaction_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a pending withdrawal
      effect: destructive
      questions:
      - How do I cancel a withdrawal request before it's processed?
      - Can I stop a payout I requested by mistake?
      instructions:
      - text: Cancel payout {transaction_id}.
        slots:
          transaction_id: path.transaction_id
      - text: Stop withdrawal request {transaction_id}.
        slots:
          transaction_id: path.transaction_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/user/payments/payout'].get
  update:
    x-apievangelist-phrasing:
      intent: List my withdrawal history
      effect: read
      questions:
      - What withdrawals have I made from my trading account?
      - Where can I check whether my past payouts went through?
      instructions:
      - text: Show my payout history.
      - text: List all my withdrawals to the bank.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/user/payments/payout'].post
  update:
    x-apievangelist-phrasing:
      intent: Withdraw funds to my bank
      effect: write
      questions:
      - How do I withdraw money from my trading account to my bank?
      - Can I choose IMPS instead of NEFT for a withdrawal?
      instructions:
      - text: Withdraw {amount} rupees via {mode}.
        slots:
          amount: requestBody.amount
          mode: requestBody.mode
      - text: Start a {mode} payout of INR {amount} to my bank account.
        slots:
          mode: requestBody.mode
          amount: requestBody.amount
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/user/payments/payout/modes'].get
  update:
    x-apievangelist-phrasing:
      intent: List available withdrawal modes
      effect: read
      questions:
      - Which withdrawal methods can I use right now?
      - Is instant IMPS withdrawal available for my account?
      instructions:
      - text: List the payout modes I can use.
      - text: Show which withdrawal methods are available now.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/user/payments/payin'].get
  update:
    x-apievangelist-phrasing:
      intent: List my deposit history
      effect: read
      questions:
      - What funds have I added to my trading account?
      - Did my recent deposit get credited?
      instructions:
      - text: Show my pay-in history.
      - text: List the deposits I've made into my account.
      method: generated
      generated: '2026-09-26'