The Payment Link Object

Represents a shareable payment link that allows customers to pay without a custom integration.

The Payment Link object represents a shareable URL that opens a Yuno-hosted checkout page. Payment links are ideal for invoice collection, social commerce, email billing, and scenarios where you need to collect a payment without building a custom checkout integration.

No-code payments. Payment links use Yuno’s hosted checkout UI. The customer clicks the link, selects a payment method, and completes the transaction. No SDK integration is required on your side.

Object Fields

id · string

The unique identifier for this payment link (UUID).

Example: pl_6e7f8a9b-0c1d-2e3f-4a5b-6c7d8e9f0a1b

url · string

The shareable payment link URL. Send this to your customer via email, SMS, WhatsApp, or any channel.

Example: https://pay.y.uno/pl_6e7f8a9b-0c1d-2e3f-4a5b-6c7d8e9f0a1b

amount · object

The payment amount details.

Show amount

value · number

The payment amount value.

Example: 499.90

currency · string

ISO 4217 currency code.

Example: USD

country · string

The country where the payment takes place. ISO 3166-1 alpha-2 code. Determines which payment methods are displayed.

Example: US

status · string

Current status of the payment link.

Values: ACTIVE, EXPIRED, COMPLETED, CANCELLED

Example: ACTIVE

description · string

Customer-facing description displayed on the hosted checkout page.

Example: Invoice #2026-042 — Web Development Services

merchant_order_id · string

Your internal order or invoice identifier, used for reconciliation.

Example: inv-2026-042

one_time_use · boolean

When true, the link can only be used for a single successful payment. When false, the link remains active and can accept multiple payments until it expires or is cancelled.

Example: true

vault_on_success · boolean

When true, the customer’s payment method is automatically enrolled (vaulted) after a successful payment. Requires a customer_id to be associated with the link.

Example: false

expires_at · string

ISO 8601 timestamp of when the payment link expires. After this time, the link returns an expiration message to the customer.

Example: 2026-03-17T23:59:59.000Z

payment_id · string

The ID of the Payment Object created when a customer completes payment through this link. null until a payment is made.

Example: 8546df3a-b83e-4bb5-a4b3-57aa6385924f

created_at · string

ISO 8601 timestamp of when the payment link was created.

Example: 2026-03-10T14:00:00.000Z

Example

{
  "id": "pl_6e7f8a9b-0c1d-2e3f-4a5b-6c7d8e9f0a1b",
  "url": "https://pay.y.uno/pl_6e7f8a9b-0c1d-2e3f-4a5b-6c7d8e9f0a1b",
  "amount": {
    "value": 499.90,
    "currency": "USD"
  },
  "country": "US",
  "status": "ACTIVE",
  "description": "Invoice #2026-042 — Web Development Services",
  "merchant_order_id": "inv-2026-042",
  "one_time_use": true,
  "vault_on_success": false,
  "expires_at": "2026-03-17T23:59:59.000Z",
  "payment_id": null,
  "created_at": "2026-03-10T14:00:00.000Z"
}

Status Lifecycle

Status	Description
ACTIVE	Link is live and accepting payments.
COMPLETED	A successful payment has been made through this link. For one_time_use links, the link is no longer usable.
EXPIRED	The link has passed its expires_at time without a completed payment.
CANCELLED	The link was manually cancelled via the API.

Related Endpoints

• Create Payment Link. POST /v1/payment-links
• Get Payment Link. GET /v1/payment-links/{payment_link_id}
• Cancel Payment Link. POST /v1/payment-links/{payment_link_id}/cancel

Related Concepts

• Payment Object. The payment created when a customer uses the link
• Hosted Checkout. How Yuno’s hosted checkout page works
• Webhooks. Receive notifications when a payment link is completed