AutosettlementSettings
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
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 | ||||
|---|---|---|---|---|---|---|
enable
required |
boolean |
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.
| ||||
settlementTime
required |
string (date-time) | The time of day (UTC) at which this merchant's batch is closed by auto settlement.
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.
| ||||
sendMerchantEmail
required |
boolean |
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.
| ||||
userNotificationType
required |
MerchantAutosettleEmailUserType MerchantAutosettleEmailUserType | Defines the type of user associated with an autosettle email notification for a merchant.
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.
| ||||
additionalEmailNotifications
required |
array of EmailAddress array of EmailAddress |
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 EmailAddress: This body has no documented fields. | ||||||
currentBatchIds
required |
object | Per-processor open batch IDs for this merchant, keyed by lower-cased processor key
(e.g. `"tsys"`, `"loopback"`). Transactions authorized for a given processor
while its batch is open are stamped with that processor's ID. When settlement starts,
only the rotating processor's entry is rotated to a new value: sibling processors'
boundaries are unaffected. Empty until the first settlement run or first transaction
that needs batch assignment.
Format: `{merchantId-short}:{date}:{sequence}`.
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.
| ||||
currentBatchId
required |
string | Deprecated single batch ID, kept for reading older settings only. When
`currentBatchIds` has no entry for a processor, the server treats this value as
that processor's open batch. The first successful batch rotation populates
`currentBatchIds` for that processor and clears this value. The server never
writes this field; use `currentBatchIds` instead.
nullabledeprecated
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.