Skip to main content
POST
Create payment link
Use the API Playground below to send this request with your X-Api-Key. Provide a payment_provider_account_id and either an amount/currency pair or a products array (all in the same currency).

Authorizations

X-Api-Key
string
header
required

Body

application/json
name
string
required
payment_provider_account_id
string
required
description
string | null
products
string[]
amount
number<float> | null

Required if products is empty

currency
string

3-letter currency. Required with amount.

is_active
boolean
max_installments
integer
Required range: 1 <= x <= 24
interest_rate
number<float>
is_recurring
boolean
interval_unit
string
interval_count
integer
billing_cycles
integer | null

Response

201 - application/json

Created

id
string
public_token
string
name
string
description
string | null
amount
number<float> | null
currency
string
is_active
boolean
max_installments
integer
interest_rate
number<float>
is_recurring
boolean
interval_unit
string
interval_count
integer
billing_cycles
integer | null
payment_provider_account_id
string
provider_account
object
products
object[]
created_at
string<date-time>