Settlements, deposits and billing

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

{ next_settlement, commerce, accumulated_balance, accumulated_balance_details }

next_settlement = next settlement; commerce = merchant data with the masked IBAN; accumulated_balance = [{ total, currency }]; accumulated_balance_details = the detail.

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

Returns

tilopay_settlement_transactions

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

Parameters

Returns

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

Returns

tilopay_deposit_detail

Detail of a security deposit (id from tilopay_deposits_list).

Parameters

Returns

tilopay_deposit_extend

Extends a security deposit authorization, owner only. Requires a 6-digit email code, but confirmation_code is not declared in the schema: the two-call flow is completed through the WhatsApp Assistant.

Parameters

Returns

After authorization, the extension data returned by Tilopay.

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

Returns