GET v1/companies/{companyId}/ecomm-payments/{sessionId}

Returns the status of an integrated online payment

Request Information

URI Parameters

Name	Description	Type	Additional information
companyId	Cova company identifier	integer	Required
sessionId	Unique Cova Pay payment session identifier	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

CovaEcommPaymentStatusResponse

Name	Description	Type	Additional information
Id	The original Cova Pay session id, captured from the payment session	globally unique identifier	None.
LocationId	The Id of the location that the payment occurred at	integer	None.
Status	The status of the payment	EcommPaymentStatus	None.
FailureReason	If the payment failed to initiate this will contain the reason it failed. Otherwise, it will be an empty string	string	None.
StoreReference	The Adyen Store reference for the location	string	None.
OrderReference	Unique string, such as the customer facing “order number” that will appear in reporting as the reference number to the transaction	string	None.
ReturnUrl	A URL that redirects the shopper back to your site, after payment	string	None.
Currency	The currency for the payment	CurrencyType	None.
Amount	The requested amount of the payment	decimal number	None.
CreatedDate	The date and time that the payment was initiated	date	None.
Results	A list of all card attempts made for this payment	Collection of CovaEcommPaymentResult	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": "15e531e0-467a-408b-b6d8-c24a6e8df66a",
  "LocationId": 2,
  "Status": 0,
  "FailureReason": "sample string 3",
  "StoreReference": "sample string 4",
  "OrderReference": "sample string 5",
  "ReturnUrl": "sample string 6",
  "Currency": 0,
  "Amount": 7.0,
  "CreatedDate": "2025-11-21T14:53:19.7542197+00:00",
  "Results": [
    {
      "AuthorizationCode": "sample string 1",
      "AuthorizedAmount": 2.0,
      "Succeeded": true,
      "CardType": "sample string 4",
      "Last4Digits": "sample string 5",
      "TransactionTime": "2025-11-21T14:53:19.7542197+00:00",
      "PspReference": "sample string 7",
      "ShopperEmail": "sample string 8",
      "Message": "sample string 9"
    },
    {
      "AuthorizationCode": "sample string 1",
      "AuthorizedAmount": 2.0,
      "Succeeded": true,
      "CardType": "sample string 4",
      "Last4Digits": "sample string 5",
      "TransactionTime": "2025-11-21T14:53:19.7542197+00:00",
      "PspReference": "sample string 7",
      "ShopperEmail": "sample string 8",
      "Message": "sample string 9"
    }
  ]
}