Payment Links

Create shareable payment links to collect payments without building a frontend checkout experience.

Overview

Payment Links allow you to create shareable URLs that direct customers to a hosted payment page. This is ideal for scenarios where you need to collect payments without building or maintaining a checkout frontend — such as invoice payments, social commerce, email campaigns, or phone orders.

Each payment link generates a unique URL that can be shared via email, SMS, messaging apps, or embedded in a website.

Creating a Payment Link

Use the Payment Links API to generate a shareable payment URL.

cURL

curl --request POST \
  --url https://api.y.uno/v1/payment-links \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --data '{
    "amount": {
      "value": 150.00,
      "currency": "USD"
    },
    "country": "US",
    "description": "Invoice #1042 - Premium Plan",
    "customer": {
      "email": "[e-mail]",
      "name": "Jane Smith"
    },
    "expiration_date": "2026-03-15T23:59:59Z",
    "allowed_payment_methods": ["CARD"],
    "redirect_url": "https://yourstore.com/thank-you",
    "metadata": {
      "invoice_id": "INV-1042",
      "order_id": "ORD-5678"
    }
  }'

Payment Link Configuration

Parameter	Required	Description
amount	Yes	Payment amount and currency
country	Yes	ISO 3166-1 alpha-2 country code
description	No	Description shown to customer on payment page
customer	No	Pre-fill customer information
expiration_date	No	ISO 8601 expiration timestamp
allowed_payment_methods	No	Restrict available payment methods
redirect_url	No	URL to redirect after successful payment
metadata	No	Key-value pairs for your internal reference

Payment Link Lifecycle

Status	Description
ACTIVE	Link is available for payment
COMPLETED	Payment has been successfully collected
EXPIRED	Link passed its expiration date
CANCELLED	Link was manually cancelled

A payment link can only be used once. After a successful payment, the link status changes to COMPLETED and cannot be reused.

Managing Payment Links

List Payment Links

curl --request GET \
  --url https://api.y.uno/v1/payment-links \
  --header 'X-Api-Key: YOUR_API_KEY'

Cancel a Payment Link

curl --request POST \
  --url https://api.y.uno/v1/payment-links/pl_abc123def456/cancel \
  --header 'X-Api-Key: YOUR_API_KEY'

Webhook Events

Event	Trigger
payment_link.created	New payment link generated
payment_link.paid	Customer completed payment
payment_link.expired	Link reached expiration date
payment_link.cancelled	Link was manually cancelled

Always set an expiration_date for payment links to prevent stale links from being used unexpectedly. A common practice is 7-30 days depending on the use case.

Use Cases

• Invoice payments: Send payment links in invoices for easy collection.
• Social commerce: Share links on social media or messaging apps.
• Phone orders: Generate links during phone calls for customers to pay.
• Email campaigns: Embed payment links in marketing emails.
• Donations: Create one-time donation collection links.

Payment links use Yuno’s hosted checkout page, which is fully PCI-compliant and handles all payment method rendering and processing. No frontend development is required on your side.

Enroll Cards with Payment Links

Payment links can also be used to update expired or declined card details and automatically enroll the new card. This is particularly useful for merchants running their own subscription engines who need a new vaulted_token when a customer’s card expires or is blocked.

How It Works

1. Send the Payment Link

   Create a payment link with vault_on_success set to true and one_time_use set to true. The customer receives a secure link to complete a pending payment with a new credit or debit card.

   Required fields:

   • customer_payer.id. Previously generated customer identifier
   • one_time_use. Set to true for single-use links
   • vault_on_success. Set to true to enroll the card after successful payment
2. Automatic Enrollment

   Upon successful payment through the link, Yuno automatically generates a new vaulted_token for the customer’s updated card.

3. Continue Charging

   Use the Get Payment Methods endpoint to retrieve the customer’s updated stored payment methods. Continue your subscription schedule with the new vaulted_token.

Benefits

• Speed: Customers resolve payment issues instantly without account login.
• Seamless update: New cards are automatically saved when previous cards expire or are blocked.
• Security: All transactions use Yuno’s PCI-compliant hosted checkout with encryption.