{"_id":"5632a5ea49e16d0d00122489","__v":0,"category":{"_id":"5632a5e749e16d0d0012244d","__v":1,"pages":["5632a5ea49e16d0d00122481","5632a5ea49e16d0d00122482","5632a5ea49e16d0d00122483","5632a5ea49e16d0d00122484","5632a5ea49e16d0d00122485","5632a5ea49e16d0d00122486","5632a5ea49e16d0d00122487","5632a5ea49e16d0d00122488","5632a5ea49e16d0d00122489","5632a5ea49e16d0d0012248a","5632a5ea49e16d0d0012248b","5632a5ea49e16d0d0012248c","5632a5ea49e16d0d0012248d","5632a5ea49e16d0d0012248e","5632a5ea49e16d0d0012248f","5632a5ea49e16d0d00122490","5632a5ea49e16d0d00122491","5632a5ea49e16d0d00122492","5632a5ea49e16d0d00122493","5632a5ea49e16d0d00122494","5632a5ea49e16d0d00122495","5632a5ea49e16d0d00122496","5632a5ea49e16d0d00122497","5632a5ea49e16d0d00122498","5632a5ea49e16d0d00122499","5632a5ea49e16d0d0012249a","5632a5ea49e16d0d0012249b","5632a5ea49e16d0d0012249c","5632a5ea49e16d0d0012249d","5632a5ea49e16d0d0012249e","5632a5ea49e16d0d0012249f","5632a5ea49e16d0d001224a0","5632a5ea49e16d0d001224a1","5632a5ea49e16d0d001224a2","5632a5ea49e16d0d001224a3","5632a5ea49e16d0d001224a4","5632a5ea49e16d0d001224a5","5632a5ea49e16d0d001224a6","5632a5ea49e16d0d001224a7"],"project":"55b933b3146ef121002158d3","version":"5632a5e549e16d0d00122443","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-08-04T17:34:02.800Z","from_sync":false,"order":12,"slug":"objects","title":"Objects"},"githubsync":"","user":"55b932ba8fd1a02b00f496c8","project":"55b933b3146ef121002158d3","version":{"_id":"5632a5e549e16d0d00122443","__v":6,"project":"55b933b3146ef121002158d3","createdAt":"2015-10-29T23:04:05.701Z","releaseDate":"2015-10-29T23:04:05.701Z","categories":["5632a5e749e16d0d00122444","5632a5e749e16d0d00122445","5632a5e749e16d0d00122446","5632a5e749e16d0d00122447","5632a5e749e16d0d00122448","5632a5e749e16d0d00122449","5632a5e749e16d0d0012244a","5632a5e749e16d0d0012244b","5632a5e749e16d0d0012244c","5632a5e749e16d0d0012244d","5632a5e749e16d0d0012244e","5632a5e749e16d0d0012244f","5632a5e749e16d0d00122450","5632b179df556c0d00cd095b","564e13053b2b4a19000cd69b","59caa9df65accc001a489c95","59cab50965accc001a489d28","59cadd464ab7b70024378e74"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.1.0","version":"1.1"},"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-04T17:52:16.498Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":8,"body":"This object contains credit card specific information for a transaction.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Description\"\n}\n[/block]\nWhen retrieving stored CreditCardData from the gateway with a function like [getTransaction](/docs/get-transactions), many of the properties such as CardNumber, CardExpiration and MagStripe will be masked for security reasons. Full, unmasked, credit card data can not be retrieved via the Soap API.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Properties\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Type\",\n    \"h-1\": \"Name\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"string\",\n    \"0-1\": \"CardType\",\n    \"0-2\": \"Card Type - describes card issuer (Visa, MC, Amex, Discover). Read only property (ignored if sent as a parameter to transaction methods).\",\n    \"1-0\": \"string\",\n    \"1-1\": \"CardNumber\",\n    \"1-2\": \"Card Number\",\n    \"2-0\": \"string\",\n    \"2-1\": \"CardExpiration\",\n    \"2-2\": \"Expiration Date - Should be set to 4 digit MMYY.\",\n    \"3-0\": \"string\",\n    \"3-1\": \"CardCode\",\n    \"3-2\": \"CVV2/CID card code value from back of card. Set to -2 if the code is not legible, -9 if the code is not on the card.\",\n    \"4-0\": \"string\",\n    \"4-1\": \"AvsStreet\",\n    \"4-2\": \"Billing address associated with card, used by AVS.\",\n    \"5-0\": \"string\",\n    \"5-1\": \"AvsZip\",\n    \"5-2\": \"Billing zipcode associated with card, used by AVS.\",\n    \"6-0\": \"boolean\",\n    \"6-1\": \"CardPresent\",\n    \"6-2\": \"Indicates if the card is present during the transaction (ie: the card was swiped at a POS terminal). Used to indicate retail.\",\n    \"7-0\": \"string\",\n    \"7-1\": \"MagStripe\",\n    \"7-2\": \"Raw Track 1 and/or Track 2 data for swiped transactions. Base64 encode the raw data you are getting from the device (no need to parse it or clean it up), then put enc:// at the beginning and pass it the MagStripe field.\",\n    \"8-0\": \"string\",\n    \"8-1\": \"DUKPT\",\n    \"8-2\": \"DUKPT encrypted pin block. Only required for pin debit transactions. The first 16 characters are the encrypted pin block, followed by the 6 character long Key Set Identifier (KSID). The remaining characters are the Pin Pad serial number and transaction counter.\",\n    \"9-0\": \"string\",\n    \"9-1\": \"Signature\",\n    \"9-2\": \"Signature capture image. Base64 encoded.\",\n    \"10-0\": \"string\",\n    \"10-1\": \"TermType\",\n    \"10-2\": \"Terminal type (POS, StandAlone, Unattended, or Unkown). May be left blank if unknown.\",\n    \"11-0\": \"string\",\n    \"11-1\": \"MagSupport\",\n    \"11-2\": \"Indicates whether software has support for mag swipe (Yes, No, Unknown).\",\n    \"12-0\": \"string\",\n    \"12-1\": \"XID\",\n    \"12-2\": \"XID value received from 3rd party Visa VPAS or MC UCAF.\",\n    \"13-0\": \"string\",\n    \"13-1\": \"CAVV\",\n    \"13-2\": \"CAVV value received from 3rd party Visa VPAS or MC UCAF.\",\n    \"14-0\": \"integer\",\n    \"14-1\": \"ECI\",\n    \"14-2\": \"ECI value.\",\n    \"15-0\": \"boolean\",\n    \"15-1\": \"InternalCardAuth\",\n    \"15-2\": \"Use gateway based authentication for Visa VPAS or MC UCAF.\",\n    \"16-0\": \"string\",\n    \"16-1\": \"Pares\",\n    \"16-2\": \"Pares returned by client after successful authentication.\"\n  },\n  \"cols\": 3,\n  \"rows\": 17\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Examples\"\n}\n[/block]\n## PHP \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<?php\\n// for directions on how to set up the  \\n// WSDL link and create \\\"$token\\\" and \\\"$client,\\\"\\n// see: http://wiki.eBizCharge.com/developer/soap/howto/php\\n$CreditCardData=array(\\n       'CardNumber' => '4444555566667779',\\n       'CardExpiration' => '0909',\\n       'AvsStreet' => '1234 Main Street',\\n       'AvsZip' => '99281',\\n       'CardCode' => '999'\\n);                \\n$Request=array(\\n 'AccountHolder' => 'Example Creator',\\n 'ClientIP' => '123.123.123.123',\\n 'CustomerID' => '123456',\\n 'Command' => 'Sale',\\n 'Details' => array(\\n       'Amount' => '29.00',\\n       'Clerk' => 'John Doe',\\n       'Currency' => '0',\\n       'Description' => 'Example for CreditCardData object',\\n       'Discount' => '1.00',\\n       'Invoice' => '44539'),\\n 'CreditCardData' => $CreditCardData\\n);\\n$Response=$this->client->runTransaction($this->token, $Request);\\n$TransactionObject=$this->client->getTransaction($this->token, $Response->RefNum);\\necho $TransactionObject->CreditCardData->AvsZip;\\n?>\",\n      \"language\": \"php\"\n    }\n  ]\n}\n[/block]\n## Visual Basic (.Net) \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Dim tran As eBizCharge.TransactionRequestObject = New eBizCharge.TransactionRequestObject\\n       tran.CreditCardData = New eBizCharge.CreditCardData\\n       tran.CreditCardData.CardNumber = \\\"4444555566667779\\\"\\n       tran.CreditCardData.CardExpiration = \\\"0913\\\"\\n       tran.CreditCardData.CardCode = \\\"999\\\"\",\n      \"language\": \"asp\"\n    }\n  ]\n}\n[/block]\n## C Sharp (.Net)\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"eBizCharge.TransactionRequestObject tran = new eBizCharge.TransactionRequestObject();\\ntran.CreditCardData = new eBizCharge.CreditCardData();\\ntran.CreditCardData.CardNumber = \\\"4444555566667779\\\";\\ntran.CreditCardData.CardExpiration = \\\"0909\\\";\",\n      \"language\": \"csharp\"\n    }\n  ]\n}\n[/block]\n## XML \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<CreditCardData xsi:t\\nype=\\\"ns1:CreditCardData\\\">\\n<AvsStreet xsi:type=\\\"xsd:string\\\">1234 Main Street</AvsStreet>\\n<AvsZip xsi:type=\\\"xsd:string\\\">99281</AvsZip>\\n<CardCode xsi:type=\\\"xsd:string\\\">XXX</CardCode>\\n<CardExpiration xsi:type=\\\"xsd:string\\\">XXXX</CardExpiration>\\n<CardNumber xsi:type=\\\"xsd:string\\\">XXXXXXXXXXXX7779</CardNumber>\\n<CardPresent xsi:type=\\\"xsd:boolean\\\">false</CardPresent>\\n<CardType xsi:type=\\\"xsd:string\\\">V</CardType>\\n<InternalCardAuth xsi:type=\\\"xsd:boolean\\\">false</InternalCardAuth>\\n<MagStripe xsi:type=\\\"xsd:string\\\"></MagStripe>\\n<MagSupport xsi:type=\\\"xsd:string\\\"></MagSupport>\\n<Pares xsi:type=\\\"xsd:string\\\"></Pares>\\n<TermType xsi:type=\\\"xsd:string\\\"></TermType>\\n</CreditCardData>\",\n      \"language\": \"xml\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"creditcarddata","type":"basic","title":"CreditCardData"}
This object contains credit card specific information for a transaction. [block:api-header] { "type": "basic", "title": "Description" } [/block] When retrieving stored CreditCardData from the gateway with a function like [getTransaction](/docs/get-transactions), many of the properties such as CardNumber, CardExpiration and MagStripe will be masked for security reasons. Full, unmasked, credit card data can not be retrieved via the Soap API. [block:api-header] { "type": "basic", "title": "Properties" } [/block] [block:parameters] { "data": { "h-0": "Type", "h-1": "Name", "h-2": "Description", "0-0": "string", "0-1": "CardType", "0-2": "Card Type - describes card issuer (Visa, MC, Amex, Discover). Read only property (ignored if sent as a parameter to transaction methods).", "1-0": "string", "1-1": "CardNumber", "1-2": "Card Number", "2-0": "string", "2-1": "CardExpiration", "2-2": "Expiration Date - Should be set to 4 digit MMYY.", "3-0": "string", "3-1": "CardCode", "3-2": "CVV2/CID card code value from back of card. Set to -2 if the code is not legible, -9 if the code is not on the card.", "4-0": "string", "4-1": "AvsStreet", "4-2": "Billing address associated with card, used by AVS.", "5-0": "string", "5-1": "AvsZip", "5-2": "Billing zipcode associated with card, used by AVS.", "6-0": "boolean", "6-1": "CardPresent", "6-2": "Indicates if the card is present during the transaction (ie: the card was swiped at a POS terminal). Used to indicate retail.", "7-0": "string", "7-1": "MagStripe", "7-2": "Raw Track 1 and/or Track 2 data for swiped transactions. Base64 encode the raw data you are getting from the device (no need to parse it or clean it up), then put enc:// at the beginning and pass it the MagStripe field.", "8-0": "string", "8-1": "DUKPT", "8-2": "DUKPT encrypted pin block. Only required for pin debit transactions. The first 16 characters are the encrypted pin block, followed by the 6 character long Key Set Identifier (KSID). The remaining characters are the Pin Pad serial number and transaction counter.", "9-0": "string", "9-1": "Signature", "9-2": "Signature capture image. Base64 encoded.", "10-0": "string", "10-1": "TermType", "10-2": "Terminal type (POS, StandAlone, Unattended, or Unkown). May be left blank if unknown.", "11-0": "string", "11-1": "MagSupport", "11-2": "Indicates whether software has support for mag swipe (Yes, No, Unknown).", "12-0": "string", "12-1": "XID", "12-2": "XID value received from 3rd party Visa VPAS or MC UCAF.", "13-0": "string", "13-1": "CAVV", "13-2": "CAVV value received from 3rd party Visa VPAS or MC UCAF.", "14-0": "integer", "14-1": "ECI", "14-2": "ECI value.", "15-0": "boolean", "15-1": "InternalCardAuth", "15-2": "Use gateway based authentication for Visa VPAS or MC UCAF.", "16-0": "string", "16-1": "Pares", "16-2": "Pares returned by client after successful authentication." }, "cols": 3, "rows": 17 } [/block] [block:api-header] { "type": "basic", "title": "Examples" } [/block] ## PHP [block:code] { "codes": [ { "code": "<?php\n// for directions on how to set up the \n// WSDL link and create \"$token\" and \"$client,\"\n// see: http://wiki.eBizCharge.com/developer/soap/howto/php\n$CreditCardData=array(\n 'CardNumber' => '4444555566667779',\n 'CardExpiration' => '0909',\n 'AvsStreet' => '1234 Main Street',\n 'AvsZip' => '99281',\n 'CardCode' => '999'\n); \n$Request=array(\n 'AccountHolder' => 'Example Creator',\n 'ClientIP' => '123.123.123.123',\n 'CustomerID' => '123456',\n 'Command' => 'Sale',\n 'Details' => array(\n 'Amount' => '29.00',\n 'Clerk' => 'John Doe',\n 'Currency' => '0',\n 'Description' => 'Example for CreditCardData object',\n 'Discount' => '1.00',\n 'Invoice' => '44539'),\n 'CreditCardData' => $CreditCardData\n);\n$Response=$this->client->runTransaction($this->token, $Request);\n$TransactionObject=$this->client->getTransaction($this->token, $Response->RefNum);\necho $TransactionObject->CreditCardData->AvsZip;\n?>", "language": "php" } ] } [/block] ## Visual Basic (.Net) [block:code] { "codes": [ { "code": "Dim tran As eBizCharge.TransactionRequestObject = New eBizCharge.TransactionRequestObject\n tran.CreditCardData = New eBizCharge.CreditCardData\n tran.CreditCardData.CardNumber = \"4444555566667779\"\n tran.CreditCardData.CardExpiration = \"0913\"\n tran.CreditCardData.CardCode = \"999\"", "language": "asp" } ] } [/block] ## C Sharp (.Net) [block:code] { "codes": [ { "code": "eBizCharge.TransactionRequestObject tran = new eBizCharge.TransactionRequestObject();\ntran.CreditCardData = new eBizCharge.CreditCardData();\ntran.CreditCardData.CardNumber = \"4444555566667779\";\ntran.CreditCardData.CardExpiration = \"0909\";", "language": "csharp" } ] } [/block] ## XML [block:code] { "codes": [ { "code": "<CreditCardData xsi:t\nype=\"ns1:CreditCardData\">\n<AvsStreet xsi:type=\"xsd:string\">1234 Main Street</AvsStreet>\n<AvsZip xsi:type=\"xsd:string\">99281</AvsZip>\n<CardCode xsi:type=\"xsd:string\">XXX</CardCode>\n<CardExpiration xsi:type=\"xsd:string\">XXXX</CardExpiration>\n<CardNumber xsi:type=\"xsd:string\">XXXXXXXXXXXX7779</CardNumber>\n<CardPresent xsi:type=\"xsd:boolean\">false</CardPresent>\n<CardType xsi:type=\"xsd:string\">V</CardType>\n<InternalCardAuth xsi:type=\"xsd:boolean\">false</InternalCardAuth>\n<MagStripe xsi:type=\"xsd:string\"></MagStripe>\n<MagSupport xsi:type=\"xsd:string\"></MagSupport>\n<Pares xsi:type=\"xsd:string\"></Pares>\n<TermType xsi:type=\"xsd:string\"></TermType>\n</CreditCardData>", "language": "xml" } ] } [/block]