PaymentsPostRequestBodyContentApplicationJsonSchemaPayment

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/cash-app/main/json-schema/cash-app-payments-post-request-body-content-application-json-schema-payment-schema.json",
  "title": "PaymentsPostRequestBodyContentApplicationJsonSchemaPayment",
  "description": "Data about the payment to create.",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/cash-app-payments-api-openapi.yml#/components/schemas/PaymentsPostRequestBodyContentApplicationJsonSchemaPayment",
  "type": "object",
  "properties": {
    "amount": {
      "type": "integer",
      "description": "The amount of money to charge the customer, in the lowest denomination of currency for the payment.\n\nMin value: `1`"
    },
    "currency": {
      "$ref": "#/$defs/Currency"
    },
    "merchant_id": {
      "type": "string",
      "description": "ID of the merchant to make the payment to.\n\nMin length: `1`\nMax length: `128`"
    },
    "grant_id": {
      "type": "string",
      "description": "A grant ID from the Customer Request API that indicates permission to take the payment.\n\nMin length: `1`\nMax length: `256`"
    },
    "reference_id": {
      "type": "string",
      "description": "A user-defined identifier for this payment, typically used to associate the payment with a record in an external system.\n\nMin length: `1`\nMax length: `1024`"
    },
    "capture": {
      "type": "boolean",
      "default": true,
      "description": "Whether or not to automatically capture the payment once it's created.\n\nDefault: `true`"
    },
    "metadata": {
      "$ref": "#/$defs/Metadata"
    },
    "enrichments": {
      "$ref": "#/$defs/PaymentEnrichments"
    }
  },
  "required": [
    "amount",
    "currency",
    "merchant_id",
    "grant_id"
  ],
  "$defs": {
    "Currency": {
      "type": "string",
      "enum": [
        "USD"
      ],
      "description": "Indicates the country associated with an entity. Values are from the [ISO-4217 Alpha-3](https://www.iso.org/iso-4217-currency-codes.html) specification.\n\nCurrent values:\n\n- `USD`: United States Dollar",
      "title": "Currency"
    },
    "Metadata": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "Freeform key-value pairs of arbitrary data associated with this resource.\n\nKeys and values must be passed as strings and not contain any personally identifiable information (PII).\n\nMin keys: `0`\nMax keys: `50`\n\n\n> Note: Nested keys are not supported.",
      "title": "Metadata"
    },
    "PaymentEnrichments": {
      "type": "object",
      "properties": {
        "initiation": {
          "$ref": "#/$defs/PaymentEnrichmentsInitiation",
          "description": "If present, provides information about transaction initiation."
        },
        "recurring_series_id": {
          "type": "string",
          "description": "If present, indicates that this payment is part of a recurring series of payments, such as a subscription.\n\nThe value should contain a unique identifier for the recurring series that is constant across all of its payments, so it can be used to group them together.\n\nMin length: `1`\nMax length: `1024`"
        },
        "statement_descriptor": {
          "type": "string",
          "description": "If present, adds the descriptor as line item on to a customer's payment receipt in their in-app Activity page.\nThe descriptor will be present under the header \"On statement as\".\n\nStatement descriptor requirements vary by platform. If the input for this field exceeds the character limit, it will be truncated to the limit, then suffixed with an ellipsis (...).\n\nMin length: `1`\nMax length: `22`"
        },
        "restricted_categories": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/PaymentEnrichmentsRestrictedCategoriesItems"
          },
          "description": "If present, indicates that this payment is associated with one or more restricted categories. Contact the Cash App Pay support team to use this field."
        }
      },
      "description": "Describes optional fields beyond core payment information to supplement payment processing.\n\nEnrichments provide additional context about a payment, which can improve the overall payment experience including, but not limited to: \n  - Increased approval rates\n  - Enhanced transaction insights\n  - Better payment flows in Cash App",
      "title": "PaymentEnrichments"
    },
    "PaymentEnrichmentsInitiation": {
      "type": "object",
      "properties": {
        "actor": {
          "$ref": "#/$defs/PaymentEnrichmentsInitiationActor",
          "description": "The party who initiated the payment.\n\n- `CUSTOMER`\n- `MERCHANT`"
        }
      },
      "required": [
        "actor"
      ],
      "description": "If present, provides information about transaction initiation.",
      "title": "PaymentEnrichmentsInitiation"
    },
    "PaymentEnrichmentsInitiationActor": {
      "type": "string",
      "enum": [
        "CUSTOMER",
        "MERCHANT"
      ],
      "description": "The party who initiated the payment.\n\n- `CUSTOMER`\n- `MERCHANT`",
      "title": "PaymentEnrichmentsInitiationActor"
    },
    "PaymentEnrichmentsRestrictedCategoriesItems": {
      "type": "string",
      "enum": [
        "ALCOHOL",
        "FINANCIAL_SERVICES",
        "CANNABIS"
      ],
      "title": "PaymentEnrichmentsRestrictedCategoriesItems"
    }
  }
}