POST
/
refund
Refund
curl --request POST \
  --url https://test.paysight.io/customerapi/refund \
  --header 'ClientId: <clientid>' \
  --header 'Content-Type: application/json' \
  --header 'UserEmail: <useremail>' \
  --data '{
  "parentCompanyId": 1,
  "userEmail": "care@yourdomain.com",
  "messageId": "fd6562a1-e0e7-4b8b-b0d4-f20359482dd1",
  "amount": 12.99,
  "refundItems": [],
  "sendUserCommunication": false
}'
{
  "success": true,
  "message": "",
  "refundId": "da6562a1-e0e7-4b8b-c0d4-g20359482dd1"
}

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

Payload

The body is of type object.

Response

200 - application/json

Valid Request. More detailed info will be in the JSON body

The response is of type object.