PayoutsPostRequestBodyContentApplicationJsonSchemaPayout

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/cash-app/main/json-schema/cash-app-payouts-post-request-body-content-application-json-schema-payout-schema.json",
  "title": "PayoutsPostRequestBodyContentApplicationJsonSchemaPayout",
  "description": "Data about the payout to create.",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/cash-app-payouts-api-openapi.yml#/components/schemas/PayoutsPostRequestBodyContentApplicationJsonSchemaPayout",
  "type": "object",
  "properties": {
    "amount": {
      "type": "integer",
      "description": "The amount of money to pay the customer, in the lowest denomination of currency for the payout.\n\nMin value: `1`"
    },
    "currency": {
      "$ref": "#/$defs/Currency"
    },
    "merchant_id": {
      "type": "string",
      "description": "ID of the merchant making the payout.\n\nMin length: `1`\nMax length: `128`"
    },
    "grant_id": {
      "type": "string",
      "description": "A grant ID from the Customer Request API that indicates permission to make the payout.\n\nMin length: `1`\nMax length: `256`"
    },
    "purpose": {
      "$ref": "#/$defs/PayoutPurpose"
    },
    "reference_id": {
      "type": "string",
      "description": "A user-defined identifier for this payout, typically used to associate the payout 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 payout once it's created. Must be true until authorization and void payout states are supported.\n\nDefault: `true`"
    },
    "note": {
      "type": "string",
      "description": "A note about the payout that will be shown to the customer.\n\nMin length: `1`\nMax length: `1024`"
    },
    "metadata": {
      "$ref": "#/$defs/Metadata"
    }
  },
  "required": [
    "amount",
    "currency",
    "merchant_id",
    "grant_id",
    "purpose",
    "capture",
    "note"
  ],
  "$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"
    },
    "PayoutPurpose": {
      "type": "string",
      "enum": [
        "SERVICES"
      ],
      "description": "The purpose or intent of the payout.",
      "title": "PayoutPurpose"
    }
  }
}