Skip to main content
POST
Create a payment link

Authorizations

Authorization
string
header
required

API key from the Payoes dashboard (pk_test_... or pk_live_...)

Body

application/json
amount
string
required

Stellar amount with up to 7 decimal places

Pattern: ^\d+(\.\d{1,7})?$
Example:

"10.5"

settlement_asset
object
allowed_assets
object[]
Minimum array length: 1
description
string | null
Maximum string length: 500
metadata
object | null

Response

Payment link created

id
string
required
Example:

"plink_abc123xyz"

object
enum<string>
required
Available options:
payment_link
amount
string
required
settlement_asset
object
required
allowed_assets
object[]
required
active
boolean
required
url
string<uri>
required

Checkout entry URL (/c/plink_...)

environment
enum<string>
required
Available options:
sandbox,
production
created_at
string<date-time>
required
updated_at
string<date-time>
required
description
string | null
metadata
object | null