Batch

Queries related to batch transactions

Query batch logs

post

Header parameters

SessKeystringRequired

A unique session key used for authentication in API calls. This key is generated upon successful authentication and must be included in all subsequent requests.

Example: A1842D663E9A4A72XXXXXXXX303541303234373138

Content-TypestringRequiredExample: application/json

AcceptstringRequiredExample: application/json

Body

application/json

QuerystringOptional

A query string for obtaining specific batch log records using Number's query language. Build logical terms and join them with '&&' for logical AND or '||' for logical OR. Use single quotes for text and date values. Refer to the variable chart for query composition:

• A: MERCHANT ID - The merchant record you are interested in, e.g. (A=545).
• B: STATUS - The status of the batch log, e.g. (B=-1).
  • -1: ALL
  • 1: FAILED
  • 2: APPROVED
• C: CREATED ON - The date the batch log was created, e.g. (C>='3/2/2024')&&(C<='4/2/2024').
• D: BATCH LOG ID - The unique identifier for the batch log, e.g. (D=1777).
• E: BATCH NUMBER - The batch number for the batch log, e.g. (E=185).

Example: (B=1)&&(C>='3/2/2024')&&(C<='4/2/2024')

Responses

200

Successfully returned batch log records

application/json

post

/APIcardProcREST/v1.0.0/Query/BatchLog

HTTPcURLJavaScriptPython

POST /APIcardProcREST/v1.0.0/Query/BatchLog HTTP/1.1
Host: easypay5.com
SessKey: A1842D663E9A4A72XXXXXXXX303541303234373138
Content-Type: application/json
Accept: application/json
Content-Length: 45

{
  "Query": "(C>='7/19/2023')&&(C<'7/20/2023')"
}

200

Successfully returned batch log records

{
  "Batch_Log_QueryResult": {
    "BatchLogs": [
      {
        "BatchAmt": 110,
        "BatchClose": "020224054035",
        "BatchNO": 512,
        "BatchOpen": "020224054031",
        "BatchRecs": 3,
        "Code": "A",
        "CreatedBy": "AUTOSCHED",
        "CreatedOn": "2024-12-01T11:19:01.000Z",
        "FinishedOn": "2024-12-01T11:19:01.000Z",
        "ID": 612,
        "MerchID": 3,
        "Released": 0,
        "SettleResp": "APPROVAL Batch:512:Recs:3:$110.00",
        "TxLOCK": "7A639CD720CE4B14"
      }
    ],
    "ErrCode": 0,
    "ErrMsg": "",
    "FunctionOk": true,
    "NumRecords": 9,
    "RespMsg": "Successfully Returned Batch Log Records : 9"
  }
}