POST
/
ChargeBacks
/
response
/
{Id}
curl --request POST \
  --url https://api-sandbox.payabli.com/api/ChargeBacks/response/{Id} \
  --header 'Content-Type: application/json' \
  --header 'requestToken: <api-key>' \
  --data '{
  "contactName": "John Doe",
  "contactEmail": "example@email.com",
  "notes": "any note here",
  "attachments": [
    {
      "ftype": "pdf",
      "filename": "my-doc.pdf",
      "furl": "https://mysite.com/my-doc.pdf",
      "fContent": "TXkgdGVzdCBmaWxlHJ==..."
    }
  ]
}'
{
  "isSuccess": true,
  "responseText": "Success",
  "responseCode": 0,
  "responseData": 126
}

Authorizations

​
requestToken
string
header
required

Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.

Headers

​
idempotencyKey
string

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.

Example:

"6B29FC40-CA47-1067-B31D-00DD010662DA"

Path Parameters

​
Id
integer
required

ID of chargeback or return record

Body

ResponseChargeback object to add
​
contactName
string | null

Name of response submitter

Example:

"John Doe"

​
contactEmail
string | null

Email of response submitter.

Maximum length: 320
Example:

"example@email.com"

​
notes
string | null

Response notes

Example:

"any note here"

​
attachments
object[] | null

Array of attached files to response.

Contains details about a file. See See fileObject Object Model for a complete reference. Max upload size is 30 MB.

Response

200
application/json
Success
​
isSuccess
boolean

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

Example:

true

​
responseText
string | null

Response text for operation: 'Success' or 'Declined'.

Example:

"Success"

​
responseData
integer

The response data.

Was this page helpful?