v1

latestOpenAPI 3.0.3Moneris2026-07-2454487645.8 KB

Disputes

Check image upload status

This endpoint can be used to check image upload status

get/disputes/{case-id}/{case-record-number}/uploads/{upload-reference-id}

Path parameters

case-idstring required

The case ID associated with the uploaded files.

case-record-numberinteger required

The case record number of the files. This must be a value between "0" and "99".

upload-reference-idstring required

Upload reference Id.

Headers

Api-Versionstring required

The endpoint's API Version. Must be provided through headers.

Example:2025-08-14

The endpoint's API Version.

Must be provided through the headers section.

X-Merchant-Idstring required

Thirteen character long identification provided to merchants by Moneris.

Example:0123456789101

Thirteen character identification code.

Note: This code is provided by Moneris and is required to identify the Merchant executing the transaction."

X-Correlation-Idstring

Example:06f1e47b-a1b5-4902-be9c-bccc506127c4

Correlates a series of requests within the same flow.

Note: This ID is generated by Moneris with every request or response, if it doesn't exist. Merchants are to echo back the value with every request that is part of the call flow."

Response

Upload Status retrieved successfully.

uploadReferenceIdstring required

Upload reference id.

uploadStatus'PENDING' | 'FAILED' | 'SUCCESSFUL' required

Status type.

PENDING: The Images have been pending upload.
FAILED: Image upload failed. Failure could be caused by different reasons.
SUCCESSFUL: Images uploaded successfully.

Example response

{
  "uploadReferenceId": "IU1001ARZ3NDEKTSV4RRFFQ69G5FAV"
}