Refund or Void a payment

Refund or Void a payment. Authentication Key Type: SalesChannelApiKey

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Example:

curl --request PATCH \
  --url https://api.hips.com/v2/payments/z68uoH7QZ1fizWZ3iPR6vbYE/refund \
  --header 'Accept: application/json' \
  --header 'Authorization: private_BQokikJOvBiI2HlWgH4olfQ2' \
  --header 'Content-Type: application/json \
  --data '{
    "amount": 1000,
    "items": [
       {  
          "name": "T-shirt out of stock, sorry.",
          "quantity": 1,
          "vat_amount": -250,
          "unit_price": -1000
       } 
   ]
  }'
Path Params
string
required

Payment ID of the Payment you want to refund

Body Params

Refund or Void a payment. Authentication Key Type: SalesChannelApiKey

int32

Non-negative. Minor units. i.e 10000 = 100,00 (max value: original order value). Amount that should be returned / refunded back to the customer. If blank the entire payment will be refunded.

Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json