ProcessorOpenBatchGroupDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
A processor-scoped slice of the merchant's open batch. Mirrors a single (merchant, processor) settlement-close group: it owns the per-payment-type breakdown for that processor plus the processor-level totals and the batch identifiers used to scope a manual close.
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.
Fields
| Field | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
processorKey
required |
string | Lower-cased processor key (the same key the settlement close fans out on, derived from
the transaction's `ProcessorKey`). Empty for the unassigned group (see
`isUnassigned`).
nullable
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.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
processorName
required |
string | Friendly processor name resolved from the merchant's active processor profiles, when one
matches `processorKey`; otherwise `null` (callers fall back to
the key).
nullable
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.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
isUnassigned
required |
boolean | True when this group holds transactions that carry no `ProcessorKey`. Such rows are
intentionally excluded from every per-processor settlement close (the per-processor scoping
invariant), so they cannot be closed from this view; the group is surfaced read-only so an
operator can see that orphaned transactions exist.
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.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
isProcessorInactive
required |
boolean | True when this processor has unsettled transactions but no <em>active</em> processor profile
on the merchant (e.g. the profile was deactivated after the transactions were authorized).
The settlement close fans out only over active processor keys, so such a batch cannot be
closed from this view; it is surfaced read-only and routed to targeted re-settle / recovery.
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.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
openBatchId
required |
string | Representative open (gateway) batch id for this processor's current open batch. Passed back
on a manual close to scope the run to this processor's batch.
nullable
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.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
processorBatchId
required |
string | Representative processor batch id for this processor's open batch, when assigned.
nullable
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.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
paymentTypes
required |
array of PaymentTypeOpenBatchSummaryDto array of PaymentTypeOpenBatchSummaryDto | Per-payment-type breakdown within this processor's open batch.
nullable
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.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Fields of each PaymentTypeOpenBatchSummaryDto:
This body has no documented fields. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
totals
required |
OpenBatchTotalsDto OpenBatchTotalsDto | Processor-level rollup (count and net amount) across this group's payment types.
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.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Fields of OpenBatchTotalsDto: This body has no documented fields. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
lastUpdatedUtc
required |
string (date-time) | When this group's projection was computed (UTC).
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.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
This model has no documented fields.