Buy Buttons

E-commerce payment button configuration

List buy buttons

get

/buy-buttons

Returns all buy buttons configured by the authenticated merchant. Supports filtering by name and date range.

Roles: Manager, SuperManager

Authorizations

AuthorizationstringRequired

JWT token obtained from /auth/login or /auth/login/manager. Include as Authorization: Bearer <token>.

Query parameters

startDatestring · dateOptional

Filter start date (ISO format)

endDatestring · dateOptional

Filter end date (ISO format, required if startDate is set)

namestringOptional

Filter by button name (partial match)

Responses

200

Buy button list

application/json

successbooleanOptional

Whether the request succeeded

statusintegerOptional

HTTP status code

401

Unauthorized

application/json

get/buy-buttons

GET /api/next/buy-buttons HTTP/1.1
Host: api.lyzi.fr
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "status": 1,
  "data": [
    {
      "_id": "text",
      "name": "text",
      "websiteUrl": "https://example.com",
      "itemRef": "text",
      "callbackUrl": "text",
      "price": 1,
      "currency": "text",
      "goods": {
        "goodsName": "text",
        "goodsType": "01",
        "goodsCategory": "0000",
        "goodsDetail": "text",
        "goodsQuantity": "text"
      },
      "identifier": "text"
    }
  ]
}

Create a buy button

post

/buy-buttons

Creates a new e-commerce buy button. After creation, embed the generated HTML snippet on your product page.

Roles: Manager, SuperManager

Authorizations

AuthorizationstringRequired

JWT token obtained from /auth/login or /auth/login/manager. Include as Authorization: Bearer <token>.

Body

namestringRequired

Internal name for the button

websiteUrlstring · uriRequired

URL of the page where the button is embedded

itemRefstringOptional

Merchant's product reference

callbackUrlstringOptional

Webhook URL called when payment completes

pricenumberRequired

Fixed price in the specified currency

currencystringRequired

Currency code (e.g. EUR, USD, CHF)

Responses

200

Buy button created

application/json

successbooleanOptional

Whether the request succeeded

statusintegerOptional

HTTP status code

401

Unauthorized

application/json

422

Validation error

application/json

post/buy-buttons

POST /api/next/buy-buttons HTTP/1.1
Host: api.lyzi.fr
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 255

{
  "name": "Blue T-Shirt — Pay with Crypto",
  "websiteUrl": "https://myshop.com/products/blue-tshirt",
  "price": 29.99,
  "currency": "EUR",
  "callbackUrl": "https://myshop.com/webhooks/lyzi",
  "goods": {
    "goodsName": "Blue T-Shirt",
    "goodsType": "01",
    "goodsCategory": "3000"
  }
}

{
  "success": true,
  "status": 1,
  "data": {
    "_id": "text",
    "name": "text",
    "websiteUrl": "https://example.com",
    "itemRef": "text",
    "callbackUrl": "text",
    "price": 1,
    "currency": "text",
    "goods": {
      "goodsName": "text",
      "goodsType": "01",
      "goodsCategory": "0000",
      "goodsDetail": "text",
      "goodsQuantity": "text"
    },
    "identifier": "text"
  }
}

Get a buy button

get

/buy-buttons/{id}

Returns details of a single buy button by ID.

Roles: SuperAdmin, Manager, SimpleUser, SuperManager, Service

Authorizations

AuthorizationstringRequired

JWT token obtained from /auth/login or /auth/login/manager. Include as Authorization: Bearer <token>.

Path parameters

idstringRequired

Responses

200

Buy button details

application/json

successbooleanOptional

Whether the request succeeded

statusintegerOptional

HTTP status code

401

Unauthorized

application/json

404

Not found

get/buy-buttons/{id}

GET /api/next/buy-buttons/{id} HTTP/1.1
Host: api.lyzi.fr
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "status": 1,
  "data": {
    "_id": "text",
    "name": "text",
    "websiteUrl": "https://example.com",
    "itemRef": "text",
    "callbackUrl": "text",
    "price": 1,
    "currency": "text",
    "goods": {
      "goodsName": "text",
      "goodsType": "01",
      "goodsCategory": "0000",
      "goodsDetail": "text",
      "goodsQuantity": "text"
    },
    "identifier": "text"
  }
}

Update a buy button

put

/buy-buttons/{id}

Updates one or more fields of a buy button.

Roles: Manager, SuperManager

Authorizations

AuthorizationstringRequired

JWT token obtained from /auth/login or /auth/login/manager. Include as Authorization: Bearer <token>.

Path parameters

idstringRequired

Body

namestringOptional

websiteUrlstringOptional

itemRefstringOptional

callbackUrlstringOptional

pricenumberOptional

currencystringOptional

identifierstringOptional

HTML embed identifier

Responses

200

Buy button updated

application/json

successbooleanOptional

Whether the request succeeded

statusintegerOptional

HTTP status code

401

Unauthorized

application/json

put/buy-buttons/{id}

PUT /api/next/buy-buttons/{id} HTTP/1.1
Host: api.lyzi.fr
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 121

{
  "name": "text",
  "websiteUrl": "text",
  "itemRef": "text",
  "callbackUrl": "text",
  "price": 1,
  "currency": "text",
  "identifier": "text"
}

{
  "success": true,
  "status": 1,
  "data": {
    "_id": "text",
    "name": "text",
    "websiteUrl": "https://example.com",
    "itemRef": "text",
    "callbackUrl": "text",
    "price": 1,
    "currency": "text",
    "goods": {
      "goodsName": "text",
      "goodsType": "01",
      "goodsCategory": "0000",
      "goodsDetail": "text",
      "goodsQuantity": "text"
    },
    "identifier": "text"
  }
}

Delete a buy button

delete

/buy-buttons/{id}

Permanently removes a buy button.

Roles: Manager, SuperManager

Authorizations

AuthorizationstringRequired

JWT token obtained from /auth/login or /auth/login/manager. Include as Authorization: Bearer <token>.

Path parameters

idstringRequired

Responses

200

Buy button deleted

application/json

successbooleanOptional

Whether the request succeeded

statusintegerOptional

HTTP status code

dataanyOptional

Response payload

401

Unauthorized

application/json

delete/buy-buttons/{id}

DELETE /api/next/buy-buttons/{id} HTTP/1.1
Host: api.lyzi.fr
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "status": 1,
  "data": null
}