|
— |
developer:soap-1.6:objects:creditcarddata [2012/07/03 10:00] (current)
tem created |
| | + | <embed ..:contents/>====== CreditCardData ====== |
| | + | |
| | + | This object contains credit card specific information for a transaction. |
| | + | |
| | + | ===== Description ===== |
| | + | |
| | + | When retrieving stored CreditCardData from the gateway with a function like [[..:methods:getTransaction]], 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. |
| | + | |
| | + | |
| | + | ===== Properties ===== |
| | + | |
| | + | ^Type ^Name ^Description ^ |
| | + | |string |CardType |Card Type - describes card issuer (Visa, MC, Amex, Discover). Read only property (ignored if sent as a parameter to transaction methods).| |
| | + | |string |CardNumber |Card Number| |
| | + | |string |CardExpiration |Expiration Date - Should be set to 4 digit MMYY.| |
| | + | |string |CardCode |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.| |
| | + | |string |AvsStreet |Billing address associated with card, used by AVS.| |
| | + | |string |AvsZip |Billing zipcode associated with card, used by AVS.| |
| | + | |boolean |CardPresent |Indicates if the card is present during the transaction (ie: the card was swiped at a POS terminal). Used to indicate retail.| |
| | + | |string |MagStripe |Raw Track 1 and/or Track 2 data for swiped transactions.| |
| | + | |string |DUKPT |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. | |
| | + | |string |Signature | Signature capture image. Base64 encoded. | |
| | + | |string |TermType |Terminal type (POS, StandAlone, Unattended, or Unkown). May be left blank if unknown.| |
| | + | |string |MagSupport |Indicates whether software has support for mag swipe (Yes, No, Unknown).| |
| | + | |string |XID |XID value received from 3rd party Visa VPAS or MC UCAF.| |
| | + | |string |CAVV |CAVV value received from 3rd party Visa VPAS or MC UCAF.| |
| | + | |integer |ECI |ECI value.| |
| | + | |boolean |InternalCardAuth |Use gateway based authentication for Visa VPAS or MC UCAF.| |
| | + | |string |Pares |Pares returned by client after successful authentication.| |
| | + | |
| | + | ===== Places Used ===== |
| | + | |
| | + | |
| | + | [[..:objects:PaymentMethod]] |
| | + | |
| | + | [[..:objects:TransactionObject]] |
| | + | |
| | + | [[..:objects:TransactionRequestObject]] |
| | + | |
| | + | |
| | + | ===== Examples ===== |
| | + | |
| | + | ==== PHP ==== |
| | + | |
| | + | <code php> |
| | + | <?php |
| | + | // for directions on how to set up the |
| | + | // WSDL link and create "$token" and "$client," |
| | + | // see: http://wiki.usaepay.com/developer/soap/howto/php |
| | + | |
| | + | $CreditCardData=array( |
| | + | 'CardNumber' => '4444555566667779', |
| | + | 'CardExpiration' => '0909', |
| | + | 'AvsStreet' => '1234 Main Street', |
| | + | 'AvsZip' => '99281', |
| | + | 'CardCode' => '999' |
| | + | ); |
| | + | |
| | + | $Request=array( |
| | + | 'AccountHolder' => 'Example Creator', |
| | + | 'ClientIP' => '123.123.123.123', |
| | + | 'CustomerID' => '123456', |
| | + | 'Command' => 'Sale', |
| | + | 'Details' => array( |
| | + | 'Amount' => '29.00', |
| | + | 'Clerk' => 'John Doe', |
| | + | 'Currency' => '0', |
| | + | 'Description' => 'Example for CreditCardData object', |
| | + | 'Discount' => '1.00', |
| | + | 'Invoice' => '44539'), |
| | + | 'CreditCardData' => $CreditCardData |
| | + | ); |
| | + | |
| | + | $Response=$this->client->runTransaction($this->token, $Request); |
| | + | |
| | + | $TransactionObject=$this->client->getTransaction($this->token, $Response->RefNum); |
| | + | |
| | + | echo $TransactionObject->CreditCardData->AvsZip; |
| | + | |
| | + | ?> |
| | + | </code> |
| | + | |
| | + | ==== .NET VB ==== |
| | + | <code vb> |
| | + | Dim tran As usaepay.TransactionRequestObject = New usaepay.TransactionRequestObject |
| | + | tran.CreditCardData = New usaepay.CreditCardData |
| | + | tran.CreditCardData.CardNumber = "4444555566667779" |
| | + | tran.CreditCardData.CardExpiration = "0913" |
| | + | tran.CreditCardData.CardCode = "999" |
| | + | |
| | + | </code> |
| | + | |
| | + | ==== .NET C# ==== |
| | + | <code c> |
| | + | usaepay.TransactionRequestObject tran = new usaepay.TransactionRequestObject(); |
| | + | |
| | + | tran.CreditCardData = new usaepay.CreditCardData(); |
| | + | tran.CreditCardData.CardNumber = "4444555566667779"; |
| | + | tran.CreditCardData.CardExpiration = "0909"; |
| | + | |
| | + | </code> |
| | + | |
| | + | ==== XML ==== |
| | + | |
| | + | <code xml> |
| | + | <CreditCardData xsi:type="ns1:CreditCardData"> |
| | + | <AvsStreet xsi:type="xsd:string">1234 Main Street</AvsStreet> |
| | + | <AvsZip xsi:type="xsd:string">99281</AvsZip> |
| | + | <CardCode xsi:type="xsd:string">XXX</CardCode> |
| | + | <CardExpiration xsi:type="xsd:string">XXXX</CardExpiration> |
| | + | <CardNumber xsi:type="xsd:string">XXXXXXXXXXXX7779</CardNumber> |
| | + | <CardPresent xsi:type="xsd:boolean">false</CardPresent> |
| | + | <CardType xsi:type="xsd:string">V</CardType> |
| | + | <InternalCardAuth xsi:type="xsd:boolean">false</InternalCardAuth> |
| | + | <MagStripe xsi:type="xsd:string"></MagStripe> |
| | + | <MagSupport xsi:type="xsd:string"></MagSupport> |
| | + | <Pares xsi:type="xsd:string"></Pares> |
| | + | <TermType xsi:type="xsd:string"></TermType> |
| | + | </CreditCardData> |
| | + | </code> |
| | + | |
| | + | ===== Change Log ===== |
| | + | |
| | + | ^Version ^Change ^ |
| | + | |[[developer:soap-1.1:objects:creditcarddata|1.1]] | Added DUKPT parameter for pin-debit transactions, Signature parameter for signature capture. | |
| | | | |
