{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/monite/json-schema/monite-batch-payment-link-request-schema.json",
  "title": "BatchPaymentLinkRequest",
  "description": "Request schema for creating a batch payment link.\nBased on PaymentsBatchPaymentRequest but excluding payer_bank_account_id.",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/monite-batch-payment-links-api-openapi.yml#/components/schemas/BatchPaymentLinkRequest",
  "properties": {
    "expires_at": {
      "type": "string",
      "format": "date-time"
    },
    "funding_payment_method": {
      "type": "string",
      "enum": [
        "us_ach"
      ],
      "default": "us_ach"
    },
    "payment_intents": {
      "items": {
        "$ref": "#/$defs/BatchSinglePaymentIntent"
      },
      "type": "array",
      "minItems": 1
    },
    "payout_payment_methods": {
      "items": {
        "$ref": "#/$defs/MoniteAllPaymentMethodsTypes"
      },
      "type": "array",
      "minItems": 1,
      "uniqueItems": true,
      "default": [
        "us_ach"
      ]
    },
    "return_url": {
      "type": "string",
      "maxLength": 2083,
      "minLength": 1,
      "format": "uri",
      "description": "The URL where to redirect the payer after the payment. If `return_url` is specified, then after the payment is completed the payment page will display the \"Return to platform\" link that navigates to this URL."
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "payment_intents"
  ],
  "$defs": {
    "BatchPaymentIntentsRecipient": {
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid"
        },
        "bank_account_id": {
          "type": "string",
          "format": "uuid"
        },
        "type": {
          "type": "string",
          "enum": [
            "counterpart"
          ]
        }
      },
      "additionalProperties": false,
      "type": "object",
      "required": [
        "id",
        "type"
      ],
      "description": "Recipient schema specific for batch payment links.\nSupports 'us_ach' and 'wire' payout methods in the schema, but only 'us_ach' is currently used.\nValidation is done at the scenario level."
    },
    "BatchSinglePaymentIntent": {
      "properties": {
        "object": {
          "$ref": "#/$defs/PaymentObjectPayable"
        },
        "payment_reference": {
          "type": "string",
          "description": "Must be provided if payable's document id is missing."
        },
        "recipient": {
          "$ref": "#/$defs/BatchPaymentIntentsRecipient"
        }
      },
      "additionalProperties": false,
      "type": "object",
      "required": [
        "object",
        "recipient"
      ],
      "description": "Single payment intent schema specific for batch payment links.\nUses BatchPaymentIntentsRecipient instead of PaymentIntentsRecipient."
    },
    "MoniteAllPaymentMethodsTypes": {
      "type": "string",
      "enum": [
        "sepa_credit",
        "us_ach",
        "blik",
        "card",
        "bacs_direct_debit",
        "bancontact",
        "eps",
        "giropay",
        "ideal",
        "p24",
        "sepa_debit",
        "sofort",
        "applepay",
        "googlepay",
        "affirm",
        "klarna"
      ]
    },
    "PaymentObjectPayable": {
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid"
        },
        "type": {
          "type": "string",
          "enum": [
            "payable"
          ]
        }
      },
      "additionalProperties": false,
      "type": "object",
      "required": [
        "id",
        "type"
      ]
    }
  }
}