Credit Card - Capture

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/nmi/main/json-schema/nmi-credit-card-capture-request-schema.json",
  "title": "Credit Card - Capture",
  "x-generated": "2026-10-14",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/nmi-payments-openapi.yml#/components/schemas/CreditCardCaptureRequest",
  "allOf": [
    {
      "type": "object",
      "required": [
        "type",
        "transactionid",
        "amount",
        "security_key"
      ],
      "properties": {
        "security_key": {
          "$ref": "#/$defs/SecurityKey"
        },
        "type": {
          "type": "string",
          "enum": [
            "capture"
          ],
          "description": "The type of transaction to be processed."
        },
        "transactionid": {
          "type": "string",
          "description": "Original payment gateway transaction id."
        },
        "amount": {
          "type": "string",
          "description": "Total amount to be settled. This amount must be equal to or less than the original authorized amount.\n  \nFormat: `x.xx`"
        },
        "tracking_number": {
          "type": "string",
          "description": "Shipping tracking number."
        },
        "shipping_carrier": {
          "type": "string",
          "enum": [
            "ups",
            "fedex",
            "dhl",
            "usps"
          ],
          "description": "Shipping carrier."
        },
        "orderid": {
          "type": "string",
          "description": "Order ID."
        }
      }
    },
    {
      "$ref": "#/$defs/SignatureImage"
    }
  ],
  "$defs": {
    "SecurityKey": {
      "type": "string",
      "description": "API Security Key assigned to a merchant account. New keys can be generated from the merchant control panel in Settings > Security Keys"
    },
    "SignatureImage": {
      "type": "object",
      "properties": {
        "signature_image": {
          "type": "string",
          "description": "Cardholder signature image.\n  \nFormat: `base64 encoded raw PNG image. (16kiB maximum)`"
        }
      }
    }
  }
}