Moov · Schema

CreatePaymentLinkRequest

Request body for creating a payment link.

BankingEmbedded FinanceFinancial InfrastructureMoney MovementPaymentsTransfers

Properties

Name Type Description
amount object
description string Description of the payment that will be shown to the payer.
expiresOn string ISO 8601 timestamp when this payment link should expire.
View JSON Schema on GitHub

JSON Schema

moov-createpaymentlinkrequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreatePaymentLinkRequest",
  "title": "CreatePaymentLinkRequest",
  "type": "object",
  "description": "Request body for creating a payment link.",
  "required": [
    "amount"
  ],
  "properties": {
    "amount": {
      "$ref": "#/components/schemas/Amount"
    },
    "description": {
      "type": "string",
      "description": "Description of the payment that will be shown to the payer.",
      "maxLength": 250
    },
    "expiresOn": {
      "type": "string",
      "format": "date-time",
      "description": "ISO 8601 timestamp when this payment link should expire."
    }
  }
}