GET v1/companies/{companyId}/ecomm-refunds/{id}

Returns the status of an integrated online refund.

Request Information

URI Parameters

Name	Description	Type	Additional information
companyId	Cova company identifier	integer	Required
id	Unique Cova Pay refund identifier	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

CovaEcommRefundStatusResponse

Name	Description	Type	Additional information
Id	Refund identifier - generated	globally unique identifier	None.
LocationId	The Id of the location that the refund occurred at	integer	None.
Status	The status of the refund	EcommRefundStatus	None.
FailureReason	If the refund failed to initiate this will contain the reason it failed. Otherwise, it will be an empty string	string	None.
RefundReference	Recommended to supply the original order reference to assist in retailer reconciliation	string	None.
PaymentId	The original Cova Pay session id, captured from the payment session	globally unique identifier	None.
Currency	The currency for the refund	CurrencyType	None.
RequestedAmount	The requested amount of the refund	decimal number	None.
PaymentPspReference	The Adyen PSP reference of the Ecomm payment that was refunded	string	None.
CreatedDate	The date and time that the refund was initiated	date	None.
Result	Additional information about a completed refund This will be null if the refund failed to initiate or has not yet completed	CovaEcommRefundResult	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": "3c65ee45-4c4c-4881-82be-1abd8d5d5ce9",
  "LocationId": 2,
  "Status": 0,
  "FailureReason": "sample string 3",
  "RefundReference": "sample string 4",
  "PaymentId": "33cb8dcd-ab94-4eb8-82e7-8955f0070fd5",
  "Currency": 0,
  "RequestedAmount": 6.0,
  "PaymentPspReference": "sample string 7",
  "CreatedDate": "2025-11-21T14:53:18.5624176+00:00",
  "Result": {
    "AuthorizedAmount": 1.0,
    "Succeeded": true,
    "CardType": "sample string 3",
    "Last4Digits": "sample string 4",
    "TransactionTime": "2025-11-21T14:53:18.5624176+00:00",
    "PspReference": "sample string 6",
    "Message": "sample string 7"
  }
}