Payment Settlement Events

When a Pay Now payment settlement completes, the Charging Server generates an MtxPaymentSettlementEvent Event Detail Record (EDR) that is separate from the authorization EDR.

MtxPaymentSettlementEvent Fields describes the MtxPaymentSettlementEvent EDR fields.
Table 1. MtxPaymentSettlementEvent Fields
Field Type Description
Amount Decimal Payment amount.
PaymentToken BLOB Payment token used to authorize the payment.
PaymentMethodName String Optional descriptive name for the payment method.
PaymentMethodResourceId UINT32 Resource ID of payment method. The resource ID is auto-generated when the payment method is created using the SubMan APIs.
PaymentSettlementTransactionId BLOB The payment settlement transaction ID. The value comes from the payment gateway and Payment Service.
PaymentAuthorizationEventId String The ID of the corresponding payment authorization event.
Status UINT16 Indicates the status of the payment settlement:
  • 0 — Succeeded
  • 1 — Rejected by the payment gateway
  • 2 — Timeout
PaymentGatewayResult String Result returned from the payment gateway.
PaymentMethodType String Descriptive name of the payment method type used to authorize payment.
DeferredSettlement Bool Indicates if the settlement was deferred at the time it was charged. The GL processor uses this field to determine if it must read the events for the original charges to find charge records with revenue recognition type pending_settlement (6).