MerchantBillingRunResultStatus
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Outcome status for an individual merchant within a billing run.
Values
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Success |
Merchant rated successfully. Terminal for a dry run; on a non-dry run it is a transient pre-dispatch state that the fulfillment dispatcher advances to a path-specific status (Invoiced or ChargePending). |
Failed |
Billing failed for this merchant. |
Skipped |
Merchant was skipped (e.g., inactive or excluded). |
NoPlan |
No active price plan assigned to this merchant. |
NoUsage |
No usage recorded for this merchant in the billing period. |
NoFulfillmentPath |
Neither ResellerBillingPreferences.DefaultFulfillmentPath nor the per-merchant MerchantBillingAssignment.FulfillmentPath override is set, so the resolver cannot decide how to collect payment for this merchant. |
NoPaymentMethod |
The effective fulfillment path is RecurringContract but no active MerchantBillingPaymentMethod row exists for the (ResellerId, MerchantId) pair, so the recurring charge has no token to draft against. |
MissingCollectionMerchant |
The effective fulfillment path is RecurringContract but the reseller has not configured a CollectionMerchantId, so there is no party to own the recurring contract. |
MissingHpp |
The effective fulfillment path is Invoicing but the reseller has not configured an HppPageId, so the generated invoice has no payment link destination. |
Invoiced |
The merchant was rated successfully and the Invoicing fulfillment path produced an issued invoice. Terminal for the Invoicing path: see MerchantBillingRunResult.InvoiceId for the artifact. |
Charged |
The RecurringContract path charge completed successfully. Set when the downstream charge reconciliation (tracked separately) confirms an approved transaction; see MerchantBillingRunResult.TransactionId. |
ChargePending |
The merchant was rated successfully and the RecurringContract path dispatched a charge request into the Transaction Manager. The charge has not yet been reconciled; the run records this as a non-terminal "awaiting result" state. See MerchantBillingRunResult.ContractId. |
ChargeFailed |
The RecurringContract path charge was attempted but declined or errored. Set by the downstream charge reconciliation (tracked separately). |
NoBillableUsage |
Usage was recorded for the merchant in the billing period, but the plan produced no positive-charge line item, so there is nothing to bill. Distinct from NoUsage (which means no usage aggregates existed at all): here the merchant genuinely transacted, the usage simply fell entirely within a rate entry's included/free allowance or matched no billable rate entry. Where a rate entry matched the usage, the rated run keeps the zero-billable line item visible so the operator can see the usage and why it was not charged; usage that matched no rate entry produces no line item. |
Fields
| Field | Type | Description |
|---|
This model has no documented fields.