Add Metadata in a Payment link

Editing and Adding Metadata to a Payment Link

This guide explains how to edit existing metadata and add new metadata to a payment link in the platform.

Accessing the Metadata Edit Function

  1. Navigate to the payment link details page.
  2. Locate the metadata section.
  3. Click on the "Edit metadata" option.

Editing Existing Metadata

When you click on "Edit metadata":

  1. All existing metadata fields become editable.
  2. You can modify both the "Key" and "Value" fields for each metadata entry.

Adding New Metadata

To add new metadata:

  1. Click the "Add metadata" button that appears when in edit mode.

  2. A new set of "Key" and "Value" input fields will be displayed.

  3. Enter the desired key and value for the new metadata.

Saving Changes

  1. Ensure all fields are filled (both "Key" and "Value" for each entry).
  2. Verify that all "Key" entries are unique.
  3. If all conditions are met, the "Save" button will be enabled.
  4. Click "Save" to update the metadata.

Canceling Changes

If you decide not to save your changes:

  1. Click the "Cancel" button.
  2. All changes will be discarded, and you'll return to the view mode.

Important Notes

  • The "Key" field must be unique for each metadata entry.
  • Empty fields are not allowed when saving.
  • The "Save" button remains disabled if there are any empty fields or duplicate keys.

Error Messages

You may encounter the following error message:

  • "Metadata keys must be unique." - This appears in red under the input field if you try to use a key that already exists.

Success Message

Upon successful update, you'll see:

  • "Metadata has been successfully updated"

Best Practices

  1. Use clear and descriptive keys for easy understanding.
  2. Keep values concise but informative.
  3. Double-check for typos before saving to ensure accuracy.
  4. Use consistent naming conventions for keys across different payment links.

Step-by-Step Guide

  1. Click "Edit metadata" to enter edit mode.
  2. Modify existing metadata as needed.
  3. To add new metadata, click "Add metadata" and fill in the new "Key" and "Value" fields.
  4. Ensure all fields are filled and all keys are unique.
  5. If everything is correct, the "Save" button will be enabled.
  6. Click "Save" to update the metadata.
  7. You'll see a success message and return to view mode.

By following these steps, you can efficiently manage metadata for your payment links, ensuring all information is up-to-date and accurately recorded.