Get Open Batch API Response Object

The description of the Get Open Batch API response object

The Get Open Batch API returns a response in standard JSON format. The following table lists the properties of a Get Open Batch API response:

Top-Level Properties

Property	Description
`success`	Whether or not the API call succeeded.
`content`	The `content` subobject.
`errors`	The `errors` subobject array if any.

`content` Subobject

Property	Description
`batchNbr`	The merchant-specific batch number.
`merchantNbr`	The merchant number.
`openDate`	The date and time the batch was originally opened.
`closeDate`	The close date of the batch, which is always `null` as the batch is still open.
`totalAmount`	The total sum of all transactions currently in the batch.
`txnsInBatch`	The number of transactions in the batch.
`status`	The status of the batch, which is always `Open` as the batch is still open.
`transactions`	The `transactions` subobject array.

`transactions` Subobject (Array)

Property	Description
`txnNbr`	The system-generated transaction number.
`externalInvoiceNbr`	The merchant’s invoice number.
`amount`	The transaction amount.
`txnType`	The type of transaction, which is always `Sale` .
`txnStatus`	The status of the transaction, which is always `Approved.`
`datePosted`	The transaction creation date.
`cardNbr`	The last four digits of the card that was processed with the transaction.
`disputeId`	Reserved for internal use.
`rebillInvoiceNbr`	Reserved for internal use.
`tailNbr`	The tail number of the aircraft associated with the transaction.
`branchOfService`	The branch of service associated with the card that was processed with the transaction.
`details`	Reserved for internal use.
`isPPSPOS`	Whether the origin of the transaction was the PPS POS.

`errors` Subobject (Array)

Property	Description
`code`	The error code.
`message`	The error message.

You can find examples of this response object here.

Updated 5 months ago