Moov · Schema

Refund

A refund issued against a completed card transfer.

BankingEmbedded FinanceFinancial InfrastructureMoney MovementPaymentsTransfers

Properties

Name Type Description
refundID string Unique identifier for the refund.
status string Current status of the refund.
amount object
createdOn string ISO 8601 timestamp when the refund was created.
updatedOn string ISO 8601 timestamp when the refund was last updated.
View JSON Schema on GitHub

JSON Schema

moov-refund-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Refund",
  "title": "Refund",
  "type": "object",
  "description": "A refund issued against a completed card transfer.",
  "properties": {
    "refundID": {
      "type": "string",
      "format": "uuid",
      "description": "Unique identifier for the refund."
    },
    "status": {
      "type": "string",
      "description": "Current status of the refund.",
      "enum": [
        "created",
        "pending",
        "completed",
        "failed"
      ]
    },
    "amount": {
      "$ref": "#/components/schemas/Amount"
    },
    "createdOn": {
      "type": "string",
      "format": "date-time",
      "description": "ISO 8601 timestamp when the refund was created."
    },
    "updatedOn": {
      "type": "string",
      "format": "date-time",
      "description": "ISO 8601 timestamp when the refund was last updated."
    }
  }
}