Payments Report

Get a detailed report of all processed payments. Supports pagination and rich filtering.

Endpoint: GET /payments

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	1234567890abcdefghijk
size	No	number	Cantidad de registros por página	Por defecto es 100. Mínimo 1 Máximo 1000
from	No	number (ms)	Timestamp inicial (UTC ms)	1759276800000 Por defecto se toman los últimos 31 días
to	No	number (ms)	Timestamp final (UTC ms)	1762408800000 Por defecto se toman los últimos 31 días.
year	No	number	Año del reporte	2025
month	No	number	Mes del reporte (1-12)	10
amount_from	No	number	Monto mínimo a filtrar	200
amount_to	No	number	Monto máximo a filtrar	2000
sort	No	string	Ordenamiento: `asc` o `desc`	asc
payment_method	No	string	Método de pago. Opciones: `CreditCardPayment`, `SpeiPayment`, `CashPayment`, `BanortePayment`, `BnplPayment`	CashPayment
status	No	string	Estado. Opciones: `expired`, `paid`, `canceled`, `pending_payment`, `refunded`, `voided`, `charged_back`, `partially_refunded`, `reversed`, `pre_authorized`, `pending_confirmation`, `under_review`	paid
field	No	string	Campos a filtrar (separados por coma)	status,bank
customer_id	No	string	Filtro por ID de cliente	cust_123

Example request:

curl -X GET "https://services.digitalfemsa.io/reports/v1/payments?year=2025&month=10&from=1759276800000&to=1762408800000&size=1&next_page_url=1234567890abcdefghijk" \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.app-v2.1.0+json" \
  -H "Authorization: Bearer <your_api_key>"

Response (example):

{
  "next_page_url": "https://services.digitalfemsa.io/reports/v1/payments?from=1759276800000&month=10&next_page_url=1234567890abcdefghijk&size=1&to=1762408800000&year=2025",
  "has_more": true,
  "total": 57,
  "object": "list",
  "data": [
    {
      "antifraud_code": "",
      "antifraud_decision": "",
      "auth_code": "",
      "bank": "",
      "banking_decision": "",
      "branch_office": "",
      "card_brand": "",
      "card_number": "",
      "card_type": "",
      "cardholder_name": "",
      "channel": "",
      "charge_amount": 90,
      "charge_id": "68e5505c2997c500158019e123456",
      "chargeback_date": null,
      "checkout_id": "",
      "checkout_request_id": "",
      "checkout_request_name": "",
      "checkout_request_type": "",
      "commission": null,
      "company_id": "5f90a9802238c0000123456",
      "country_card": "",
      "create_date": 1759858780410,
      "currency": "MXN",
      "customer_custom_reference": "",
      "customer_id": "",
      "deposit_amount": null,
      "deposit_date": null,
      "deposit_id": "",
      "deposit_reference": "",
      "description": "Vintage Typewriter",
      "email": "[email protected]",
      "error_message": "",
      "exchange_rate": 1,
      "failure_code": "",
      "foreign_charge_amount": null,
      "foreign_currency": "",
      "invoice_id": "",
      "ip": "",
      "item_description": "",
      "item_name": "Vintage Typewriter",
      "livemode": true,
      "metadata": "{\"woocommerce_version\":\"10.2.2\",\"reference_id\":69,\"plugin\":\"woocommerce\",\"plugin_spin_version\":\"1.0.2\",\"payment_method\":\"Spin_Block_Gateway\"}",
      "monthly_installments": null,
      "name": "Uriel Perez",
      "order_id": "ord_123456789abcde",
      "partial": false,
      "pay_date": null,
      "payment_cash": "OxxoPay",
      "payment_method": "OxxoPayment",
      "payment_type": "",
      "phone": "",
      "receiving_account_number": "",
      "reference_id": "69",
      "reference_oxxo": "12345678901234",
      "refund_date": null,
      "shipping_address": "Brisas de Florida aaaaaaa, aaaaaaa, Temixco, mx, 62584",
      "status": "expired",
      "store": "",
      "subscription_id": "",
      "transaction_id": "",
      "transaction_type": "",
      "type": ""
    }
  ]
}