Batch Capture, Sale & Refunds

Description

The createUploadBatch API allows users to upload a Payments, Sale Or Refunds batch file for the selected period of time.

Request

Endpoint

/ui/v1/createUploadBatch

Method

POST

Content-Type: application/json

Attributes

ELEMENT DESCRIPTION FORMAT
StartDate Required

Start date of the batch		 2023-06-05
endDate Required

End date of the batch		 2023-06-06
paymentGateway Required

Array index
• value Required

Payment Gateway value		 ex: Chase Paymentech (netConnect - Direct To Tandem)
• name Required

Payment Gateway name for which the batch has to be inititated		 CHASE_PAYMENTECH_NETCONNECT
merchantId Required

Merchant Id		 1

Request Body

{
    "startDate": "2023-06-05",
    "endDate": "2023-06-05",
    "paymentGateway": [{
        "value": "Chase Paymentech (NetConnect - Direct To Tandem)",
        "name": "CHASE_PAYMENTECH_NETCONNECT"
    }],
    "merchantId": ["1"]
}

Response

{
    "records": [{
        "id": 215,
        "batchID": null,
        "uploadedBatchFileName": "000333.Request.txt",
        "downloadedBatchFileName": "000333.Response.txt",
        "createdDateTime": null,
        "lastUpdatedDateTime": null,
        "batchStatus": {
            "name": "PROCESSED"
        },
        "uploadedRecordCount": 2,
        "responseRecordCount": 2,
        "paymentGateway": {
            "value": "Chase Paymentech (NetConnect - Direct To Tandem)",
            "name": "CHASE_PAYMENTECH_NETCONNECT"
        },
        "responseMessage": null,
        "startTransactionDateTime": null,
        "endTransactionDateTime": null,
        "uploadedAmount": null,
        "responseAmount": null,
        "merchantNumber": null,
        "createdUserId": 328,
        "lastModifiedUserId": null,
        "merchantId": 1,
        "createdUserName": null,
        "merchantName": null
    }],
    "recordCount": null,
    "message": null
}

Updated As Of Version 5.8.0.3