Skip to main content
POST
/
api
/
v1
/
business
/
links
Create a payment link
curl --request POST \
  --url http://localhost:3001/api/v1/business/links \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "slug": "my-shop",
  "title": "My Payment Page",
  "linkType": "link",
  "description": "Pay for goods and services",
  "avatarUrl": "https://example.com/avatar.png",
  "accentColor": "#6366f1",
  "thankYouMessage": "Thank you for your payment!",
  "amountType": "flexible",
  "fixedAmount": 49.99,
  "presetAmounts": [
    5,
    10,
    25,
    50,
    100
  ],
  "currency": "USD",
  "minAmount": 1,
  "maxAmount": 10000,
  "acceptsCard": true,
  "acceptsCrypto": false,
  "collectName": true,
  "collectEmail": true,
  "collectNote": true,
  "config": {}
}
'
{
  "success": true,
  "data": {
    "id": "<string>",
    "businessId": "<string>",
    "slug": "<string>",
    "title": "<string>",
    "amount": 123,
    "currency": "<string>",
    "type": "link",
    "isActive": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "redirectUrl": "<string>",
    "metadata": {}
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.useaxra.com/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
x-api-key
string
required

Body

application/json
​
slug
string
required

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

Example:

"my-shop"

​
title
string
required

Title displayed on the link page

Example:

"My Payment Page"

​
linkType
string

Link type: "link" or "church"

Example:

"link"

​
description
string
Example:

"Pay for goods and services"

​
avatarUrl
string
Example:

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

​
accentColor
string
Example:

"#6366f1"

​
thankYouMessage
string
Example:

"Thank you for your payment!"

​
amountType
string

"flexible" | "fixed" | "preset"

Example:

"flexible"

​
fixedAmount
number

Fixed amount (required when amountType is "fixed")

Example:

49.99

​
presetAmounts
string[]

Preset amounts (required when amountType is "preset")

Example:
[5, 10, 25, 50, 100]
​
currency
string

Currency code

Example:

"USD"

​
minAmount
number

Minimum amount for flexible payments

Example:

1

​
maxAmount
number

Maximum amount for flexible payments

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