Skip to main content
POST
/
api
/
mitigation
/
refund
Refund (and Cancel)
curl --request POST \
  --url https://test.paysight.io/api/mitigation/refund \
  --header 'Authorization: <api-key>' \
  --header 'ClientId: <clientid>' \
  --header 'Content-Type: application/json' \
  --header 'UserEmail: <useremail>' \
  --data '{
  "transactionId": "c0ffeec0-ffee-c0ff-eec0-ffeec0ffhec0",
  "amount": 20,
  "refundItems": [
    {
      "itemId": "item123",
      "quantity": 1
    }
  ],
  "sendUserCommunication": true,
  "alertSource": "ChargebackHelp",
  "alertType": "RDR"
}'
{
  "success": true,
  "message": "<string>",
  "refundId": "<string>"
}

Authorizations

​
Authorization
string
header
required

Your Paysight API key

Headers

​
ClientId
string
required

Your Paysight Tenant/Client Id. This is the id of the parent company listed in https://app.paysight.io/management/companies. Alternatively, this will be provided by Paysight

​
UserEmail
string
required

The email address of the party or group making the request

Body

application/json

Request payload for issuing a refund

​
transactionId
string
required

Unique ID of the transaction to refund

Example:

"c0ffeec0-ffee-c0ff-eec0-ffeec0ffhec0"

​
amount
number

Amount to refund

Example:

20

​
refundItems
object[]

List of items included in the refund - this is only required for partial refunds on ecom transactions. Otherwise omit.

​
sendUserCommunication
boolean

Whether to send an email notification to the customer

Example:

true

​
alertSource
enum<string>

Source of the alert triggering the refund

Available options:
Chargebacks911,
AltoGlobal,
ChargebacksHero,
GoatMaverick,
DisputeDotCom,
Kount,
ChargebackHelp,
Disputifier,
RCVR
Example:

"ChargebackHelp"

​
alertType
enum<string>

Type of alert

Available options:
Ethoca,
CDRN,
RDR
Example:

"RDR"

Response

Refund result

Response payload returned after processing a refund. Note in the case of RDR, the refund will only be recorded as it is already completed.

​
success
boolean

Indicates if the refund was successful

​
message
string

Message describing the result of the refund

​
refundId
string

Unique identifier for the processed refund

⌘I