Skip to main content
POST
Get Batch

Authorizations

X-Api-Key
string
header
required

Enter your API key

Body

application/json
id
integer<uint64>
required

Batch Identifier

sortColumn
string | null
default:Id

Sort column, the column being used for sorting. The default is transaction Id.

Valid Options:

  • Id
  • Type
  • Tender
  • Amount
  • AuthorizedAmount
  • CapturedAmount
  • GratuityAmount
  • SurchargeAmount
  • SettlementAmount
  • AvsCode
  • CvvCode
  • Created
Maximum string length: 100
Pattern: ^[A-Za-z0-9]*$
page
integer<int32> | null
default:1

Page, the of results being requested.

Required range: 1 <= x <= 2147483647
pageSize
integer<int32> | null
default:20

Page size, the number of items being requested for the page.

Required range: 1 <= x <= 1000
sortOrder
string | null
default:DESC

Sort order, the sort columns desired sort direction. The default is DESC.

Examples:

  • ASC
  • DESC
Maximum string length: 20
Pattern: ^[A-Za-z]*$

Response

object | null

OK

id
integer<uint64>

Ecrypt Batch ID

transactions
object | null