Refunds

Issue a partial refund

post

Path parameters

RefNostringRequired

Unique, system-generated order identifier.

Example: 734881310

Header parameters

X-Avangate-AuthenticationstringRequired

Authentication header

Example: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"

Acceptstring · enumRequiredExample: application/jsonPossible values:

Body

application/json

amountnumberOptional

commentstringOptional

reasonstringOptional

Responses

200

OK

No content

post

/orders/{RefNo}/refund

HTTPcURLJavaScriptPython

POST /rest/6.0/orders/{RefNo}/refund HTTP/1.1
Host: api.2checkout.com
X-Avangate-Authentication: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"
Accept: application/json
Content-Type: application/json
Content-Length: 117

{
  "amount": 23,
  "items": [
    {
      "Code": "my_product_1",
      "Quantity": 1
    }
  ],
  "comment": "requested by vendor",
  "reason": "CUSTOM_REASON"
}

200

OK

No content

Working example: Cancel a refund request

delete

Path parameters

RefNostringRequired

Unique, system-generated order identifier.

Example: 734881310

Header parameters

X-Avangate-AuthenticationstringRequired

Authentication header

Example: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"

Acceptstring · enumRequiredExample: application/jsonPossible values:

Responses

200

OK

application/json

RefundIdstringOptionalExample: 5

400

Invalid data

application/json

delete

/orders/{RefNo}/refund

HTTPcURLJavaScriptPython

DELETE /rest/6.0/orders/{RefNo}/refund HTTP/1.1
Host: api.2checkout.com
X-Avangate-Authentication: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"
Accept: application/json

{
  "RefundId": 5
}