action pay1_update_payment_link {
  label: "Update a payment link."
  provider: pay1
  method: PUT
  path: "/v1/payment-links/{linkId}"
  encoding: json
  input: {
    type: "object"
    properties: {
      accountId: {
        type: "string"
        description: "identifier for the subaccount"
      }
      active: {
        type: "boolean"
        description: "link activation status"
      }
      backgroundImage: {
        type: "string"
        format: "css"
        description: "backgroundImage css property"
      }
      billing: {
        type: "object"
        properties: {
          addressAddition: {
            type: "string"
            description: "customer additional address line"
          }
          city: {
            type: "string"
            description: "customer city"
          }
          company: {
            type: "string"
            description: "customer company name"
          }
          country: {
            type: "string"
            description: "customer country code (2 letter ISO-3166 code)"
          }
          firstName: {
            type: "string"
            description: "customer first name"
          }
          lastName: {
            type: "string"
            description: "customer last name"
          }
          state: {
            type: "string"
            description: "customer state code"
          }
          street: {
            type: "string"
            description: "customer street name"
          }
          zip: {
            type: "string"
            description: "customer postcode"
          }
        }
      }
      currency: {
        type: "string"
        description: "currency code"
        enum: ["ALL", "DZD", "ARS", "AUD", "BSD", "BHD", "BDT", "AMD", "BBD", "BMD", "BTN", "BOB", "BWP", "BZD", "SBD", "BND", "MMK", "BIF", "KHR", "CAD", "CVE", "KYD", "LKR", "CLP", "CNY", "COP", "KMF", "CRC", "HRK", "CUP", "CZK", "DKK", "DOP", "SVC", "ETB", "ERN", "FKP", "FJD", "DJF", "GMD", "GIP", "GTQ", "GNF", "GYD", "HTG", "HNL", "HKD", "HUF", "ISK", "INR", "IDR", "IRR", "IQD", "ILS", "JMD", "JPY", "KZT", "JOD", "KES", "KPW", "KRW", "KWD", "KGS", "LAK", "LBP", "LSL", "LRD", "LYD", "MOP", "MWK", "MYR", "MVR", "MUR", "MXN", "MNT", "MDL", "MAD", "OMR", "NAD", "NPR", "ANG", "AWG", "VUV", "NZD", "NIO", "NGN", "NOK", "PKR", "PAB", "PGK", "PYG", "PEN", "PHP", "QAR", "RUB", "RWF", "SHP", "SAR", "SCR", "SLL", "SGD", "VND", "SOS", "ZAR", "SSP", "SZL", "SEK", "CHF", "SYP", "THB", "TOP", "TTD", "AED", "TND", "UGX", "MKD", "EGP", "GBP", "TZS", "USD", "UYU", "UZS", "WST", "YER", "TWD", "UYW", "VES", "MRU", "STN", "CUC", "ZWL", "BYN", "TMT", "GHS", "SDG", "UYI", "RSD", "MZN", "AZN", "RON", "CHE", "CHW", "TRY", "XAF", "XCD", "XOF", "XPF", "XBA", "XBB", "XBC", "XBD", "XAU", "XDR", "XAG", "XPT", "XTS", "XPD", "XUA", "ZMW", "SRD", "MGA", "COU", "AFN", "TJS", "AOA", "BGN", "CDF", "BAM", "EUR", "MXV", "UAH", "GEL", "BOV", "PLN", "BRL", "CLF", "XSU", "USN"]
      }
      description: {
        type: "string"
        description: "free format description of the payment"
      }
      email: {
        type: "string"
        description: "email the invoice should be delivered to"
      }
      errorUrl: {
        type: "string"
        description: "final redirect after a final payment"
      }
      expiration: {
        type: "string"
        format: "date"
        description: "link expiration date, the link will only be executable until end of that day"
      }
      intent: {
        type: "string"
        description: "designates the type of transaction that will be created"
        enum: ["authorization", "preauthorization"]
      }
      invoiceInformation: {
        type: "object"
        description: "relevant information for the invoice module"
        properties: {
          invoiceId: {
            type: "string"
            description: "id that should be put on the invoice"
          }
          invoiceText: {
            type: "string"
            description: "short text that should be put after the invoice"
          }
        }
      }
      language: {
        type: "string"
        description: "link ISO language code"
        enum: ["de_DE", "en_US"]
      }
      linkId: {
        type: "string"
      }
      logo: {
        type: "string"
        format: "url"
        description: "logo url"
      }
      merchantId: {
        type: "string"
        description: "identifier for the merchant"
      }
      mode: {
        type: "string"
        description: "execution mode"
        enum: ["live", "test"]
      }
      notifyUrl: {
        type: "string"
        description: "Url where the notification will be send after link was executed"
      }
      paymentMethods: {
        type: "array"
        description: "list of available payment methods"
        items: {
          type: "string"
          description: "available payment methods"
          enum: ["visa", "mastercard", "amex", "paypal", "sofort", "paydirekt", "postfinance-e", "postfinance-card", "bancontact", "przelewy24", "alipay", "ideal", "eps", "giropay", "sepa"]
        }
      }
      portalId: {
        type: "string"
        description: "identifier for the portal"
      }
      reference: {
        type: "string"
        description: "payment reference number, has to be unique per merchant and mode"
      }
      shipping: {
        type: "object"
        additionalProperties: true
      }
      shoppingCart: {
        type: "array"
        items: {
          type: "object"
          required: ["number", "price", "quantity", "type"]
          properties: {
            deliveryDateEnd: {
              type: "string"
              format: "date"
              description: "delivery period end date"
            }
            deliveryDateStart: {
              type: "string"
              format: "date"
              description: "delivery date"
            }
            description: {
              type: "string"
              description: "item description"
            }
            number: {
              type: "string"
              description: "item number"
            }
            price: {
              type: "integer"
              format: "int64"
              description: "gross price of single item"
            }
            quantity: {
              type: "integer"
              format: "int64"
              description: "total number of ordered items"
            }
            type: {
              type: "string"
              description: "item type"
              enum: ["goods", "shipment", "handling", "voucher"]
            }
            vatRate: {
              type: "integer"
              format: "int64"
              description: "vat rate (<100 in %, >=100 in bp)"
            }
          }
        }
      }
      successUrl: {
        type: "string"
        description: "final redirect after a successful payment"
      }
      userId: {
        type: "string"
        description: "identifier for the user"
      }
    }
    required: ["accountId", "currency", "linkId", "merchantId", "mode", "portalId", "reference", "shoppingCart"]
    additionalProperties: false
  }
  output: {
    type: "object"
    properties: {
      accountId: {
        type: "string"
        description: "identifier for the subaccount"
      }
      active: {
        type: "boolean"
        description: "link activation status"
      }
      amount: {
        type: "integer"
        format: "int64"
        description: "total amount of all shopping cart items in lowest denomination"
      }
      backgroundImage: {
        type: "string"
        format: "css"
        description: "backgroundImage css property"
      }
      billing: {
        type: "object"
        properties: {
          addressAddition: {
            type: "string"
            description: "customer additional address line"
          }
          city: {
            type: "string"
            description: "customer city"
          }
          company: {
            type: "string"
            description: "customer company name"
          }
          country: {
            type: "string"
            description: "customer country code (2 letter ISO-3166 code)"
          }
          firstName: {
            type: "string"
            description: "customer first name"
          }
          lastName: {
            type: "string"
            description: "customer last name"
          }
          state: {
            type: "string"
            description: "customer state code"
          }
          street: {
            type: "string"
            description: "customer street name"
          }
          zip: {
            type: "string"
            description: "customer postcode"
          }
        }
      }
      created: {
        type: "integer"
        format: "int64"
        description: "created time in ISO 8601 format"
      }
      currency: {
        type: "string"
        description: "currency code"
        enum: ["ALL", "DZD", "ARS", "AUD", "BSD", "BHD", "BDT", "AMD", "BBD", "BMD", "BTN", "BOB", "BWP", "BZD", "SBD", "BND", "MMK", "BIF", "KHR", "CAD", "CVE", "KYD", "LKR", "CLP", "CNY", "COP", "KMF", "CRC", "HRK", "CUP", "CZK", "DKK", "DOP", "SVC", "ETB", "ERN", "FKP", "FJD", "DJF", "GMD", "GIP", "GTQ", "GNF", "GYD", "HTG", "HNL", "HKD", "HUF", "ISK", "INR", "IDR", "IRR", "IQD", "ILS", "JMD", "JPY", "KZT", "JOD", "KES", "KPW", "KRW", "KWD", "KGS", "LAK", "LBP", "LSL", "LRD", "LYD", "MOP", "MWK", "MYR", "MVR", "MUR", "MXN", "MNT", "MDL", "MAD", "OMR", "NAD", "NPR", "ANG", "AWG", "VUV", "NZD", "NIO", "NGN", "NOK", "PKR", "PAB", "PGK", "PYG", "PEN", "PHP", "QAR", "RUB", "RWF", "SHP", "SAR", "SCR", "SLL", "SGD", "VND", "SOS", "ZAR", "SSP", "SZL", "SEK", "CHF", "SYP", "THB", "TOP", "TTD", "AED", "TND", "UGX", "MKD", "EGP", "GBP", "TZS", "USD", "UYU", "UZS", "WST", "YER", "TWD", "UYW", "VES", "MRU", "STN", "CUC", "ZWL", "BYN", "TMT", "GHS", "SDG", "UYI", "RSD", "MZN", "AZN", "RON", "CHE", "CHW", "TRY", "XAF", "XCD", "XOF", "XPF", "XBA", "XBB", "XBC", "XBD", "XAU", "XDR", "XAG", "XPT", "XTS", "XPD", "XUA", "ZMW", "SRD", "MGA", "COU", "AFN", "TJS", "AOA", "BGN", "CDF", "BAM", "EUR", "MXV", "UAH", "GEL", "BOV", "PLN", "BRL", "CLF", "XSU", "USN"]
      }
      description: {
        type: "string"
        description: "free format description of the payment"
      }
      email: {
        type: "string"
        description: "customer email for invoices or payment notification"
      }
      errorUrl: {
        type: "string"
        description: "final redirect after a failed payment"
      }
      expiration: {
        type: "string"
        format: "date"
        description: "link expiration date, the link will only be executable until end of that day"
      }
      hash: {
        type: "string"
        description: "hash for the client API"
      }
      id: {
        type: "string"
        description: "link id"
      }
      intent: {
        type: "string"
        description: "designates the type of transaction that will be created"
        enum: ["authorization", "preauthorization"]
      }
      invoiceInformation: {
        type: "object"
        description: "relevant information for the invoice module"
        properties: {
          invoiceId: {
            type: "string"
            description: "id that should be put on the invoice"
          }
          invoiceText: {
            type: "string"
            description: "short text that should be put after the invoice"
          }
        }
      }
      language: {
        type: "string"
        description: "link ISO language code"
        enum: ["de_DE", "en_US"]
      }
      link: {
        type: "string"
        description: "customer payment link"
      }
      logo: {
        type: "string"
        format: "url"
        description: "logo url"
      }
      merchantId: {
        type: "string"
        description: "identifier for the merchant"
      }
      mode: {
        type: "string"
        description: "execution mode"
        enum: ["live", "test"]
      }
      modified: {
        type: "integer"
        format: "int64"
        description: "last modified time in ISO 8601 format"
      }
      notifyUrl: {
        type: "string"
        description: "notify url. If unset no notification will be send"
      }
      paymentMethod: {
        type: "string"
        description: "available payment methods"
        enum: ["visa", "mastercard", "amex", "paypal", "sofort", "paydirekt", "postfinance-e", "postfinance-card", "bancontact", "przelewy24", "alipay", "ideal", "eps", "giropay", "sepa"]
      }
      paymentMethods: {
        type: "array"
        description: "list of available payment methods"
        items: {
          type: "string"
          description: "available payment methods"
          enum: ["visa", "mastercard", "amex", "paypal", "sofort", "paydirekt", "postfinance-e", "postfinance-card", "bancontact", "przelewy24", "alipay", "ideal", "eps", "giropay", "sepa"]
        }
      }
      paymentProcess: {
        type: "string"
        description: "identifier of the created payment process."
      }
      portalId: {
        type: "string"
        description: "identifier for the portal"
      }
      redirectUrl: {
        type: "string"
        description: "redirect url. empty if the payment process does not require a redirect."
      }
      reference: {
        type: "string"
        description: "payment reference number, has to be unique per merchant and mode"
      }
      shipping: {
        type: "object"
        additionalProperties: true
      }
      shoppingCart: {
        type: "array"
        items: {
          type: "object"
          required: ["number", "price", "quantity", "type"]
          properties: {
            deliveryDateEnd: {
              type: "string"
              format: "date"
              description: "delivery period end date"
            }
            deliveryDateStart: {
              type: "string"
              format: "date"
              description: "delivery date"
            }
            description: {
              type: "string"
              description: "item description"
            }
            number: {
              type: "string"
              description: "item number"
            }
            price: {
              type: "integer"
              format: "int64"
              description: "gross price of single item"
            }
            quantity: {
              type: "integer"
              format: "int64"
              description: "total number of ordered items"
            }
            type: {
              type: "string"
              description: "item type"
              enum: ["goods", "shipment", "handling", "voucher"]
            }
            vatRate: {
              type: "integer"
              format: "int64"
              description: "vat rate (<100 in %, >=100 in bp)"
            }
          }
        }
      }
      status: {
        type: "string"
        description: "link status"
        enum: ["ready", "created", "executed", "expired", "deactivated"]
      }
      successUrl: {
        type: "string"
        description: "final redirect after a successful payment"
      }
      userId: {
        type: "string"
        description: "identifier of the created user."
      }
    }
  }
}