Deposit Report

Get a report of deposits made for a given month. Supports pagination.

Endpoint: GET /deposits

Authorization:

Nombre	Tipo	Descripción
Authorization	Basic	Se utiliza la auth que maneja OXXO pay.

Parameters:

Nombre	Obligatorio	Tipo	Descripción	Ejemplo
next_page_url	No	string	Cursor de paginación devuelto por la respuesta previa	1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1
size	No	int	Number of records per pag	Por defecto es 100. Mínimo 1 Máximo 1000
from	No	number (ms)	Timestamp inicial (UTC ms) Fecha desde que se tiene que buscar.	1661220000000 Por defecto se toman los últimos 31 días
to	No	number (ms)	Timestamp final (UTC ms) Fecha hasta que se tiene que buscar.	1661220000000 Por defecto se toman los últimos 31 días
year	Sí	number	Año del reporte	2025
month	Sí	number	Mes del reporte (1-12)	10
field	No	string	Campos a filtrar (separados por coma)	id,status

Example request:

curl -X GET "https://services.digitalfemsa.io/reports/v1/deposits?year=2025&month=10&size=3&next_page_url=1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1" \
  -H "Authorization: Bearer <your_api_key>"

Response (example):

{
  "next_page_url": "https://services.digitalfemsa.io/reports/v1/deposits?month=10&next_page_url=1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1&size=3&year=2025",
  "has_more": true,
  "total": 23,
  "object": "list",
  "data": [
    {
      "company_id": "680012600b1234567abcdef",
      "create_at": 1759305082799,
      "deposit_amount": 76491.69,
      "deposit_details": [
        { "Concept": "AllTransactions", "amount": 79344.93, "commission": 2853.24, "net": 76491.69 },
        { "Concept": "Capture",         "amount": 79344.93, "commission": 2853.24, "net": 76491.69 },
        { "Concept": "Chargeback",      "amount": null,     "commission": null,    "net": 76491.69 }
      ],
      "deposit_reference": "8244224",
      "id": "123456789abcdefghi",
      "status": "paid_out",
      "transaction_id": "123456789abcdefgghi",
      "transferred_at": 1759305083192
    }
  ]
}