Skip to main content
POST
/
v1
/
payment-links
Create payment link
curl --request POST \
  --url https://api-sandbox.y.uno/v1/payment-links \
  --header 'Content-Type: application/json' \
  --header 'account-code: <api-key>' \
  --header 'private-secret-key: <api-key>' \
  --header 'public-api-key: <api-key>' \
  --data '
{
  "amount": {
    "currency": "BRL",
    "value": 250
  },
  "country": "BR",
  "description": "Invoice #INV-2026-001",
  "merchant_order_id": "order-link-001",
  "expires_at": "2026-03-08T23:59:59.000Z"
}
'
{
  "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)

​
account-code
string
header
required

Your account identifier. The alias X-Account-Code is also accepted.

Body

application/json
​
amount
object
required
Example:
{ "currency": "BRL", "value": 100 }
​
country
string
required

ISO 3166-1 alpha-2 country code

Pattern: ^[A-Z]{2}$
Example:

"BR"

​
description
string

Payment description shown to customer

Example:

"Invoice #INV-2026-001"

​
merchant_order_id
string

Your unique order identifier

Example:

"order-link-001"

​
expires_at
string<date-time>

Expiration date for the link

Example:

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

Response

Payment link created successfully

​
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
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"