id
required |
string (uuid)
|
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.
|
creationTime
required |
string (date-time)
|
The date and time when this entity was created.
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.
|
creatorId
required |
string (uuid)
|
The ID of the user who created this entity.
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.
|
lastModificationTime
required |
string (date-time)
|
The date and time when this entity was last modified.
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.
|
lastModifierId
required |
string (uuid)
|
The ID of the user who last modified this entity.
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.
|
isDeleted
required |
boolean
|
Indicates whether this entity has been deleted.
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.
|
deleterId
required |
string (uuid)
|
The ID of the user who deleted this entity, if it is deleted.
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.
|
deletionTime
required |
string (date-time)
|
The date and time when this entity was deleted, if it is deleted.
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.
|
merchantId
required |
string (uuid)
|
Gets or sets the unique identifier of the merchant associated with the batch file.
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.
|
merchantName
required |
string
|
Gets or sets the merchant name associated with the batch file.
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.
|
fileName
required |
string
|
Gets or sets the name of the file.
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.
|
filePath
required |
string
|
Gets or sets the file system path to the batch file.
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.
|
status
required |
BatchStatus
BatchStatus |
Gets or sets the current processing status of the batch file.
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.
Pending |
Batch has been uploaded but not yet validated | Ready |
Batch is validated and ready to be processed | InProgress |
Batch is currently being processed | Completed |
Batch processing completed (may have some failed transactions) | Failed |
Batch processing failed completely | Cancelled |
Batch was cancelled |
|
totalTransactions
required |
integer (int32)
|
Gets or sets the total number of transactions included in the batch file.
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.
|
processedTransactions
required |
integer (int32)
|
Gets or sets the number of transactions that have been processed for the batch file.
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.
|
successfulTransactions
required |
integer (int32)
|
Gets or sets the number of transactions in the batch that completed successfully.
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.
|
failedTransactions
required |
integer (int32)
|
Gets or sets the number of transactions in the batch that failed to process.
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.
|
uploadedDate
required |
string (date-time)
|
Gets or sets the date and time when the batch file was uploaded.
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.
|
validatedDate
required |
string (date-time)
|
Gets or sets the date and time when the batch file was validated.
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.
|
processingStartDate
required |
string (date-time)
|
Gets or sets the date and time when processing of the batch file started.
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.
|
processingEndDate
required |
string (date-time)
|
Gets or sets the date and time when processing of the batch file completed.
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.
|
processedByUserId
required |
string (uuid)
|
Gets or sets the unique identifier of the user who processed the batch file.
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.
|
processedByUserName
required |
string
|
Gets or sets the name of the user who processed the batch file.
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.
|
transactions
required |
array of BatchFileTransactionDto
array of BatchFileTransactionDto |
Gets or sets the collection of transactions included in the batch file.
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.
|
notes
required |
string
|
Gets or sets optional notes associated with the batch file.
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.
|
errorMessage
required |
string
|
Gets or sets a human-readable description of the error associated with the batch file, if any.
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.
|
concurrencyStamp
required |
string
|
Gets or sets a value used to detect concurrent updates to the batch file.
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.
|
progressPercentage
required |
number (double)
|
Calculated property for progress percentage
read only
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.
|
successRate
required |
number (double)
|
Calculated property for success rate
read only
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.
|