Payments Report

Get a detailed report of all processed payments.

Endpoint: GET /payments

Parameters:

  • year (required): Report year (e.g., 2025)
  • month (required): Report month (1-12)

Example request:

curl -X GET "https://services.digitalfemsa.io/reports/v1/payments?year=2025&month=10" \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.app-v2.1.0+json" \
  -H "Authorization: Bearer key_XXXXXXXXXXXXXX"

Expected response:

{
    "has_more": false,
    "total": 52,
    "object": "list",
    "data": [
        {
            "antifraud_code": "",
            "antifraud_decision": "",
            "auth_code": "",
            "bank": "",
            "banking_decision": "",
            "branch_office": "",
            "card_brand": "",
            "card_number": "",
            "card_type": "",
            "cardholder_name": "",
            "channel": "Checkout",
            "charge_amount": 55.1,
            "charge_id": "68e40186691ffa0016f5495b",
            "chargeback_date": null,
            "checkout_id": "",
            "checkout_request_id": "0696f1b0-14e9-4647-969b-9f852b39b737",
            "checkout_request_name": "Compra de Brandon Guadarrama",
            "checkout_request_type": "HostedPayment",
            "commission": null,
            "company_id": "5f90a9802238c00001b064dc",
            "country_card": "",
            "create_date": 1759773062879,
            "currency": "MXN",
            "customer_custom_reference": "",
            "customer_id": "",
            "deposit_amount": null,
            "deposit_date": null,
            "deposit_id": "",
            "deposit_reference": "",
            "description": "spin-2025.myshopify.com",
            "email": "[email protected]",
            "error_message": "",
            "exchange_rate": 1,
            "failure_code": "",
            "foreign_charge_amount": null,
            "foreign_currency": "",
            "invoice_id": "",
            "ip": "",
            "item_description": "",
            "item_name": "spin-2025.myshopify.com",
            "livemode": true,
            "metadata": "{\"store\":\"spin-2025.myshopify.com\",\"app_version\":\"1.0.3\",\"plugin\":\"Spin...",
            "payment_method": "card",
            "payment_type": "charge",
            "status": "paid",
            "transaction_id": "68e40186791ffa0016f5495e"
        }
    ]
}