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

The first step toward taking an integrated online payment

Request Information

URI Parameters

NameDescriptionTypeAdditional information
companyId

Cova company identifier.

 integer

Required
locationid

Cova location identifier.

 integer

Required

Body Parameters

Payment session request.

CovaPayCheckoutSessionRequest
NameDescriptionTypeAdditional information
OrderReference

Unique string, such as the customer facing “order number” that will appear in reporting as the reference number to the transaction

 string

None.
Amount

A positive, decimal number (with 2 decimal digits) representing the amount to charge the card.

 decimal number

None.
ReturnUrl

A URL that redirects the shopper back to your site, after payment

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "OrderReference": "sample string 1",
  "Amount": 2.0,
  "ReturnUrl": "sample string 3"
}

Response Information

Resource Description

CovaPayCheckoutSessionReponse
NameDescriptionTypeAdditional information
sessionId

Unique Cova Pay session identifier - generated

 string

None.
id

Unique Adyen session identifier - generated

 string

None.
sessionData

A string of encoded data needed to initialize web components

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "sessionId": "sample string 1",
  "id": "sample string 2",
  "sessionData": "sample string 3"
}