Created with Sketch.
Created with Sketch.

RefundRemaining

POST /CheckOut2Api/Commerce/RefundRemaining

The method allows merchant to refund remaining amount on the order for undelivered goods.

Input Parameters

NameData TypeDefault ValueDescription
ExternalIdStringNone. Must be specified.An ID acquired when initializing a Check-Out session.
OrderReferenceStringNone. Must be specified.An ID that identifies the order for which the purchase is to be made.
TranIdString (max. length 36 characters)An empty stringA random unique ID generated by the calling party that identifies the HTTP request. Although the property isn’t strictly required , we recommend to generate a new random GUID and pass it. Technically, it can be any string.

Example request

{
 "ExternalId": "19ac0d1ee909c302d212b4324d9194b5",
 "TranId": "123456",
 "OrderReference": "ue12345"
} 

Return Value

If successful, the method returns a HTTP status code 200 (OK) with no additional content.

IF not successful the method returns a HTTP status code 400 with error description in body.

[
  {
    "ErrorCode": "10005",
    "ErrorMessage": "Invalid or missing external ID."
  }
]