Skip to main content
GET
/
master-entities
/
{master_entity_id}
/
settlements
Listar liquidaciones
curl --request GET \
  --url https://api.tupana.ai/v1/master-entities/{master_entity_id}/settlements/ \
  --header 'Authorization: <api-key>'
{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "settlement_id": 1042,
      "period_date": "2026-04-30",
      "status": "paid",
      "gross_total": "150000.00",
      "commission_total": "3570.00",
      "net_total": "146430.00",
      "paid_at": "2026-05-02T15:00:00+00:00"
    }
  ]
}

​
¿Para qué se usa?

Obtiene la lista paginada de liquidaciones (payouts) del destinatario: cada liquidación agrupa los cobros con tarjeta de un período y representa el monto neto que se depositó (o se va a depositar) al destinatario.

​
Qué hace

  • Retorna las liquidaciones del destinatario ordenadas por fecha de payout descendente (más reciente primero).
  • Incluye totales por liquidación: bruto cobrado, comisión total (base + IVA) y neto a depositar.
  • Pagina con page (1-indexed) y page_size (default 25, máximo 100).

​
Estados

EstadoSignificado
pendingLa liquidación está generada pero el depósito al banco del destinatario aún no se ejecuta.
paidEl depósito al destinatario está confirmado. paid_at indica cuándo.
failedEl depósito falló. Contactar a soporte si ocurre.

​
Consideraciones importantes

​
Comisión

La comisión es 2% sobre el bruto de cada cobro, más 19% de IVA sobre esa comisión. Se calcula por item y luego se agrega, con redondeo hacia abajo sin decimales por item.

​
Scope por API Key

La API Key debe pertenecer a un usuario con acceso a la master entity indicada en la URL. Si no, el endpoint responde 403.

Authorizations

​
Authorization
string
header
required

API Key para autenticación. Formato: Api-Key YOUR-API-KEY

Path Parameters

​
master_entity_id
integer
required

ID del destinatario (MasterEntity).

Query Parameters

​
page
integer

Número de página (1-indexed). Por defecto: 1.

Required range: x >= 1
​
page_size
integer

Tamaño de página. Por defecto: 25, máximo: 100.

Required range: 1 <= x <= 100

Response

Lista paginada de liquidaciones

​
count
integer
Example:

1

​
next
string | null
Example:

null

​
previous
string | null
Example:

null

​
results
object[]