When the account statement runs, a notification with the schema below will be sent to an agreed-on endpoint. All money values are given in Mexican cents unless otherwise specified.
Key | Type | Description | Example value |
---|---|---|---|
id_type | int | The notification type id. Takes the value of 3 for account statement notifications. | 3 |
notification | object | The notification’s payload | See below for the schema |
Notification object’s schema
Key | Type | Description | Example value |
---|---|---|---|
cards_summary | list of objects | A list of all cards that transacted in the period | See below for the schema |
customer_info | object | General customer information | See below for the schema |
period_transactions | list of objects | A list of all transactions done during the period | See below for the schema |
movement_summary | object | Accumulated metrics derived from the period transactions, e.g. how much was purchased, paid in taxes, etc. | See below for the schema or |
Cards Summary Entry Schema
Key | Type | Description | Example value |
---|---|---|---|
card_id | int | The card’s unique identifier | 1 |
cardholder_name | string | The cardholder’s name | “Omar Hernández” |
card_type | string | “physical” or “digital” | “physical” |
cumulative_payments | int | The total amount of payments done using this card | 100000 |
cumulative_charges | int | The total amount of purchases done using this card | 100000 |
Customer Info Schema
Key | Type | Description | Example value |
---|---|---|---|
issuer | string | The ecommerce’s name | “montajes” |
statement_period | object | Information about the account statement’s period | See below for the schema |
cutoff_date | string | The new period’s final day | “2025-09-14” |
payment_due_date | string | The new period’s due date | “2025-09-24” |
account_holder | object | Account holder information | See below for schema |
credit_details | object | Information on amounts relevant to the account statement | See below for schema |
Period Transactions Schema
Key | Type | Description | Example value |
---|---|---|---|
card_id | int | The card’s unique identifier. Only present if the transaction involved a credit card. For example, this field is absent in payments done directly to a parent balance | 2 |
amount | int | The transaction’s amount | 10000 |
category | string | Can be “purchase” or “charge” | “purchase” |
narrative | string | A description of the transaction’s origin or nature | "USFUEL PRONTOGAS ZARCO CHIHUAHUA CHI MEX" |
settlement_date | string | Date the transaction was settled | “2025-10-14” |
foreign_currency | object | Contains currency exchange information. Only appears if the transaction was performed with a currency other than the Mexican Peso (MXN) | See below for the schema |
Movement Summary Schema
Key | Type | Description | Example value |
---|---|---|---|
min_due_payment | int | The minimum amount to pay before the next due date to avoid default interests | 10000 |
total_due_payment | int | The total amount to pay before the next due date to avoid all interests | 50000 |
average_daily_balance | int | Average principal debt per day in the period | 45000 |
cutoff_balance | int | The total amount to pay without deferred purchase amounts. If there are no deferred purchases, then this value equals the total_due_payment. | 50000 |
last_period_cutoff_balance | int | The previous period’s cutoff balance. Absent for the first period | 40000 |
period_payments | int | The sum of payment transactions done in the period | 10000 |
period_purchases | int | The sum of purchase transactions done in the period | 10000 |
period_refunds | int | The sum of refund transactions done in the period | 10000 |
period_withdrawals | int | The sum of cash withdrawals (e.g. at the ATM) done in the period | 10000 |
period_commission | int | The sum of commissions charged in the period | 10000 |
period_ordinary_interest | int | The sum of ordinary interests charged during the account statement’s calculation | 10000 |
period_default_interest | int | The sum of default interests charged during the account statement’s calculation | 10000 |
period_tax | int | The sum of tax charged in the period | 10000 |
period_adjustments | int | The sum of transaction adjustments done in the period | 10000 |
Period Transactions Foreign Currency Schema
Key | Type | Description | Example value |
---|---|---|---|
original_amount | int | The transaction’s amount in its original currency’s smallest denomination, e.g. cents | 1000 |
original_currency | string | The original currency’s code | USD |
Customer Info Statement Period Schema
Key | Type | Description | Example value |
---|---|---|---|
start_date | string | The period’s first date | 2024-09-01 |
end_date | string | The period’s last date | 2024-10-01 |
Customer Info Account Holder Schema
Key | Type | Description | Example value |
---|---|---|---|
company_name | string | The company’s name | Coca-Cola |
rfc | string | The company’s RFC | AAA000101122 |
Customer Info Credit Details Schema
Key | Type | Description | Example value |
---|---|---|---|
credit_line | int | The parent balance’s credit line | 5000000 |
credit_limit | int | The parent balance’s credit limit | 4500000 |
interest_rates_as_percentage | object | Information on the rates used to calculate interests | See below for the schema |
cat_without_iva_as_percentage | string (numeric) | The CAT (total annual cost) without value added tax, as a percentage | "95.20" |
Customer Info Credit Details Interest Rates Schema
Key | Type | Description | Example value |
---|---|---|---|
ordinary | string (numeric) | Ordinary interest rate | “23.00” |
default | string (numeric) | Default interest rate | “35.00” |