Instamojo · Schema

Instamojo Refund

Schema for creating and representing an Instamojo refund

PaymentsE-CommerceIndiaPayment GatewayPayment LinksRefundsOrders

Properties

Name	Type	Description
id	string	Unique refund ID assigned by Instamojo
payment_id	string	Payment ID for which refund is being requested
type	string	Three-letter refund type code
body	string	Explanation for why the refund is being requested
refund_amount	string	Amount to refund in INR. Defaults to full transaction amount if not specified.
total_amount	string	Total amount of the original transaction
status	string	Current status of the refund
created_at	string	Timestamp when the refund was created

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/instamojo/main/json-schema/refund.json",
  "title": "Instamojo Refund",
  "description": "Schema for creating and representing an Instamojo refund",
  "type": "object",
  "required": ["payment_id", "type", "body"],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique refund ID assigned by Instamojo",
      "readOnly": true,
      "examples": ["C5c0751269"]
    },
    "payment_id": {
      "type": "string",
      "description": "Payment ID for which refund is being requested",
      "examples": ["MOJO5a06005J21512345"]
    },
    "type": {
      "type": "string",
      "description": "Three-letter refund type code",
      "enum": ["RFD", "TNR", "QFL", "QNR", "EWN", "TAN", "PTH"],
      "enumDescriptions": {
        "RFD": "Refund",
        "TNR": "Test Refund",
        "QFL": "Quality/Fulfillment Issue",
        "QNR": "Quality Not as Represented",
        "EWN": "Event/Workshop Not Held",
        "TAN": "Technical Issue/App Not Working",
        "PTH": "Paid to Wrong Handle"
      }
    },
    "body": {
      "type": "string",
      "description": "Explanation for why the refund is being requested"
    },
    "refund_amount": {
      "type": "string",
      "description": "Amount to refund in INR. Defaults to full transaction amount if not specified.",
      "pattern": "^\\d+(\\.\\d{1,2})?$"
    },
    "total_amount": {
      "type": "string",
      "description": "Total amount of the original transaction",
      "readOnly": true
    },
    "status": {
      "type": "string",
      "description": "Current status of the refund",
      "enum": ["Pending", "Processed", "Rejected"],
      "readOnly": true
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the refund was created",
      "readOnly": true
    }
  }
}