Create Yolfi Paylink
yolfi_paylinks_createCreate a Yolfi payment link after approval of product, amount, currency, and one-time or recurring billing.
Instructions
Create a Yolfi payment link only after the user approves product name, amount, currency, and one-time or recurring payment type.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | User-approved product, plan, donation, or access name shown on checkout. | |
| type | No | Payment link type: ONE_TIME or RECURRING. | |
| price | Yes | User-approved decimal price, represented as a string to avoid numeric rounding. | |
| currency | No | Account currency code. Supported values are USD, EUR, and CNY. | |
| imageUrl | No | Optional public product image URL shown on checkout. | |
| metadata | No | Safe non-secret metadata such as source, productSlug, planId, or environment. | |
| collectName | No | Whether checkout should collect the customer name. | |
| description | No | Optional user-approved customer-facing description. | |
| collectEmail | No | Whether checkout should collect customer email. | |
| collectAddress | No | Whether checkout should collect the customer address. | |
| paymentMetadata | No | Default payment metadata as a flat map of strings, finite numbers, or booleans; do not use customer-controlled metadata as authorization. | |
| recurringInterval | No | Recurring billing interval when type is RECURRING. | |
| collectDateOfBirth | No | Whether checkout should collect the customer date of birth. | |
| collectPhoneNumber | No | Whether checkout should collect the customer phone number. | |
| recurringIntervalCount | No | Multiplier for the recurring interval; the backend applies the interval-specific maximum. |