Sample XML Payloads for Events in the Financial Transactions Class
The Financial Transactions Event Class is a category of event notifications within the Aria Systems platform that focuses on financial transactions associated with an account. This article includes examples of XML payloads for a few different use cases.
Disclaimer: The data included below may not represent real-world data (e.g. account numbers, event numbers). Consult the related event list and real data in your Aria application when testing.
Use Case 1: New Payment Transaction Event
This payload represents a notification triggered by a new payment being added to an account, including financial transaction details and related invoice information.
<apf2doc xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<request>
<version>3.5</version>
<sender>A</sender>
<transaction_id>100001234</transaction_id>
<!-- A = add/new transaction -->
<action>A</action>
<!-- T = financial transaction class -->
<class>T</class>
<auth_key>CLIENT-AUTH-KEY-123</auth_key>
<client_receipt_id>RCPT-20260108-0001</client_receipt_id>
</request>
<account>
<client_no>12345</client_no>
<acct_no>987654321</acct_no>
<client_acct_id>CUST-000123</client_acct_id>
<userid>user_123@example.com</userid>
<senior_acct_no>987650000</senior_acct_no>
<master_plan_instances>
<master_plan_instance_data>
<plan_instance_no>555001</plan_instance_no>
<client_plan_instance_id>PLAN-MAIN-001</client_plan_instance_id>
<resp_level_cd>A</resp_level_cd>
<resp_plan_instance_no>555001</resp_plan_instance_no>
</master_plan_instance_data>
</master_plan_instances>
</account>
<financial_transaction_groups>
<financial_transaction_group>
<object_type>ACCT</object_type>
<object_no>987654321</object_no>
<billing_group_no>1001</billing_group_no>
<billing_group_name>Default Billing Group</billing_group_name>
<client_billing_group_id>BG-DEFAULT</client_billing_group_id>
<!-- Total of the payment transaction(s) in this group -->
<total_amount>-50.00</total_amount>
</financial_transaction_group>
</financial_transaction_groups>
<financial_transactions>
<financial_transaction>
<!-- Optional high-level transaction id -->
<financial_trans_id>200000567</financial_trans_id>
<!-- Required granular id -->
<financial_trans_granular_id>20000056701</financial_trans_granular_id>
<!-- Example payment type code -->
<financial_trans_type_no>3001</financial_trans_type_no>
<financial_trans_type_label>Payment</financial_trans_type_label>
<!-- Example GL mapping for payment -->
<financial_trans_gl_type>PAYMENT</financial_trans_gl_type>
<financial_trans_date>2026-01-08T10:25:00</financial_trans_date>
<!-- Payments often represented as negative amounts (credit to account) -->
<financial_trans_amount>-50.00</financial_trans_amount>
<financial_trans_status_label>Posted</financial_trans_status_label>
<financial_trans_status_desc>Payment successfully applied</financial_trans_status_desc>
<financial_trans_client_notes>Payment via credit card</financial_trans_client_notes>
<financial_trans_applied_amount>-50.00</financial_trans_applied_amount>
<financial_trans_inv_type_cd>REG</financial_trans_inv_type_cd>
<!-- No failed_payment_charge_data for a successful new payment -->
<financial_trans_appln_data>
<financial_trans_application>
<!-- Charge transaction that this payment is applied to -->
<charge_trans_id>190000999</charge_trans_id>
<!-- The payment transaction providing funds -->
<payment_trans_id>200000567</payment_trans_id>
<applied_amount>-50.00</applied_amount>
<!-- The same charge or a related transaction receiving the application -->
<applied_trans_id>190000999</applied_trans_id>
<applied_trans_type_no>1001</applied_trans_type_no>
<applied_trans_type_label>Invoice Charge</applied_trans_type_label>
<charge_trans_type_no>1001</charge_trans_type_no>
<charge_trans_type_label>Invoice Charge</charge_trans_type_label>
<invoice_no>5550001</invoice_no>
<sequential_statement_id>STMT-000045</sequential_statement_id>
</financial_trans_application>
</financial_trans_appln_data>
<!-- No unapplied portion in this example -->
<financial_trans_unappln_data>
<!-- Intentionally left with no financial_trans_unapplication child for fully applied payment -->
</financial_trans_unappln_data>
<!-- No future manual allocation in this example -->
<future_manual_allocation></future_manual_allocation>
</financial_transaction>
</financial_transactions>
<posting_info>
<posting_status_cd>1</posting_status_cd>
<posting_user>system_posting_job</posting_user>
<posting_date>2026-01-08T10:26:00</posting_date>
</posting_info>
<invoice>
<invoice_no>5550001</invoice_no>
<invoice_type_cd>REG</invoice_type_cd>
<threshold_billing_rule>
<threshold_billing_rule_no>9001</threshold_billing_rule_no>
<client_threshold_billing_rule_id>THRESH-USD-50</client_threshold_billing_rule_id>
<currency_amount>50.00</currency_amount>
</threshold_billing_rule>
</invoice>
<event_data>
<event>
<!-- Example event id for a new payment transaction -->
<event_id>3101</event_id>
<event_label>New Payment Transaction</event_label>
</event>
</event_data>
</apf2doc>
Use Case 2: Modified Transaction Event
This payload represents a notification triggered by a modification to an existing transaction (e.g., updating the posting status), including posting information and multiple financial transactions.
<apf2doc xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<request>
<!-- Version fixed to 3.5 in the XSD -->
<version>3.5</version>
<!-- A = Aria, C = Client; outbound is effectively A -->
<sender>A</sender>
<!-- Unique provisioning request id -->
<transaction_id>100001235</transaction_id>
<!-- M = modify -->
<action>M</action>
<!-- T = financial transaction class -->
<class>T</class>
<!-- Optional auth and client receipt -->
<auth_key>CLIENT-AUTH-KEY-123</auth_key>
<client_receipt_id>RCPT-20260108-0002</client_receipt_id>
</request>
<account>
<client_no>12345</client_no>
<acct_no>987654321</acct_no>
<client_acct_id>CUST-000123</client_acct_id>
<userid>user_123@example.com</userid>
<senior_acct_no>987650000</senior_acct_no>
<master_plan_instances>
<master_plan_instance_data>
<plan_instance_no>555001</plan_instance_no>
<client_plan_instance_id>PLAN-MAIN-001</client_plan_instance_id>
<resp_level_cd>A</resp_level_cd>
<resp_plan_instance_no>555001</resp_plan_instance_no>
</master_plan_instance_data>
</master_plan_instances>
</account>
<financial_transaction_groups>
<financial_transaction_group>
<object_type>ACCT</object_type>
<object_no>987654321</object_no>
<billing_group_no>1001</billing_group_no>
<billing_group_name>Default Billing Group</billing_group_name>
<client_billing_group_id>BG-DEFAULT</client_billing_group_id>
<!-- Total after modification (for example, reduced payment amount) -->
<total_amount>-40.00</total_amount>
</financial_transaction_group>
</financial_transaction_groups>
<financial_transactions>
<financial_transaction>
<!-- Same original transaction id being modified -->
<financial_trans_id>200000567</financial_trans_id>
<!-- Same granular id, now representing the modified state -->
<financial_trans_granular_id>20000056701</financial_trans_granular_id>
<financial_trans_type_no>3001</financial_trans_type_no>
<financial_trans_type_label>Payment</financial_trans_type_label>
<financial_trans_gl_type>PAYMENT</financial_trans_gl_type>
<!-- Modification date/time -->
<financial_trans_date>2026-01-08T11:05:00</financial_trans_date>
<!-- Payment amount changed from -50.00 to -40.00 -->
<financial_trans_amount>-40.00</financial_trans_amount>
<financial_trans_status_label>Adjusted</financial_trans_status_label>
<financial_trans_status_desc>Payment adjusted after reconciliation</financial_trans_status_desc>
<financial_trans_client_notes>Payment reduced due to dispute resolution</financial_trans_client_notes>
<!-- Applied amount also adjusted -->
<financial_trans_applied_amount>-40.00</financial_trans_applied_amount>
<financial_trans_inv_type_cd>REG</financial_trans_inv_type_cd>
<!-- No failed payment data; this is a successful payment modification -->
<!-- failed_payment_charge_data omitted -->
<!-- Application data reflecting new applied amount -->
<financial_trans_appln_data>
<financial_trans_application>
<charge_trans_id>190000999</charge_trans_id>
<payment_trans_id>200000567</payment_trans_id>
<!-- Adjusted applied amount -->
<applied_amount>-40.00</applied_amount>
<applied_trans_id>190000999</applied_trans_id>
<applied_trans_type_no>1001</applied_trans_type_no>
<applied_trans_type_label>Invoice Charge</applied_trans_type_label>
<charge_trans_type_no>1001</charge_trans_type_no>
<charge_trans_type_label>Invoice Charge</charge_trans_type_label>
<invoice_no>5550001</invoice_no>
<sequential_statement_id>STMT-000045</sequential_statement_id>
</financial_trans_application>
</financial_trans_appln_data>
<!-- Unapplication data showing that 10.00 was unapplied from the original 50.00 -->
<financial_trans_unappln_data>
<financial_trans_unapplication>
<charge_trans_id>190000999</charge_trans_id>
<!-- Positive magnitude for the amount removed from the previous application -->
<unapplied_amount>10.00</unapplied_amount>
<charge_trans_type_no>1001</charge_trans_type_no>
<charge_trans_type_label>Invoice Charge</charge_trans_type_label>
<invoice_no>5550001</invoice_no>
<sequential_statement_id>STMT-000045</sequential_statement_id>
</financial_trans_unapplication>
</financial_trans_unappln_data>
<!-- No remaining amount for future manual allocation in this example -->
<future_manual_allocation></future_manual_allocation>
</financial_transaction>
</financial_transactions>
<posting_info>
<posting_status_cd>1</posting_status_cd>
<posting_user>system_adjustment_job</posting_user>
<posting_date>2026-01-08T11:06:00</posting_date>
</posting_info>
<invoice>
<invoice_no>5550001</invoice_no>
<invoice_type_cd>REG</invoice_type_cd>
<threshold_billing_rule>
<threshold_billing_rule_no>9001</threshold_billing_rule_no>
<client_threshold_billing_rule_id>THRESH-USD-50</client_threshold_billing_rule_id>
<currency_amount>50.00</currency_amount>
</threshold_billing_rule>
</invoice>
<event_data>
<event>
<!-- Example event id to represent a modified transaction -->
<event_id>3102</event_id>
<event_label>Modified Transaction</event_label>
</event>
</event_data>
</apf2doc>
Use Case 3: Electronic Payment Application
This XML payload represents an electronic payment application event.
<apf2doc xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<request>
<!-- Version is fixed at 3.5 in the schema -->
<version>3.5</version>
<!-- Outbound from Aria -->
<sender>A</sender>
<!-- Unique provisioning request id -->
<transaction_id>100001240</transaction_id>
<!-- A = add (new application of a payment) -->
<action>A</action>
<!-- T = financial transaction class -->
<class>T</class>
<!-- Optional authentication and receipt fields -->
<auth_key>CLIENT-AUTH-KEY-123</auth_key>
<client_receipt_id>RCPT-20260108-EPAY-0001</client_receipt_id>
</request>
<account>
<client_no>12345</client_no>
<acct_no>987654321</acct_no>
<client_acct_id>CUST-000123</client_acct_id>
<userid>user_123@example.com</userid>
<senior_acct_no>987650000</senior_acct_no>
<master_plan_instances>
<master_plan_instance_data>
<plan_instance_no>555001</plan_instance_no>
<client_plan_instance_id>PLAN-MAIN-001</client_plan_instance_id>
<resp_level_cd>A</resp_level_cd>
<resp_plan_instance_no>555001</resp_plan_instance_no>
</master_plan_instance_data>
</master_plan_instances>
</account>
<financial_transaction_groups>
<financial_transaction_group>
<!-- Application is at the account level in this example -->
<object_type>ACCT</object_type>
<object_no>987654321</object_no>
<billing_group_no>1001</billing_group_no>
<billing_group_name>Default Billing Group</billing_group_name>
<client_billing_group_id>BG-DEFAULT</client_billing_group_id>
<!-- Total payment amount being applied -->
<total_amount>-75.00</total_amount>
</financial_transaction_group>
</financial_transaction_groups>
<financial_transactions>
<financial_transaction>
<!-- Payment transaction already exists in Aria; this event reflects its application -->
<financial_trans_id>300000111</financial_trans_id>
<financial_trans_granular_id>30000011101</financial_trans_granular_id>
<!-- Example transaction type for an electronic payment -->
<financial_trans_type_no>3002</financial_trans_type_no>
<financial_trans_type_label>Electronic Payment</financial_trans_type_label>
<financial_trans_gl_type>PAYMENT</financial_trans_gl_type>
<!-- Date/time of the electronic payment posting/application -->
<financial_trans_date>2026-01-08T10:45:00</financial_trans_date>
<!-- Total payment amount; usually negative (credit) -->
<financial_trans_amount>-75.00</financial_trans_amount>
<financial_trans_status_label>Posted</financial_trans_status_label>
<financial_trans_status_desc>Electronic payment applied to open invoices</financial_trans_status_desc>
<financial_trans_client_notes>Electronic payment via credit card gateway</financial_trans_client_notes>
<!-- Entire payment amount is applied in this example -->
<financial_trans_applied_amount>-75.00</financial_trans_applied_amount>
<financial_trans_inv_type_cd>REG</financial_trans_inv_type_cd>
<!-- No failed payment data for a successful electronic payment -->
<!-- Application details: payment is applied to two different invoice charges -->
<financial_trans_appln_data>
<!-- First application: main invoice -->
<financial_trans_application>
<!-- Charge transaction being paid -->
<charge_trans_id>210000900</charge_trans_id>
<!-- Payment transaction providing the funds -->
<payment_trans_id>300000111</payment_trans_id>
<!-- Amount applied to this charge -->
<applied_amount>-50.00</applied_amount>
<!-- Receiving transaction (often same as charge_trans_id) -->
<applied_trans_id>210000900</applied_trans_id>
<applied_trans_type_no>1001</applied_trans_type_no>
<applied_trans_type_label>Invoice Charge</applied_trans_type_label>
<charge_trans_type_no>1001</charge_trans_type_no>
<charge_trans_type_label>Invoice Charge</charge_trans_type_label>
<!-- Invoice reference for this application -->
<invoice_no>6000100</invoice_no>
<sequential_statement_id>STMT-000050</sequential_statement_id>
</financial_trans_application>
<!-- Second application: another open invoice or charge -->
<financial_trans_application>
<charge_trans_id>210000901</charge_trans_id>
<payment_trans_id>300000111</payment_trans_id>
<!-- Remaining amount applied to a second charge -->
<applied_amount>-25.00</applied_amount>
<applied_trans_id>210000901</applied_trans_id>
<applied_trans_type_no>1001</applied_trans_type_no>
<applied_trans_type_label>Invoice Charge</applied_trans_type_label>
<charge_trans_type_no>1001</charge_trans_type_no>
<charge_trans_type_label>Invoice Charge</charge_trans_type_label>
<invoice_no>6000101</invoice_no>
<sequential_statement_id>STMT-000051</sequential_statement_id>
</financial_trans_application>
</financial_trans_appln_data>
<!-- No unapplied portion in this example; payment is fully allocated -->
<financial_trans_unappln_data>
<!-- No financial_trans_unapplication children for a fully applied payment -->
</financial_trans_unappln_data>
<!-- No future manual allocation since nothing remains unapplied -->
<future_manual_allocation></future_manual_allocation>
</financial_transaction>
</financial_transactions>
<posting_info>
<posting_status_cd>1</posting_status_cd>
<posting_user>epay_gateway_job</posting_user>
<posting_date>2026-01-08T10:46:00</posting_date>
</posting_info>
<!-- Example primary invoice referenced in the first application; the second could be represented similarly or left implicit -->
<invoice>
<invoice_no>6000100</invoice_no>
<invoice_type_cd>REG</invoice_type_cd>
<threshold_billing_rule>
<threshold_billing_rule_no>9001</threshold_billing_rule_no>
<client_threshold_billing_rule_id>THRESH-USD-50</client_threshold_billing_rule_id>
<currency_amount>50.00</currency_amount>
</threshold_billing_rule>
</invoice>
<event_data>
<event>
<!-- Example event id for an electronic payment application -->
<event_id>3201</event_id>
<event_label>Electronic Payment Application</event_label>
</event>
</event_data>
</apf2doc>
Use Case 4: External Payment Unapplication
This XML payload represents an external payment unapplication event.
<apf2doc xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<request>
<!-- Version fixed in XSD -->
<version>3.5</version>
<!-- Outbound notification from Aria -->
<sender>A</sender>
<!-- Unique provisioning request id for this unapplication event -->
<transaction_id>100001245</transaction_id>
<!-- M = modify (changing how a payment is applied) -->
<action>M</action>
<!-- T = financial transaction class -->
<class>T</class>
<!-- Optional authentication and correlation fields -->
<auth_key>CLIENT-AUTH-KEY-123</auth_key>
<client_receipt_id>RCPT-20260108-EXT-UNAPPL-0001</client_receipt_id>
</request>
<account>
<client_no>12345</client_no>
<acct_no>987654321</acct_no>
<client_acct_id>CUST-000123</client_acct_id>
<userid>user_123@example.com</userid>
<senior_acct_no>987650000</senior_acct_no>
<master_plan_instances>
<master_plan_instance_data>
<plan_instance_no>555001</plan_instance_no>
<client_plan_instance_id>PLAN-MAIN-001</client_plan_instance_id>
<resp_level_cd>A</resp_level_cd>
<resp_plan_instance_no>555001</resp_plan_instance_no>
</master_plan_instance_data>
</master_plan_instances>
</account>
<financial_transaction_groups>
<financial_transaction_group>
<!-- Unapplication at the account level -->
<object_type>ACCT</object_type>
<object_no>987654321</object_no>
<billing_group_no>1001</billing_group_no>
<billing_group_name>Default Billing Group</billing_group_name>
<client_billing_group_id>BG-DEFAULT</client_billing_group_id>
<!-- Net impact to the group; here, 20.00 is being unapplied from a prior external payment -->
<total_amount>-80.00</total_amount>
</financial_transaction_group>
</financial_transaction_groups>
<financial_transactions>
<financial_transaction>
<!-- Existing external payment transaction whose application is being changed -->
<financial_trans_id>400000200</financial_trans_id>
<financial_trans_granular_id>40000020001</financial_trans_granular_id>
<!-- Example type code for an external payment -->
<financial_trans_type_no>3003</financial_trans_type_no>
<financial_trans_type_label>External Payment</financial_trans_type_label>
<financial_trans_gl_type>PAYMENT</financial_trans_gl_type>
<!-- Time of the unapplication update -->
<financial_trans_date>2026-01-08T11:30:00</financial_trans_date>
<!-- Original payment amount was -100.00; after unapplication, only -80.00 remains applied -->
<financial_trans_amount>-100.00</financial_trans_amount>
<financial_trans_status_label>Partially Unapplied</financial_trans_status_label>
<financial_trans_status_desc>External payment partially unapplied from invoice</financial_trans_status_desc>
<financial_trans_client_notes>External payment unapplication requested by gateway</financial_trans_client_notes>
<!-- Now only -80.00 remains applied -->
<financial_trans_applied_amount>-80.00</financial_trans_applied_amount>
<financial_trans_inv_type_cd>REG</financial_trans_inv_type_cd>
<!-- No failed payment data for this scenario -->
<!-- Current applications: remaining applied portion of the external payment -->
<financial_trans_appln_data>
<financial_trans_application>
<!-- Charge still being paid after unapplication -->
<charge_trans_id>220001000</charge_trans_id>
<!-- External payment providing funds -->
<payment_trans_id>400000200</payment_trans_id>
<!-- Remaining applied amount after unapplication -->
<applied_amount>-80.00</applied_amount>
<applied_trans_id>220001000</applied_trans_id>
<applied_trans_type_no>1001</applied_trans_type_no>
<applied_trans_type_label>Invoice Charge</applied_trans_type_label>
<charge_trans_type_no>1001</charge_trans_type_no>
<charge_trans_type_label>Invoice Charge</charge_trans_type_label>
<invoice_no>6100200</invoice_no>
<sequential_statement_id>STMT-000060</sequential_statement_id>
</financial_trans_application>
</financial_trans_appln_data>
<!-- Unapplication details: portion of the payment removed from a prior application -->
<financial_trans_unappln_data>
<financial_trans_unapplication>
<!-- Charge from which the external payment is being unapplied -->
<charge_trans_id>220001000</charge_trans_id>
<!-- Amount unapplied from the charge; positive numeric magnitude -->
<unapplied_amount>20.00</unapplied_amount>
<charge_trans_type_no>1001</charge_trans_type_no>
<charge_trans_type_label>Invoice Charge</charge_trans_type_label>
<invoice_no>6100200</invoice_no>
<sequential_statement_id>STMT-000060</sequential_statement_id>
</financial_trans_unapplication>
</financial_trans_unappln_data>
<!-- Remaining 20.00 will be reallocated manually or by future events -->
<future_manual_allocation>Remaining 20.00 to be reallocated to other open items</future_manual_allocation>
</financial_transaction>
</financial_transactions>
<posting_info>
<posting_status_cd>1</posting_status_cd>
<posting_user>external_unappl_job</posting_user>
<posting_date>2026-01-08T11:31:00</posting_date>
</posting_info>
<invoice>
<invoice_no>6100200</invoice_no>
<invoice_type_cd>REG</invoice_type_cd>
<threshold_billing_rule>
<threshold_billing_rule_no>9001</threshold_billing_rule_no>
<client_threshold_billing_rule_id>THRESH-USD-50</client_threshold_billing_rule_id>
<currency_amount>50.00</currency_amount>
</threshold_billing_rule>
</invoice>
<event_data>
<event>
<!-- Example event id to represent an external payment unapplication -->
<event_id>3301</event_id>
<event_label>External Payment Unapplication</event_label>
</event>
</event_data>
</apf2doc>
Use Case 5: Failed Payment Collection
Below is a concrete example XML payload for a Failed Collection event for an installment payment (using a generic “Failed Payment Collection” financial transaction and including installment-related fields in <failed_payment_charge_data>).
<apf2doc xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<request>
<version>3.6</version>
<sender>A</sender>
<transaction_id>123456</transaction_id>
<action>M</action>
<class>T</class>
<auth_key>CLIENT-AUTH-KEY-123</auth_key>
<client_receipt_id>RCPT-987654321</client_receipt_id>
</request>
<account>
<client_no>10001</client_no>
<acct_no>20002</acct_no>
<client_acct_id>ACCT-EXT-20002</client_acct_id>
<userid>jdoe@example.com</userid>
<senior_acct_no>0</senior_acct_no>
<master_plan_instances>
<master_plan_instance_data>
<plan_instance_no>30003</plan_instance_no>
<client_plan_instance_id>MPI-30003</client_plan_instance_id>
<resp_level_cd>A</resp_level_cd>
<resp_plan_instance_no>30003</resp_plan_instance_no>
</master_plan_instance_data>
</master_plan_instances>
</account>
<financial_transaction_groups>
<financial_transaction_group>
<object_type>MPI</object_type>
<object_no>30003</object_no>
<billing_group_no>1</billing_group_no>
<billing_group_name>Default Billing Group</billing_group_name>
<client_billing_group_id>BG-DEFAULT</client_billing_group_id>
<total_amount>50.00</total_amount>
</financial_transaction_group>
</financial_transaction_groups>
<financial_transactions>
<financial_transaction>
<financial_trans_id>555001</financial_trans_id>
<financial_trans_granular_id>55500101</financial_trans_granular_id>
<!-- Example type for failed collection; use your real value -->
<financial_trans_type_no>947</financial_trans_type_no>
<financial_trans_type_label>Failed Payment Collection</financial_trans_type_label>
<financial_trans_gl_type>CASH</financial_trans_gl_type>
<financial_trans_date>2026-02-10T13:45:00</financial_trans_date>
<financial_trans_user>system</financial_trans_user>
<financial_trans_amount>50.00</financial_trans_amount>
<financial_trans_status_label>Failed</financial_trans_status_label>
<financial_trans_status_desc>Collection attempt declined by processor</financial_trans_status_desc>
<financial_trans_client_notes>Installment 2 of 6 failed for payment plan PP-1001</financial_trans_client_notes>
<financial_trans_applied_amount>0.00</financial_trans_applied_amount>
<financial_trans_inv_type_cd>REG</financial_trans_inv_type_cd>
<!-- Installment-related data for the failed collection -->
<failed_payment_charge_data>
<failed_payment_charge_events>
<charge_event_no>700001</charge_event_no>
<invoice_no>800001</invoice_no>
<statement_no>900001</statement_no>
<sequential_statement_id>STMT-2026-02-01-0001</sequential_statement_id>
<installment_no>2</installment_no>
<client_installment_term_id>TERM-12MO-PLAN</client_installment_term_id>
<payment_plan_no>600001</payment_plan_no>
<client_payment_plan_id>PP-1001</client_payment_plan_id>
</failed_payment_charge_events>
</failed_payment_charge_data>
<!-- Optional: no applications because collection failed -->
<financial_trans_appln_data>
<financial_trans_application/>
</financial_trans_appln_data>
<!-- Optional: no unapplications in this example -->
<financial_trans_unappln_data>
<financial_trans_unapplication/>
</financial_trans_unappln_data>
<future_manual_allocation>N</future_manual_allocation>
</financial_transaction>
</financial_transactions>
<!-- Optional service_credit_details omitted for this example -->
<posting_info>
<posting_status_cd>2</posting_status_cd>
<posting_user>system</posting_user>
<posting_date>2026-02-10T13:46:00</posting_date>
</posting_info>
<!-- Optional invoice node; often present if tied to a specific invoice -->
<invoice>
<invoice_no>800001</invoice_no>
<invoice_type_cd>STANDARD</invoice_type_cd>
<threshold_billing_rule>
<threshold_billing_rule_no>0</threshold_billing_rule_no>
<client_threshold_billing_rule_id/>
<currency_amount>0.00</currency_amount>
</threshold_billing_rule>
</invoice>
<event_data>
<event>
<event_id>947</event_id>
<event_label>Failed Payment Collection</event_label>
</event>
</event_data>
</apf2doc>
Use Case 5: Service Credit Consumed
<?xml version="1.0" encoding="UTF-8"?>
<apf2doc>
<!-- Request header -->
<request>
<version>3.6</version>
<sender>A</sender>
<transaction_id>100200300</transaction_id>
<action>A</action>
<class>T</class>
<auth_key>CLIENT_AUTH_KEY_123</auth_key>
<client_receipt_id>SCREDIT_CONSUMED_960_001</client_receipt_id>
</request>
<!-- Account information -->
<account>
<client_no>123</client_no>
<acct_no>456789</acct_no>
<client_acct_id>ACCT-456789</client_acct_id>
<userid>customer.user@example.com</userid>
<senior_acct_no>0</senior_acct_no>
<master_plan_instances>
<master_plan_instance_data>
<plan_instance_no>90001</plan_instance_no>
<client_plan_instance_id>MPI-90001</client_plan_instance_id>
<resp_level_cd>A</resp_level_cd>
<resp_plan_instance_no>90001</resp_plan_instance_no>
</master_plan_instance_data>
</master_plan_instances>
</account>
<!-- Optional grouping info (single group example) -->
<financial_transaction_groups>
<financial_transaction_group>
<object_type>ACCOUNT</object_type>
<object_no>456789</object_no>
<billing_group_no>1001</billing_group_no>
<billing_group_name>Default Billing Group</billing_group_name>
<client_billing_group_id>BG-DEFAULT</client_billing_group_id>
<total_amount>-10.00</total_amount>
</financial_transaction_group>
</financial_transaction_groups>
<!-- Financial transaction representing the service credit consumption -->
<financial_transactions>
<financial_transaction>
<financial_trans_id>7001001</financial_trans_id>
<financial_trans_granular_id>7001001</financial_trans_granular_id>
<financial_trans_type_no>960</financial_trans_type_no>
<financial_trans_type_label>Service Credit Consumed</financial_trans_type_label>
<financial_trans_gl_type>CREDIT</financial_trans_gl_type>
<financial_trans_date>2026-02-17T10:15:00</financial_trans_date>
<financial_trans_user>system</financial_trans_user>
<financial_trans_amount>-10.00</financial_trans_amount>
<financial_trans_status_label>Posted</financial_trans_status_label>
<financial_trans_status_desc>Service credit applied to invoice charges</financial_trans_status_desc>
<financial_trans_client_notes>Service credit consumed against current invoice.</financial_trans_client_notes>
<financial_trans_applied_amount>-10.00</financial_trans_applied_amount>
<financial_trans_inv_type_cd>STD</financial_trans_inv_type_cd>
<!-- Optional: how this transaction was applied -->
<financial_trans_appln_data>
<financial_trans_application>
<charge_trans_id>8005001</charge_trans_id>
<payment_trans_id>7001001</payment_trans_id>
<applied_amount>-10.00</applied_amount>
<applied_trans_id>8005001</applied_trans_id>
<applied_trans_type_no>1</applied_trans_type_no>
<applied_trans_type_label>Invoice Charge</applied_trans_type_label>
<charge_trans_type_no>1</charge_trans_type_no>
<charge_trans_type_label>Service Charge</charge_trans_type_label>
<invoice_no>555001</invoice_no>
<sequential_statement_id>STMT-2026-02-001</sequential_statement_id>
</financial_trans_application>
</financial_trans_appln_data>
<!-- No unapplication in this simple consumed example -->
<financial_trans_unappln_data/>
<future_manual_allocation>No</future_manual_allocation>
</financial_transaction>
</financial_transactions>
<!-- Service credit details section -->
<service_credit_details>
<credit_id>30001</credit_id>
<amount>25.00</amount>
<amount_left_to_apply>15.00</amount_left_to_apply>
<amount_reserved_for_anniversary>0.00</amount_reserved_for_anniversary>
<reason_cd>101</reason_cd>
<reason_text>Service outage credit</reason_text>
<comments>Initial credit 25.00 USD, 10.00 consumed on 2026-02-17.</comments>
<currency_cd>USD</currency_cd>
<service_no_to_apply>2001</service_no_to_apply>
<service_name_to_apply>Premium Data Service</service_name_to_apply>
<client_service_id_to_apply>SRV-PREM-DATA</client_service_id_to_apply>
<applicable_mpi_no>90001</applicable_mpi_no>
<applicable_mpi_cdid>MPI-90001</applicable_mpi_cdid>
<create_date>2026-02-01T09:00:00</create_date>
<create_user>billing.admin</create_user>
<service_credit_applications>
<service_credit_application>
<invoice_no>555001</invoice_no>
<invoice_charge_line_no>1</invoice_charge_line_no>
<applied_amount>10.00</applied_amount>
</service_credit_application>
</service_credit_applications>
<!-- No unapplications for this example -->
<service_credit_unapplications/>
</service_credit_details>
<!-- Invoice impacted by the consumed credit -->
<invoice>
<invoice_no>555001</invoice_no>
<invoice_type_cd>STD</invoice_type_cd>
<threshold_billing_rule>
<threshold_billing_rule_no>0</threshold_billing_rule_no>
<client_threshold_billing_rule_id></client_threshold_billing_rule_id>
<currency_amount>0.00</currency_amount>
</threshold_billing_rule>
</invoice>
<!-- Posting information -->
<posting_info>
<posting_status_cd>1</posting_status_cd>
<posting_user>system</posting_user>
<posting_date>2026-02-17T10:16:00</posting_date>
</posting_info>
<!-- Event data identifying Service Credit Consumed (960) -->
<event_data>
<event>
<event_id>960</event_id>
<event_label>Service Credit Consumed</event_label>
</event>
</event_data>
</apf2doc>
General Observations
- These payloads adhere to the XSD structure, with <request>, <account>, <financial_transactions>, and <event_data> as required elements, and optional sections like <financial_transaction_groups>, <invoice>, and <posting_info> included as relevant.
- The version is set to "3.x" as specified in the schema, and sender is "A" (Aria).
- Optional fields like <auth_key>, <client_receipt_id>, and <senior_acct_no> are used selectively to show their potential inclusion.
- Amounts are represented as floats (e.g., "50.00"), and dates are simple strings (e.g., "2025-03-14").
- The <financial_trans_appln_data> section links transactions to their applied targets (e.g., invoices), reflecting real-world usage.