DELETE api/Commerce

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
CreditCardId	integer	None.
CardNumber	string	None.
CardType	CreditCardType	None.
SecurityCode	string	None.
ExpiryMonth	integer	None.
ExpiryYear	integer	None.
CardExpiry	string	None.
NameOnCard	string	None.
EmailAddress	string	None.
Address1	string	None.
Address2	string	None.
City	string	None.
StateId	integer	None.
StateName	string	None.
CountryId	integer	None.
CountryName	string	None.
Zip	string	None.
PhoneNumber	string	None.
UserId	integer	None.
TransactionId	string	None.
PaymentProfileId	integer	None.
CustomerProfileId	integer	None.
ChargeAmount	decimal number	None.
IPAddress	string	None.
ResponseXML	string	None.
IsPaymentDue	boolean	None.
AuthCode	string	None.
IsProcessed	boolean	None.
PaidTime	date	None.
PaymentMethod	string	None.
OperationStatus	StatusType	None.
SiteName	string	None.
ProductCode	string	None.
ErrorMessages	Collection of ErrorMessage	None.
PaymentProcessor	string	None.
PaymentProcessorId	integer	None.
SecretKey	string	None.
AccessKey	string	None.
IsVoided	boolean	None.
IsPaymentProcessorActive	boolean	None.
Description	string	None.
CCInvoiceNumber	string	None.
AuthKey	string	None.
IsCCAuthorize	boolean	None.
UserId_Guid	globally unique identifier	None.

Request Formats

application/json, text/json

Sample:

{
  "CreditCardId": 1,
  "CardNumber": "sample string 2",
  "CardType": 0,
  "SecurityCode": "sample string 3",
  "ExpiryMonth": 4,
  "ExpiryYear": 5,
  "CardExpiry": "sample string 6",
  "NameOnCard": "sample string 7",
  "EmailAddress": "sample string 8",
  "Address1": "sample string 9",
  "Address2": "sample string 10",
  "City": "sample string 11",
  "StateId": 12,
  "StateName": "sample string 13",
  "CountryId": 14,
  "CountryName": "sample string 15",
  "Zip": "sample string 16",
  "PhoneNumber": "sample string 17",
  "UserId": 18,
  "TransactionId": "sample string 19",
  "PaymentProfileId": 20,
  "CustomerProfileId": 21,
  "ChargeAmount": 22.0,
  "IPAddress": "sample string 23",
  "ResponseXML": "sample string 24",
  "IsPaymentDue": true,
  "AuthCode": "sample string 26",
  "IsProcessed": true,
  "PaidTime": "2026-04-18T06:32:10.2596781-04:00",
  "PaymentMethod": "sample string 29",
  "OperationStatus": 0,
  "SiteName": "sample string 30",
  "ProductCode": "sample string 31",
  "ErrorMessages": [
    {
      "ErrorCode": "sample string 1",
      "LongMessage": "sample string 2",
      "SeverityCode": 0,
      "ShortMessage": "sample string 3"
    },
    {
      "ErrorCode": "sample string 1",
      "LongMessage": "sample string 2",
      "SeverityCode": 0,
      "ShortMessage": "sample string 3"
    }
  ],
  "PaymentProcessor": "sample string 32",
  "PaymentProcessorId": 33,
  "SecretKey": "sample string 34",
  "AccessKey": "sample string 35",
  "IsVoided": true,
  "IsPaymentProcessorActive": true,
  "Description": "sample string 38",
  "CCInvoiceNumber": "sample string 39",
  "AuthKey": "sample string 40",
  "IsCCAuthorize": true,
  "UserId_Guid": "19b946ce-059c-478b-99cb-d273d5af31cc"
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

boolean

Response Formats

application/json, text/json

Sample:

true

application/xml, text/xml

Sample:

<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>