Payflex · Schema

Refund Request

Request body for initiating a full or partial refund via POST /order/{orderId}/refund

BNPLBuy Now Pay LaterPaymentsInstallmentsSouth AfricaFintechE-Commerce

Properties

Name Type Description
requestId string Unique identifier for this refund request; must be unique per attempt to prevent duplicate refunds
amount number Amount to refund. May be less than the original order total for partial refunds.
isPlugin boolean Flag indicating the refund was initiated from a plugin integration
merchantRefundReference string Merchant's own reference for this refund
View JSON Schema on GitHub

JSON Schema

refund-request.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/payflex/main/json-schema/refund-request.json",
  "title": "Refund Request",
  "description": "Request body for initiating a full or partial refund via POST /order/{orderId}/refund",
  "type": "object",
  "required": ["requestId", "amount"],
  "properties": {
    "requestId": {
      "type": "string",
      "description": "Unique identifier for this refund request; must be unique per attempt to prevent duplicate refunds",
      "example": "Order #12345-ab3cd4ef"
    },
    "amount": {
      "type": "number",
      "description": "Amount to refund. May be less than the original order total for partial refunds.",
      "minimum": 0.01,
      "example": 99.99
    },
    "isPlugin": {
      "type": "boolean",
      "description": "Flag indicating the refund was initiated from a plugin integration",
      "example": true
    },
    "merchantRefundReference": {
      "type": "string",
      "description": "Merchant's own reference for this refund",
      "example": "Order #12345-ab3cd4ef"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/refund-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.