Retrieve Payment Link

Retrieves the details and current status of a payment link.

GET /v1/payment-links/{payment_link_id}

Get payment link

cURL

curl --request GET \
  --url https://api-sandbox.y.uno/v1/payment-links/{payment_link_id} \
  --header 'private-secret-key: <api-key>' \
  --header 'public-api-key: <api-key>'

200

{
  "id": "pl_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "url": "https://pay.y.uno/pl_a1b2c3d4",
  "amount": {
    "currency": "BRL",
    "value": 250
  },
  "country": "BR",
  "status": "ACTIVE",
  "description": "Invoice #INV-2026-001",
  "merchant_order_id": "order-link-001",
  "expires_at": "2026-03-08T23:59:59.000Z",
  "created_at": "2026-03-01T14:00:00.000Z"
}

Authorizations

public-api-key · string · header · required

Your public API key from the Yuno Dashboard

private-secret-key · string · header · required

Your private secret key (server-side only)

Path Parameters

payment_link_id · string<uuid> · required

The unique identifier of the payment link

Response

200

application/json

Payment link details

id · string<uuid>

Example:

"pl_a1b2c3d4-e5f6-7890-abcd-ef1234567890"

url · string<uri>

Shareable payment link URL

Example:

"https://pay.y.uno/pl_a1b2c3d4"

amount · object

Show child attributes

Example:

{ "currency": "BRL", "value": 100 }

country · string

Example:

"BR"

status · enum<string>

Available options: ACTIVE, COMPLETED, CANCELLED, EXPIRED

Example:

"ACTIVE"

description · string

Example:

"Invoice #INV-2026-001"

merchant_order_id · string

Example:

"order-link-001"

expires_at · string<date-time>

Example:

"2026-03-08T23:59:59.000Z"

created_at · string<date-time>

Example:

"2026-03-01T14:00:00.000Z"