Balances with External Payment Requests

For information about querying whether a balance is associated with an external payment method, see the pricing query APIs in MATRIXX Subscriber Management API.

For information about specifying external payment requests, see the discussion about configuring general balance properties in My MATRIXX Help.

For more information about auto recurring recharge, see the discussion about external payment recurring recharge.

Fee debt balance associated with an external payment method can be impacted when an offer is purchased, when there are recurring charges, when an offer transitions to a grace period (fee charge), or when there is a cancelation charge for the offer. For more information about canceling a purchased item with debt balance associated with external payment methods, see the discussion about balances with external payment requests cancelation and expiration.

Purchase

At purchase time, if a purchase charge or the first cycle recurring charge is applied to a postpaid, non-main, actual-currency balance with Create External Payment Request selected on the balance template, external payment requests are initiated, and MtxExternalPaymentRequestEvent Event Detail Records (EDRs) are generated. At the time of purchase, a payment due date can (optionally) be supplied in the purchase API. If provided, the payment due date is saved in the purchased offer and is used to determine the payment due date for the external payment request.

The payment due date in the external payment request is either the purchase time (that is, the event time if no payment due date is supplied), or the greater of the payment due date in the purchased offer and purchase time. For more information about the purchase API, see the discussion about product offer APIs in MATRIXX Subscriber Management API.

During the purchase transaction, there is one MtxExternalPaymentRequestEvent EDR per event type, per catalog item, and per impacted balance. For example, on a catalog item purchase, if both the purchase charge and the first cycle recurring charge are applied to balances associated with an external payment method, there is one external payment request for the purchase charge and one for the recurring charge. When the external payment request is generated, an external payment request event is generated. For more information about events, see the discussion about external payment offer events and notifications.

Grace Period Transition

A fee charge is generated during status transition into a grace period when configured with offer life cycle. If the impacted fee debt balance has Create External Payment Request selected on its balance template, then an external payment request is generated. For more information about grace period transition, see the discussion about offer transition conditions in MATRIXX Subscriber Management API.

Recurring Charges

When the system is configured with Automatic Recurring Recharge, recurring charges can be collected before the cycle renewal time. If the balance template has Create External Payment Request selected, external payment requests are generated before the cycle renewal time. If the payments are received before the cycle renewal time, they are reserved until cycle renewal time and used to pay for the recurring charges.

For a prepaid balance, when the system is configured with Automatic Recurring Recharge and Create External Payment Request is selected on the balance template, a product offer or bundle containing a catalog item with recurring charges is activated and the initial recurring charges are on account, with subsequent recurring charges paid through external payments.

For prepaid external payments, if the payment is received for intervals that have ended, the external payment record status changes to VOID and an error "Modification of external payment denied as cycleEndDate has passed for paymentRequest" displays, and the payment request resource ID is returned.