Catalog

Read only

What it covers#

Read only: it lists the products or services the merchant already created as payment links and returns the detail of one.

Tools#

List catalog of products or services

Read only

tilopay_catalog_list_items

Lists the products or services in the payment links catalog.

API operation: GET /api/v1/getLinkPaymentList/{api_key}/{limit}see the operation page

Parameters

ParameterTypeRequiredDescription
limitintegerMaximum items (50 by default, 500 maximum)

Returns

{ result }

Raw Tilopay API response under the `result` key.

Catalog item detail

Read only

tilopay_catalog_get_item

Returns the detail of a catalog product or service by its ID.

API operation: GET /api/v1/getLinkPaymentById/{link_payment_id}/{api_key}see the operation page

Parameters

ParameterTypeRequiredDescription
itemIdstringyesCatalog item ID

Returns

{ result }

Raw Tilopay API response under the `result` key.

Create a catalog product or service

Write

tilopay_catalog_create_item

Creates a product or service in the Tilopay catalog (it becomes a reusable payment link with its price and description).

API operation: POST /api/v1/createLinkPaymentsee the operation page

Parameters

ParameterTypeRequiredDescription
namestringyesProduct or service name
amountnumberyesPrice
currencystringCurrency, e.g. CRC or USD. If omitted, the merchant's country currency is used.
descriptionstringyesProduct or service description

Returns

{ result, linkId, url }

result = the raw API response; linkId = id of the payment link representing the product; url = the product's charge link.

Change a catalog product

Sensitive

tilopay_catalog_update_item

Changes the name, price, currency or description of a catalog product. The Tilopay API does not allow in-place editing: the product is created with the new data and the old one is deleted, so the old product's link stops working. Confirm with the merchant before using it.

API operation: POST /api/v1/createLinkPaymentsee the operation page

Parameters

ParameterTypeRequiredDescription
item_idstringyesID of the product to change
namestringyesNew name (or the same one)
amountnumberyesNew price (or the same one)
currencystringCurrency; if omitted, the merchant's country currency
descriptionstringyesNew description (or the same one)

Returns

{ result, linkId, url, replaced }

The API does not allow editing a link: the tool creates the new product and deletes the previous one. replaced = id of the product that was replaced; linkId and url = those of the new product.

Delete a catalog product

Sensitive

tilopay_catalog_delete_item

Deletes a product or service from the catalog by its ID. Its link stops working. Confirm with the merchant before using it.

API operation: POST /api/v1/deleteLinkPaymentsee the operation page

Parameters

ParameterTypeRequiredDescription
item_idstringyesID of the product to delete

Returns

{ result }

result = API response deleting the payment link representing the product.

Last verified: 2026-08-29 · Owner: equipo-integraciones

View as raw Markdown