Create Paylink

Create payment link.

POST /paylinks

Create Paylink

cURL

curl --request POST \
  --url https://mapi.zbx.boomfi.xyz/v1/paylinks \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "amount": "<string>",
  "currency": "<string>",
  "name": "<string>",
  "account_ids": [
    123
  ],
  "account_ref": "<string>",
  "available_quantity": 2,
  "description": "<string>",
  "expires_at": "<string>",
  "image_url": "<string>",
  "intervalCount": 2,
  "metadata": {},
  "reference": "<string>",
  "trial_period": "<string>",
  "type": "<string>"
}
'

200

{
  "data": {
    "created_at": "<string>",
    "created_by": "<string>",
    "customer_ident_collection": true,
    "deleted_at": "<string>",
    "enabled": true,
    "id": "<string>",
    "invoice_id": "<string>",
    "metadata": {},
    "plan": {
      "available_quantity": 123,
      "created_at": "<string>",
      "created_by": "<string>",
      "currency": "<string>",
      "deleted_at": "<string>",
      "enabled": true,
      "expires_at": "<string>",
      "id": "<string>",
      "metadata": {},
      "name": "<string>",
      "org_id": "<string>",
      "payment_link": {
        "created_at": "<string>",
        "created_by": "<string>",
        "customer_ident_collection": true,
        "deleted_at": "<string>",
        "enabled": true,
        "id": "<string>",
        "invoice_id": "<string>",
        "metadata": {},
        "plan_id": "<string>",
        "properties": {},
        "shipping_address_collection": true,
        "tax_ident_collection": true,
        "updated_at": "<string>",
        "updated_by": "<string>"
      },
      "price": "<string>",
      "properties": {},
      "recurring_interval_count": 123,
      "reference": "<string>",
      "trial_period": "<string>",
      "updated_at": "<string>"
    },
    "plan_id": "<string>",
    "properties": {},
    "shipping_address_collection": true,
    "tax_ident_collection": true,
    "updated_at": "<string>",
    "updated_by": "<string>"
  },
  "error": true,
  "message": "<string>"
}

Authorizations

X-API-KEY · string · header · required

Body

application/json

Create Payment Link Request

amount · string · required

Price amount in major units as a decimal string (non-zero).

currency · string · required

Currency code for the price (recognised and enabled).

name · string · required

Display name shown on the payment link (max 100 characters).

Maximum string length: 100

account_ids · integer[]

Settlement account IDs to accept payment on.

account_ref · string

Settlement account reference as an alternative to account_ids.

Maximum string length: 100

available_quantity · integer

Remaining purchasable quantity; set to 1 for single-use links.

Required range: x >= 1

description · string

Human-readable description shown at checkout (max 200 characters).

Maximum string length: 200

expires_at · string

When the payment link expires (must be in the future).

image_url · string

Optional image URL shown on the payment link.

interval · enum<string>

Billing interval unit for recurring links.

Available options: Unknown, Minute, Hour, Day, Week, Month, Year

intervalCount · integer

Number of interval units between billings. Minimum 1.

Required range: x >= 1

metadata · object

Arbitrary key-value metadata (max 10 entries).

Show child attributes

reference · string

Optional merchant-defined reference (max 50 characters).

Maximum string length: 50

trial_period · string

Optional trial period before the first charge (parseable duration).

type · string

Plan type: OneTime or Recurring. Defaults from interval when omitted.

Response

200

application/json

OK

data · object

Response payload when the request succeeded.

Show child attributes

error · boolean

True when the request failed.

message · string

Human-readable status or error message.