Skip to main content
POST
Create a payment link

Headers

x-api-key
string
required

Body

application/json
slug
string
required

URL slug (3-30 chars, lowercase alphanumeric + hyphens)

Pattern: /^[a-z0-9][a-z0-9-]{1,28}[a-z0-9]$/
Example:

"my-shop"

title
string
required

Title displayed on the link page

Required string length: 1 - 200
Example:

"My Payment Page"

Link type: "link" or "church"

Available options:
link,
church
Example:

"link"

description
string
Maximum string length: 1000
Example:

"Pay for goods and services"

avatarUrl
string
Example:

"https://example.com/avatar.png"

accentColor
string
Maximum string length: 20
Example:

"#6366f1"

thankYouMessage
string
Maximum string length: 500
Example:

"Thank you for your payment!"

amountType
enum<string>

"flexible" | "fixed" | "preset"

Available options:
flexible,
fixed,
preset
Example:

"flexible"

fixedAmount
number

Fixed amount (required when amountType is "fixed")

Required range: x >= 0.01
Example:

49.99

presetAmounts
number[]

Preset amounts (required when amountType is "preset")

Example:
currency
string

Currency code

Maximum string length: 10
Example:

"USD"

minAmount
number

Minimum amount for flexible payments

Required range: x >= 0.01
Example:

1

maxAmount
number

Maximum amount for flexible payments

Required range: x >= 0.01
Example:

10000

acceptsCard
boolean
Example:

true

acceptsCrypto
boolean
Example:

false

collectName
boolean
Example:

true

collectEmail
boolean
Example:

true

collectNote
boolean
Example:

true

config
object

Church-specific config (categories, memberId, etc.)

Response

Created

success
boolean
required
Example:

true

data
object
required