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

Header¶

Content-Type: application/json

Request Body¶

{
    "startDate": "2021-03-30",
    "endDate": "2021-03-30",
    "paymentGateway": [{
        "value": "CyberSource",
        "name": "CYBERSOURCE"
    }],
    "merchantId": ["3"],
    "channelId": ["49"]
}
}

Response¶

{
    "records": [{
        "id": 108,
        "batchID": "03301922",
        "uploadedBatchFileName": "03301922.csv",
        "downloadedBatchFileName": null,
        "createdDateTime": null,
        "lastUpdatedDateTime": null,
        "batchStatus": {
            "value": "Failed",
            "name": "FAILED"
        },
        "uploadedRecordCount": 1,
        "responseRecordCount": 0,
        "paymentGateway": {
            "value": "CyberSource",
            "name": "CYBERSOURCE"
        },
        "responseMessage": "An internal exception has occurred. Please contact administrator.",
        "createdUserId": 218,
        "lastModifiedUserId": null,
        "merchantId": 3,
        "createdUserName": null,
        "merchantName": null
    }],
    "recordCount": null,
    "message": null
}

Updated As Of Version 3.8.0.9