POST v1/CovaOrderPayment

This Call Marks a Sales Order as PaidWaitingForCompletion at the Location specified within the Company

Information:

Base URL:

https://api.covasoft.net/covaorderintake

Example of a call would be:

https://api.covasoft.net/covaorderintake/v1/CovaOrderPayment

Request Information

URI Parameters

None.

Body Parameters

Details needed for the Cova Order Payment intake

CovaSalesOrderPaymentPost

Name	Description	Type	Additional information
SaleID	The OrderId submitted/returned when creating an order	globally unique identifier	None.
CompanyId		integer	None.
TrackingNumber	Required. Delivery identifier: driver name/phone/id, shipping\mailing tracking number. If not applicable, supply some sort of order reference (your internal id, perhaps) or "N/A"	string	None.
Payments		Collection of Payment	None.

Request Formats

application/json, text/json

Sample:

{
  "SaleID": "3498e172-4ca1-4517-b8ec-5a3b14d39290",
  "CompanyId": 2,
  "TrackingNumber": "sample string 3",
  "Payments": [
    {
      "PreAuthorizationToken": "sample string 1",
      "Amount": 2.1,
      "TimeTakenUtc": "2024-11-07T08:58:07.4437662+00:00",
      "Last4Digits": "sample string 4"
    },
    {
      "PreAuthorizationToken": "sample string 1",
      "Amount": 2.1,
      "TimeTakenUtc": "2024-11-07T08:58:07.4437662+00:00",
      "Last4Digits": "sample string 4"
    }
  ]
}

Response Information

Resource Description

CovaSalesOrderPaymentPost

Name	Description	Type	Additional information
SaleID	The OrderId submitted/returned when creating an order	globally unique identifier	None.
CompanyId		integer	None.
TrackingNumber	Required. Delivery identifier: driver name/phone/id, shipping\mailing tracking number. If not applicable, supply some sort of order reference (your internal id, perhaps) or "N/A"	string	None.
Payments		Collection of Payment	None.

Response Formats

application/json, text/json

Sample:

{
  "SaleID": "38813140-613e-4f20-bb9f-29799ba780a4",
  "CompanyId": 2,
  "TrackingNumber": "sample string 3",
  "Payments": [
    {
      "PreAuthorizationToken": "sample string 1",
      "Amount": 2.1,
      "TimeTakenUtc": "2024-11-07T08:58:07.4437662+00:00",
      "Last4Digits": "sample string 4"
    },
    {
      "PreAuthorizationToken": "sample string 1",
      "Amount": 2.1,
      "TimeTakenUtc": "2024-11-07T08:58:07.4437662+00:00",
      "Last4Digits": "sample string 4"
    }
  ]
}