API referencePay In endpointsDisputes and Returns

Add response to dispute

Add a response to a chargeback or ACH return.

Authentication

requestTokenstring
API Key authentication via header

Path parameters

IdlongRequired
ID of chargeback or return record

Headers

idempotencyKeystringOptional
A unique ID you can include to prevent duplicating objects or transactions if a request is sent more than once. This key is not generated in Payabli, you must generate it yourself.

Request

This endpoint expects an object.
attachmentslist of objectsOptional
Array of attached files to response.
contactEmailstringOptionalformat: "email"<=320 characters
Email of response submitter.
contactNamestringOptional
Name of response submitter
notesstringOptional
Response notes

Response

Success
isSuccessboolean

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

responseDatainteger

If isSuccess = true, this contains the chargeback identifier. If isSuccess = false, this contains the reason for the error.

responseTextstring

Response text for operation: ‘Success’ or ‘Declined’.

Errors

400
Bad Request Error
400
Bad Request Error
401
Unauthorized Error
401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error