Moov · Schema

UpdatePaymentLinkRequest

Request body for updating a payment link.

BankingEmbedded FinanceFinancial InfrastructureMoney MovementPaymentsTransfers

Properties

Name Type Description
amount object
description string Updated description for the payment link.
status string Update the status of the payment link.
expiresOn string Updated expiration timestamp for the payment link.
View JSON Schema on GitHub

JSON Schema

moov-updatepaymentlinkrequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UpdatePaymentLinkRequest",
  "title": "UpdatePaymentLinkRequest",
  "type": "object",
  "description": "Request body for updating a payment link.",
  "properties": {
    "amount": {
      "$ref": "#/components/schemas/Amount"
    },
    "description": {
      "type": "string",
      "description": "Updated description for the payment link.",
      "maxLength": 250
    },
    "status": {
      "type": "string",
      "description": "Update the status of the payment link.",
      "enum": [
        "active",
        "inactive"
      ]
    },
    "expiresOn": {
      "type": "string",
      "format": "date-time",
      "description": "Updated expiration timestamp for the payment link."
    }
  }
}