OrderTransactionCardDataDTO Object

Overview

The REST API occasionally makes use of the OrderTransactionCardDataDTO object whenever a gift card is used with a transaction.  This article will help you to know the various members of this object.

Requirements

The following pre-requisites will be necessary to accomplish the goals of this article:

  • General understanding of REST and API’s
  • Understanding of C# and/or JavaScript

Getting Started

There are no tasks needed to get started with understanding this object. 

OrderTransactionCardDataDTO

The OrderTransactionCardDataDTO object will contain all of the PA-DSS compliant details of a credit card used in a transaction for your Hotcakes Commerce store.

Members

The following table gives you details on the various members of the OrderTransactionCardDataDTO object.  The descriptions are based upon default functionality and the default Viewset included with Hotcakes.

Member Default Description
CardHolderName (empty string) The name of the credit card holder as it appears on the card.
CardIsEncrypted False Used to tell the API if the card number is encrypted or not.
CardNumber (empty string) The number of the credit card.
ExpirationMonth 1 The month that the credit card will expire.
ExpirationYear 1900 The year that the credit card will expire.

 

Example of OrderTransactionCardDataDTO

{
   "CreditCard":{
      "CardHolderName":"John Dough",
      "CardIsEncrypted":true,
      "CardNumber":"cZlVtIuNFBR8Pd4hNKjKLfXWktGtw16SRwZwsLqYryB8p1Yz+/3cPawJ7DHXoUp++xmWGByL7LJeC3mrvMsbq4Kjw0ui23R9oJUsoopMB/Y=",
      "ExpirationMonth":10,
      "ExpirationYear":2022
   }
}
Have more questions? Submit a request

Need More Help?

Do you need more assistance with this article? Please review your support options.