Catalog

Read only

What it covers#

Read only: it lists the products or services you 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 of the Tilopay catalog (title, price and short link). It can search by name or description (ignoring accents and case). The Tilopay listing may take a few minutes to reflect changes made in the dashboard; whatever is created from here appears immediately and the response of tilopay_catalog_create_item already includes the new item. Use refresh=true to force a fresh read.

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

Parameters

Parameter	Type	Required	Description
`limit`	integer	—	Maximum items (50 by default, 500 maximum)
`search`	string	—	Texto a buscar en el nombre del producto
`page`	integer	—	Página (por defecto 1)
`refresh`	boolean	—	true para ignorar la memoria corta y leer de nuevo
`include_qr`	boolean	—	Incluir el QR completo en base64 de cada ítem (por defecto false; el listado devuelve solo el enlace y has_qr)

Returns

{ result }

Raw Tilopay API response under the `result` key.

Catalog item detail

Read only

tilopay_catalog_get_item

Gets the detail of a product or service of the Tilopay catalog by its ID. The base64 QR only with include_qr=true.

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

Parameters

Parameter	Type	Required	Description
`itemId`	string	yes	Catalog item ID
`include_qr`	boolean	—	Incluir el QR en base64 (por defecto false; úsalo solo si el comercio pide el QR)

Returns

{ result }

Raw Tilopay API response under the `result` key.

Add a product or service to the catalog

Write

tilopay_catalog_create_item

Creates a product or service in the Tilopay catalog with its price and returns the short payment link and the QR as an image. If the merchant sent a photo on WhatsApp in the last 10 minutes, it uses it as the product image.

API operation: POST /api/v1/createLinkPayment — see the operation page

Parameters

Parameter	Type	Required	Description
`name`	string	yes	Product or service name
`amount`	number	yes	Price
`currency`	string	—	Currency, e.g. CRC or USD. If omitted, the merchant's country currency is used.
`description`	string	—	Product or service description
`media_ref`	string	—	Referencia exacta de la imagen recibida por WhatsApp, si la conoce
`use_last_image`	boolean	—	false para crear el producto sin foto aunque haya una imagen reciente

Returns

{ result, linkId, url }

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

Edit a catalog product

Write

tilopay_catalog_update_item

Edits a product of the Tilopay catalog (name, price, currency, description or photo) without changing its payment link.

API operation: POST /api/v1/createLinkPayment — see the operation page

Parameters

Parameter	Type	Required	Description
`itemId`	string	yes	ID del ítem del catálogo
`name`	string	—	New name (or the same one)
`amount`	number	—	New price (or the same one)
`currency`	string	—	Currency; if omitted, the merchant's country currency
`description`	string	—	New description (or the same one)
`media_ref`	string	—	Referencia exacta de la imagen recibida por WhatsApp, si la conoce
`use_last_image`	boolean	—	false para no cambiar la foto aunque haya una imagen reciente

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 from the Tilopay catalog. The product's payment link stops working. Requires a confirmation code sent by email.

API operation: POST /api/v1/deleteLinkPayment — see the operation page

Parameters

Parameter	Type	Required	Description
`itemId`	string	yes	ID del ítem del catálogo
`confirmation_code`	string	—	Código de 6 dígitos enviado al correo del comercio

Returns

{ result }

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

Sync the catalog with social networks and search engines

Write

tilopay_catalog_feed

Delivers the synced catalog link and the steps to connect it in Facebook/Instagram, Google Shopping, TikTok or Pinterest (one channel at a time, the one the merchant asks for). With send_email=true it sends it to the merchant's email.

Parameters

Parameter	Type	Required	Description
`platform`	string (facebook \| google \| tiktok \| pinterest)	—	Canal pedido. Si el comercio no dijo cuál, NO llames: pregúntale primero.
`send_email`	boolean	—	true si pidió que se lo mandes por correo

Returns

Last verified: 2026-10-07 · Owner: equipo-integraciones

View as raw Markdown