Payment links
DestructiveWhat it covers#
With this group the agent creates a payment link, reads its detail, deletes it and prepares delivery to the customer over WhatsApp or email. WhatsApp delivery does not send the message: it returns a link ready to send.
Tools#
Create payment link
Writetilopay_create_payment_link
Creates a payment link to charge a specific amount.
API operation: POST /api/v1/createLinkPayment — see the operation page
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
amount | number | yes | Amount to charge, greater than zero |
reference | string | yes | Internal reference for the charge |
description | string | yes | Description of the charge |
currency | string | — | Currency, e.g. USD or CRC (USD by default) |
client | string | — | Customer name |
client_email | string | — | Customer email |
client_phone | string | — | Customer phone |
type | integer | — | Link type (0 by default) |
callback_url | string | — | Return URL after the payment |
webhook_url | string | — | Notification webhook URL |
Returns
{ result, linkId, url }
result is the raw response; linkId and url are the id and the URL of the link already extracted. When webhook_url is not sent, the server sets one of its own so it can report the payment.
Payment link detail
Read onlytilopay_get_payment_link
Returns the detail of a payment link by its ID.
API operation: GET /api/v1/getDetailLinkPayment/{link_payment_id}/{api_key} — see the operation page
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
linkPaymentId | string | yes | Payment link ID |
Returns
{ result }
Raw Tilopay API response under the `result` key.
Delete payment link
Sensitivetilopay_delete_payment_link
Deletes a payment link by its ID.
API operation: POST /api/v1/deleteLinkPayment — see the operation page
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | ID of the payment link to delete |
Returns
{ result }
Raw Tilopay API response under the `result` key.
Send payment link over WhatsApp
Writetilopay_send_payment_link_whatsapp
Prepares sending the payment link over WhatsApp: it returns a wa.me link with the message ready. It accepts the name of a saved contact or a phone number.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
link_url | string | yes | Payment link URL |
contact_name | string | — | Name of the saved contact or of the customer |
phone | string | — | WhatsApp phone, e.g. +50688887777 |
amount | number | — | — |
currency | string | — | — |
description | string | — | — |
message | string | — | Your own message text |
save_contact | boolean | — | Save the contact in the address book |
send_now | boolean | — | Deprecated: ignored. The wa.me link is always returned. (deprecated) |
Returns
{ to, message, whatsapp_url }
It does not send the message: it returns the resolved phone, the drafted text and a wa.me link to send it with one tap. When there is no phone and no saved contact with that name, it returns an error asking for it. It saves the contact unless save_contact is false.
Send payment link over email
Writetilopay_send_payment_link_email
Emails the payment link to the customer. It accepts the name of a saved contact or an email address.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
link_url | string | yes | Payment link URL |
email | string | — | Recipient email |
contact_name | string | — | Name of the saved contact or of the customer |
amount | number | — | — |
currency | string | — | — |
description | string | — | — |
message | string | — | Additional note for the customer |
save_contact | boolean | — | Save the contact in the address book |
Returns
{ sent, to }
sent is true and to is the address it was sent to. When there is no email and no saved contact with that name, it returns an error asking for it.
Last verified: 2026-08-29 · Owner: equipo-integraciones