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

Refund a full or partial payment

Request Information

URI Parameters

NameDescriptionTypeAdditional information
companyId

Cova company identifier.

 integer

Required
locationid

Cova location identifier.

 integer

Required

Body Parameters

Payment refund request.

CovaPayRefundRequest
NameDescriptionTypeAdditional 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.

Request Formats

application/json, text/json

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

Response Information

Resource Description

CovaPayRefundResponse
NameDescriptionTypeAdditional information
Id

Refund identifier

 globally unique identifier

None.

Response Formats

application/json, text/json

Sample: 
{
  "Id": "e3c13551-116a-483f-8f58-89b5ea152f88"
}