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' \
  --data '
{
  "account_id": "YOUR_ACCOUNT_ID",
  "country": "US",
  "amount": {
    "currency": "USD",
    "value": 10000
  },
  "payment_method_types": [
    "CARD"
  ],
  "description": "Payment Link #001",
  "merchant_order_id": "order-link-001",
  "capture": true,
  "one_time_use": true,
  "callback_url": "https://example.com/payment/success",
  "availability": {
    "start_at": "2026-01-01T00:00:00Z",
    "finish_at": "2026-12-31T23:59:59Z"
  }
}
'
{
  "code": "<string>",
  "checkout_url": "<string>",
  "status": "CREATED",
  "amount": {
    "currency": "<string>",
    "value": 123
  },
  "created_at": "2023-11-07T05:31:56Z",
  "availability": {
    "start_at": "2023-11-07T05:31:56Z",
    "finish_at": "2023-11-07T05:31:56Z"
  }
}

Body

application/json
account_id
string<uuid>
required
country
enum<string>
required

ISO 3166-1 alpha-2 country code

Available options:
AR,
BO,
BR,
CL,
CO,
CR,
EC,
SV,
GT,
HN,
MX,
NI,
PA,
PY,
PE,
US,
UY
amount
object
required
payment_method_types
string[]
required
description
string
merchant_order_id
string
capture
boolean
default:true
one_time_use
boolean
default:false
callback_url
string<uri>
availability
object
customer_payer
object
metadata
object[]
Maximum array length: 120

Response

200 - application/json

Payment link created

code
string
checkout_url
string<uri>
status
enum<string>
Available options:
CREATED,
USED,
CANCELLED,
EXPIRED
amount
object
created_at
string<date-time>
availability
object