Skip to main content
POST
Create a payment link

Headers

x-api-key
string
required

Body

application/json
amount
number
required

Payment amount

Required range: x >= 0.01
Example:

49.99

currency
string
required

ISO 4217 currency code

Maximum string length: 10
Example:

"usd"

email
string<email>

Customer email for receipts

Example:

"customer@example.com"

description
string

Payment description shown to customer

Maximum string length: 500
Example:

"Premium plan subscription"

metadata
object

Arbitrary metadata attached to the payment

Example:

Response

Payment link created

success
boolean
required
Example:

true

data
object
required