External Payment Request Cancelation and Expiration

When canceling a purchased item with debt balance associated with postpaid external payment methods, the debt can be written off or paid off in full. During offer cancelation, any pending payments are forfeited; new payments are not accepted for a canceled offer. When a prepaid balance with the Create External Payment Request attribute expires, it is no longer available; any outstanding unpaid external payment requests are no longer valid and no additional payments are accepted.

The Charging Server can request payments and receive payments for balances with external payment requests. If a purchased item is canceled when approaching the new cycle start time and the external payment for the recurring charge of the upcoming cycle has been received, the payment amount is forfeited, and an MtxExternalPaymentEvent and an MtxForfeitureEvent EDR are generated. The external system should issue a refund to the subscriber.

Postpaid Balance Cancelation

If the debt is to be written off, the payment status of the external payment request records in the wallet associated with the debt balance are updated from due to payment status written-off, and a write off event is generated including a list of written off external payment requests. One write off event is generated for each debt balance associated with an external payment method.

Note: The sum of the amounts in the written off external payment requests must be equal to the debt balance amount to be written off.

If all debt is to be paid off, any debt from the cancelation charge (or early termination charge on a contract offer) is applied to the fee debt balance, and an external payment request is generated. The payment due date of the request is the offer cancelation time. For more information about offer cancelation, see the discussion about CancelOffer SubMan APIs in MATRIXX Subscriber Management API.

For any other existing debt, there are external payment requests in the system, allowing for debt to eventually be paid off.

Pending External Payment Upon Offer Cancelation

As shown in Figure 1, offer A is approaching recurring charge. The task manager is configured to generate an external payment request three days before recurring processing. The subscriber cancels the offer two days before recurring. The PUT external-payment API is rejected and the payment is refunded to the customer.

canceled offer refund — Figure 1. Canceled Offer Refund

Expiration

When an offer with debt balances expires, any debt balances with a write-off policy of expired are written-off, and a debt payment event is generated for each debt balance that is written-off. However, when a debt balance associated with external payment requests expires, the payment must be paid before the expired offer can be purged. For example, if a contract offer is canceled and an early termination charge (ETC) is to be collected, then the expired offer cannot be purged until the cancelation charge is paid. The expired offer can be purged only if no external payment requests with a Due payment status exist; all external payments for debt balances are paid, or external payments are written off when a globally configured number of days have passed after the payment due date. For more information about write-off, see the discussion about write-off policy.

Upon expiration, the remaining amount in the balance associated with external payment requests is written off (if enabled). If any outstanding external payment requests with a Due payment status, those payment requests are written off, and a write off event is generated including a list of the external payment requests written off.

A sliding window determines a finite number of intervals in a periodic balance, each of which is available for the same specified length of time. When a period within a periodic balance associated with external payment request slides the window out of the periods maintained in the wallet, the balance is treated as expired, and, if applicable, an MtxWriteOffEvent is generated. For more information about sliding windows, see the discussion about sliding windows for periodic balances.

Purging External Payment Request Records

Answer the following configuration questions to specify when external payment request records are removed from the system and when to change the status of an external payment request for a prepaid balance from DUE to VOID: Global:How long (in days) after due date should an external payment request be removed from the system? The answer to the first question defines the external payment write off interval. It determines the number of days after the due date the debt (postpaid balance) is written off. When the debt is written off, the payment status is updated to WRITTEN_OFF, and a write off event is generated. The external payment write off interval is also used to determine the number of days after the due date an external payment request for a prepaid balance can be changed to have a status of VOID. The answer to the second question defines the external payment purge interval. It specifies the number of days after the due date the payment record with a status of PAID, WRITTEN_OFF, or VOID is removed from the wallet.