Settlements, deposits and billing

Write

What it covers#

This group covers the money Tilopay settles to you: the pending balance and the date of the next deposit, already processed settlements with their transactions, security deposits (pre-authorizations held on customers) and the invoices Tilopay issues for using the platform. Everything is read-only except extending a security deposit, which requires a six-digit code sent by email.

Tools#

Next settlement and balance to settle

Read only

tilopay_settlement_balance

OFFICIAL Tilopay data: date of the next deposit (next_settlement), settlement frequency, destination IBAN account and, per currency, the accumulated pending balance with its breakdown (subtotal, commission, iva_commission, retention, retention_iva, cost, iva_tilopay, transfer, transfer_iva, net total).

Parameters

No parameters.

Returns

Settlement history

Read only

tilopay_settlements_list

Settlements already processed by Tilopay: deposit date (date_to_report), period, gross amount, deductions and total transferred. Use it for 'did they deposit Friday's money yet?' or 'how much did they deposit last month?'.

Parameters

ParameterTypeRequiredDescription
pageinteger—Página (por defecto 1)
limitinteger—Registros por página (por defecto 20)
searchstring—Texto a buscar

Returns

Transactions of a settlement

Read only

tilopay_settlement_transactions

Transactions included in an already processed settlement (id obtained from tilopay_settlements_list).

Parameters

ParameterTypeRequiredDescription
settlement_idstringyesId de la liquidación

Returns

Security deposits (pre-authorizations)

Read only

tilopay_deposits_list

Security deposits or pre-authorizations held on customers (car rental, hospitality, security deposits): amount, status and expiration. Not to be confused with settlements.

Parameters

ParameterTypeRequiredDescription
pageinteger—Página (por defecto 1)
limitinteger—Registros por página (por defecto 20)
searchstring—Texto a buscar

Returns

Detail of a security deposit

Read only

tilopay_deposit_detail

Detail of a security deposit (id from tilopay_deposits_list).

Parameters

ParameterTypeRequiredDescription
deposit_idstringyesId del depósito

Returns

Extend a security deposit

Write

tilopay_deposit_extend

Extends the validity of the authorization of a security deposit. Requires the six-digit code sent by email.

Parameters

ParameterTypeRequiredDescription
deposit_idstringyesId del depósito

Returns

Tilopay service invoices

Read only

tilopay_billing_list

Invoices Tilopay issues to the merchant for using the platform (they are not the merchant's sales). Use it for 'how much did Tilopay charge me this month?' or 'where is my Tilopay invoice?'.

Parameters

ParameterTypeRequiredDescription
pageinteger—Página (por defecto 1)
limitinteger—Registros por página (por defecto 20)
searchstring—Texto a buscar

Returns

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

View as raw Markdown