ReceiptSplitTenderLineDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
One tender's line on a split tender summary receipt.
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 | ||||||
|---|---|---|---|---|---|---|---|---|
tenderSequence
required |
integer (int32) | 1-based position of the tender within the group.
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.
| ||||||
tenderKind
required |
ReceiptTenderKind ReceiptTenderKind | What kind of payment the tender was: a card, an ACH debit from a bank account (check), or cash.
A client that meets a value it does not recognize should name the line by its position and
amount alone.
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.
| ||||||
cardBrand
required |
string | Card brand (e.g. "Visa"). Null on a check or cash line.
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.
| ||||||
lastFour
required |
string | Last four digits of the tender's card, or of the bank account on a check line. Null on a cash line.
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.
| ||||||
checkNumber
required |
string | The check number on a check line, when the payment carried one. Null on a card or cash line.
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.
| ||||||
authorizedAmount
required |
number (double) | The amount this tender authorized, in the transaction currency.
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.
| ||||||
chargedPrice
required |
ReceiptTenderPrice ReceiptTenderPrice | Which of a dual pricing merchant's two prices the payment paid for its share, for a group whose
payments are each priced on their own share; null otherwise.
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.
| ||||||
cashPriceAmount
required |
number (double) | For a payment charged the card price for its share: what it paid toward the order at the cash
price, in the transaction currency, in major currency units. Null otherwise.
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.
| ||||||
isVoided
required |
boolean | True when the tender was voided or reversed, so its amount is not part of the group total.
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.
| ||||||
isReturned
required |
boolean | True when the bank returned this check payment after the group had collected its order total,
so its amount is no longer collected. Shown only on a summary issued after the return.
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.
| ||||||
returnCode
required |
string | The NACHA return code (for example `R01`) on a returned check line.
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.
| ||||||
returnReason
required |
string | The reason for the return on a returned check line.
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.