SplitTenderContextDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
The split-tender membership of a single transaction, plus the running balance the group has collected so far. Lets a caller render "tender 2 of 3, $40.00 still owed" without fetching and summing every member of the group itself.
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 | ||||
|---|---|---|---|---|---|---|
splitTenderGroupId
required |
string (uuid) | Identifier shared by every tender in the group.
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.
| ||||
sequence
required |
integer (int32) | 1-based position of the transaction this context was assembled for.
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.
| ||||
role
required |
SplitTenderRole SplitTenderRole | Whether the transaction this context was assembled for is the group's primary tender or a
continuation.
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.
| ||||
totalRequestedAmount
required |
number (double) | The order total the group is collecting toward, in major currency units: the order total
declared on the primary tender's create request when one was declared, otherwise the amount
originally requested on the primary tender.
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.
| ||||
totalApprovedAmount
required |
number (double) | What the tenders in the group have collected, in major currency units: each card's approved
amount, less anything reversed or refunded. A voided or declined tender, and one still being
authorized, contributes nothing.
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.
| ||||
remainingAmount
required |
number (double) | What is still owed, in major currency units: `totalRequestedAmount` minus
`totalApprovedAmount`. Zero once the group has collected the full order total.
While another payment in the group is still being authorized, an additional payment for this
full amount is refused until that payment resolves. When a check payment in a completed group
is returned by the bank, this is the amount the return left unpaid; the group does not reopen
for further payments.
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.
| ||||
tenderCount
required |
integer (int32) | Number of tenders currently in the group, including voided ones (they remain part of the
audit trail).
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.
| ||||
maxTenders
required |
integer (int32) | The most tenders the merchant allows in one split-tender group, the primary included.
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.
| ||||
returnedAmount
required |
number (double) | What the bank took back from the group after it completed, in major currency units: the sum of
every check payment returned (for example, for insufficient funds) once the group had already
collected its order total. Already taken off `totalApprovedAmount` and added back
to `remainingAmount`. Null when no payment in the group has been returned.
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.
|
This model has no documented fields.