API Reference

Account Statement Notification

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.


KeyTypeDescriptionExample value
id_typeintThe notification type id. Takes the value of 3 for account statement notifications.3
notificationobjectThe notification’s payloadSee below for the schema

Notification object’s schema

KeyTypeDescriptionExample value
cards_summarylist of objectsA list of all cards that transacted in the periodSee below for the schema
customer_infoobjectGeneral customer informationSee below for the schema
period_transactionslist of objectsA list of all transactions done during the periodSee below for the schema
movement_summaryobjectAccumulated 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

KeyTypeDescriptionExample value
card_idintThe card’s unique identifier1
cardholder_namestringThe cardholder’s name“Omar Hernández”
card_typestring“physical” or “digital”“physical”
cumulative_paymentsintThe total amount of payments done using this card100000
cumulative_chargesintThe total amount of purchases done using this card100000

Customer Info Schema

KeyTypeDescriptionExample value
issuerstringThe ecommerce’s name“montajes”
statement_periodobjectInformation about the account statement’s periodSee below for the schema
cutoff_datestringThe new period’s final day“2025-09-14”
payment_due_datestringThe new period’s due date“2025-09-24”
account_holderobjectAccount holder informationSee below for schema
credit_detailsobjectInformation on amounts relevant to the account statementSee below for schema

Period Transactions Schema

KeyTypeDescriptionExample value
card_idintThe 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 balance2
amountintThe transaction’s amount10000
categorystringCan be “purchase” or “charge”“purchase”
narrativestringA description of the transaction’s origin or nature"USFUEL PRONTOGAS ZARCO CHIHUAHUA CHI MEX"
settlement_datestringDate the transaction was settled“2025-10-14”
foreign_currencyobjectContains 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

KeyTypeDescriptionExample value
min_due_paymentintThe minimum amount to pay before the next due date to avoid default interests10000
total_due_paymentintThe total amount to pay before the next due date to avoid all interests50000
average_daily_balanceintAverage principal debt per day in the period45000
cutoff_balanceintThe 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_balanceintThe previous period’s cutoff balance. Absent for the first period40000
period_paymentsintThe sum of payment transactions done in the period10000
period_purchasesintThe sum of purchase transactions done in the period10000
period_refundsintThe sum of refund transactions done in the period10000
period_withdrawalsintThe sum of cash withdrawals (e.g. at the ATM) done in the period10000
period_commissionintThe sum of commissions charged in the period10000
period_ordinary_interestintThe sum of ordinary interests charged during the account statement’s calculation10000
period_default_interestintThe sum of default interests charged during the account statement’s calculation10000
period_taxintThe sum of tax charged in the period10000
period_adjustmentsintThe sum of transaction adjustments done in the period10000

Period Transactions Foreign Currency Schema

KeyTypeDescriptionExample value
original_amountintThe transaction’s amount in its original currency’s smallest denomination, e.g. cents1000
original_currencystringThe original currency’s codeUSD

Customer Info Statement Period Schema

KeyTypeDescriptionExample value
start_datestringThe period’s first date2024-09-01
end_datestringThe period’s last date2024-10-01

Customer Info Account Holder Schema

KeyTypeDescriptionExample value
company_namestringThe company’s nameCoca-Cola
rfcstringThe company’s RFCAAA000101122

Customer Info Credit Details Schema

KeyTypeDescriptionExample value
credit_lineintThe parent balance’s credit line5000000
credit_limitintThe parent balance’s credit limit4500000
interest_rates_as_percentageobjectInformation on the rates used to calculate interestsSee below for the schema
cat_without_iva_as_percentagestring (numeric)The CAT (total annual cost) without value added tax, as a percentage"95.20"

Customer Info Credit Details Interest Rates Schema

KeyTypeDescriptionExample value
ordinarystring (numeric)Ordinary interest rate“23.00”
defaultstring (numeric)Default interest rate“35.00”