POST v1/companies/{companyId}/locations/{locationid}/ecomm-refund

Refund a full or partial payment

Request Information

Name	Description	Type	Additional information
companyId	Cova company identifier.	integer	Required
locationid	Cova location identifier.	integer	Required

Payment refund request.

Name	Description	Type	Additional information
RefundReference	Recommended to supply the original order reference to assist in retailer reconciliation	string	None.
RequestedAmount	A positive, decimal number (with 2 decimal digits) representing the amount to refund. Must be lower than or equal to the original charge amount. Over-refund fails asynchronously and is not raised to the caller.	decimal number	None.
SessionId	The original Cova Pay session id, captured from the payment session	string	None.

Sample:

{
  "RefundReference": "sample string 1",
  "RequestedAmount": 2.0,
  "SessionId": "sample string 3"
}

Name	Description	Type	Additional information
Id	Refund identifier	globally unique identifier	None.

Sample:

{
  "Id": "f9db481f-4f05-4590-9b07-18e34b970ee8"
}