PostApiPaymentLinksRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/powens/main/json-schema/powens-post-api-payment-links-request-schema.json",
  "title": "PostApiPaymentLinksRequest",
  "x-generated": "2026-10-21",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_ae-authored/powens-openapi-generated.yml#/components/schemas/PostApiPaymentLinksRequest",
  "type": "object",
  "properties": {
    "reference_id": {
      "type": "string",
      "description": "The end-to-end identifier to provide the underlying payment with."
    },
    "amount": {
      "type": "number",
      "description": "The amount of the currency to provide when creating the payment."
    },
    "currency": {
      "type": "string",
      "description": "The currency code of the payment amount, a per ISO 4217."
    },
    "label": {
      "type": "string",
      "description": "The unstructured remittance information to provide the created payment."
    },
    "execution_date_type": {
      "type": "string",
      "description": "Either \"first_open_day\" or \"instant\"."
    },
    "beneficiary": {
      "type": "object",
      "description": "The beneficiary for the payment link."
    },
    "beneficiary_identity": {
      "type": "object",
      "description": "The beneficiary's identity."
    },
    "payer": {
      "type": "object",
      "description": "The payer for the payment link, if available."
    },
    "payer_identity": {
      "type": "object",
      "description": "The payer's identity."
    },
    "operator_identity": {
      "type": "object",
      "description": "The operator's identity."
    },
    "redirect": {
      "type": "boolean",
      "description": "Whether to redirect at the end of the flow or not."
    },
    "redirect_uri": {
      "type": "string",
      "description": "The URL to redirect the end user to at the end of the payment link validation."
    },
    "redirect_state": {
      "type": "string",
      "description": "The optional state with which to redirect the end user at the end of the payment link validation."
    }
  },
  "required": [
    "amount",
    "currency",
    "label",
    "execution_date_type",
    "beneficiary",
    "beneficiary_identity",
    "payer",
    "payer_identity",
    "redirect"
  ]
}