Add an attachment to a dispute

post/disputes/{disputeId}/attachments

API Version

Add supporting information as an attachment for the raised dispute. Upload receipts, communication, or any other documentation to support the dispute.

Endpoint destination URL

Path Parameters

Required

Optional

The unique identifier of the raised dispute.

Request Parameters

Required

Optional

The type of information contained in the attachment: receipt, correspondence, other.

The content of the image. An attachment must be base64-encoded data. Make sure that all base64-encoded data strings are generated without line breaks or "wrapping". For example, do not use Base64.NO_WRAP in Java, or its equivalent in other languages. Newline characters at the end of the base64-encoded data string will also result in a malformed input error.

Min length: 4Max length: 17

The name of the attachment, including its filename extension. Supported filename extensions: jpeg, pdf, tiff.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

200 - OK
The request has succeeded.
attachmentIdstring
The unique identifier of the attachment.
401
Authentication required.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
namestring
The field that has an invalid value.
valuestring
The invalid value.
messagestring
Description of the validation error.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.
403
Insufficient permissions to process the request.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
namestring
The field that has an invalid value.
valuestring
The invalid value.
messagestring
Description of the validation error.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.
422
A request validation error.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
namestring
The field that has an invalid value.
valuestring
The invalid value.
messagestring
Description of the validation error.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.

Add an attachment to a dispute

HTTP Responses

200 - OK

401

403

422