complexType CaptureInfo
diagram index_p19.png
namespace http://www.ibillingclient.org/schema/edi
type extension of ClientObject
properties
base ClientObject
used by
element AssetTransaction/captureInfo
attributes
Name  Type  Use  Default  Fixed  annotation
idxs:IDrequired      
documentation
id: System generated identifier.
createDateDateoptional      
documentation
createDate: Date the transaction was created.
codexs:stringrequired      
documentation
code: User assigned identifier. (if not specified, id is used)
merchantAccountCodeMerchantAccountCoderequired      
documentation
merchantAccountCode: Merchant account code.
requestDateDateoptional      
documentation
requestDate: Date when the request was sent to processor.
responseDateDateoptional      
documentation
responseDate: Date when the response from the processor was received.
holderNamexs:stringoptional      
documentation
holderName: Name on the credit card or bank account's holder's name.
taxAmountxs:intoptional      
documentation
taxAmount: Tax amount if available (part of total amount).
streetxs:stringoptional      
documentation
street: Street of the billing address.
cityxs:stringoptional      
documentation
city: City of the billing address.
statexs:stringoptional      
documentation
state: State (two-letter code) of the billing address.
phonexs:stringoptional      
documentation
phone: Phone of the billing address.
zipCodexs:stringoptional      
documentation
zipCode: ZipCode of the billing address.
emailxs:stringoptional      
documentation
email: E-mail associated with holder of the card/bank account.
returnTypeReturnTypeoptional      
documentation
returnType: Code defining response type generated by the processor.
approvalCodexs:stringoptional      
documentation
approvalCode: Approval reference code generated by the processor in case of successfulauthorization (credit card only).
referenceNumberxs:stringoptional      
documentation
referenceNumber: Reference number of the transaction represented by this CaptureInfo inthe processor's system (used to issue same-day voids).
accountNumberxs:stringoptional      
documentation
accountNumber: Credit card number if credit card; bank account number if bank account.
accessoryxs:stringoptional      
documentation
accessory: Expiration date (MMyy) if credit card; routing number if bank account.
transactionTypeAssetTransactionTypeoptional      
documentation
transactionType: Type of the transaction.
cvv2xs:stringoptional      
documentation
cvv2: Security code on the back of a credit card (credit card only).
trackDataxs:stringoptional      
documentation
trackData: Copy of the data from credit card's magnetic tape (credit card only).
annotation
documentation
Represents electronic processor related info. Used for credit card and ACHprocessing transactions.
source <xs:complexType name="CaptureInfo">
 
<xs:annotation>
   
<xs:documentation>Represents electronic processor related info. Used for credit card and ACHprocessing transactions.</xs:documentation>
 
</xs:annotation>
 
<xs:complexContent>
   
<xs:extension base="ClientObject">
     
<xs:attribute name="requestDate" type="Date" use="optional">
       
<xs:annotation>
         
<xs:documentation>requestDate: Date when the request was sent to processor.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="responseDate" type="Date" use="optional">
       
<xs:annotation>
         
<xs:documentation>responseDate: Date when the response from the processor was received.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="holderName" type="xs:string" use="optional">
       
<xs:annotation>
         
<xs:documentation>holderName: Name on the credit card or bank account's holder's name.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="taxAmount" type="xs:int" use="optional">
       
<xs:annotation>
         
<xs:documentation>taxAmount: Tax amount if available (part of total amount).</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="street" type="xs:string" use="optional">
       
<xs:annotation>
         
<xs:documentation>street: Street of the billing address.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="city" type="xs:string" use="optional">
       
<xs:annotation>
         
<xs:documentation>city: City of the billing address.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="state" type="xs:string" use="optional">
       
<xs:annotation>
         
<xs:documentation>state: State (two-letter code) of the billing address.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="phone" type="xs:string" use="optional">
       
<xs:annotation>
         
<xs:documentation>phone: Phone of the billing address.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="zipCode" type="xs:string" use="optional">
       
<xs:annotation>
         
<xs:documentation>zipCode: ZipCode of the billing address.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="email" type="xs:string" use="optional">
       
<xs:annotation>
         
<xs:documentation>email: E-mail associated with holder of the card/bank account.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="returnType" type="ReturnType" use="optional">
       
<xs:annotation>
         
<xs:documentation>returnType: Code defining response type generated by the processor.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="approvalCode" type="xs:string" use="optional">
       
<xs:annotation>
         
<xs:documentation>approvalCode: Approval reference code generated by the processor in case of successfulauthorization (credit card only).</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="referenceNumber" type="xs:string" use="optional">
       
<xs:annotation>
         
<xs:documentation>referenceNumber: Reference number of the transaction represented by this CaptureInfo inthe processor's system (used to issue same-day voids).</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="accountNumber" type="xs:string" use="optional">
       
<xs:annotation>
         
<xs:documentation>accountNumber: Credit card number if credit card; bank account number if bank account.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="accessory" type="xs:string" use="optional">
       
<xs:annotation>
         
<xs:documentation>accessory: Expiration date (MMyy) if credit card; routing number if bank account.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="transactionType" type="AssetTransactionType" use="optional">
       
<xs:annotation>
         
<xs:documentation>transactionType: Type of the transaction.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="cvv2" type="xs:string" use="optional">
       
<xs:annotation>
         
<xs:documentation>cvv2: Security code on the back of a credit card (credit card only).</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="trackData" type="xs:string" use="optional">
       
<xs:annotation>
         
<xs:documentation>trackData: Copy of the data from credit card's magnetic tape (credit card only).</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
   
</xs:extension>
 
</xs:complexContent>
</xs:complexType>

attribute CaptureInfo/@requestDate
type Date
properties
isRef 0
use optional
facets
pattern \d\d\d\d\d\d\d\d
annotation
documentation
requestDate: Date when the request was sent to processor.
source <xs:attribute name="requestDate" type="Date" use="optional">
 
<xs:annotation>
   
<xs:documentation>requestDate: Date when the request was sent to processor.</xs:documentation>
 
</xs:annotation>
</xs:attribute>

attribute CaptureInfo/@responseDate
type Date
properties
isRef 0
use optional
facets
pattern \d\d\d\d\d\d\d\d
annotation
documentation
responseDate: Date when the response from the processor was received.
source <xs:attribute name="responseDate" type="Date" use="optional">
 
<xs:annotation>
   
<xs:documentation>responseDate: Date when the response from the processor was received.</xs:documentation>
 
</xs:annotation>
</xs:attribute>

attribute CaptureInfo/@holderName
type xs:string
properties
isRef 0
use optional
annotation
documentation
holderName: Name on the credit card or bank account's holder's name.
source <xs:attribute name="holderName" type="xs:string" use="optional">
 
<xs:annotation>
   
<xs:documentation>holderName: Name on the credit card or bank account's holder's name.</xs:documentation>
 
</xs:annotation>
</xs:attribute>

attribute CaptureInfo/@taxAmount
type xs:int
properties
isRef 0
use optional
annotation
documentation
taxAmount: Tax amount if available (part of total amount).
source <xs:attribute name="taxAmount" type="xs:int" use="optional">
 
<xs:annotation>
   
<xs:documentation>taxAmount: Tax amount if available (part of total amount).</xs:documentation>
 
</xs:annotation>
</xs:attribute>

attribute CaptureInfo/@street
type xs:string
properties
isRef 0
use optional
annotation
documentation
street: Street of the billing address.
source <xs:attribute name="street" type="xs:string" use="optional">
 
<xs:annotation>
   
<xs:documentation>street: Street of the billing address.</xs:documentation>
 
</xs:annotation>
</xs:attribute>

attribute CaptureInfo/@city
type xs:string
properties
isRef 0
use optional
annotation
documentation
city: City of the billing address.
source <xs:attribute name="city" type="xs:string" use="optional">
 
<xs:annotation>
   
<xs:documentation>city: City of the billing address.</xs:documentation>
 
</xs:annotation>
</xs:attribute>

attribute CaptureInfo/@state
type xs:string
properties
isRef 0
use optional
annotation
documentation
state: State (two-letter code) of the billing address.
source <xs:attribute name="state" type="xs:string" use="optional">
 
<xs:annotation>
   
<xs:documentation>state: State (two-letter code) of the billing address.</xs:documentation>
 
</xs:annotation>
</xs:attribute>

attribute CaptureInfo/@phone
type xs:string
properties
isRef 0
use optional
annotation
documentation
phone: Phone of the billing address.
source <xs:attribute name="phone" type="xs:string" use="optional">
 
<xs:annotation>
   
<xs:documentation>phone: Phone of the billing address.</xs:documentation>
 
</xs:annotation>
</xs:attribute>

attribute CaptureInfo/@zipCode
type xs:string
properties
isRef 0
use optional
annotation
documentation
zipCode: ZipCode of the billing address.
source <xs:attribute name="zipCode" type="xs:string" use="optional">
 
<xs:annotation>
   
<xs:documentation>zipCode: ZipCode of the billing address.</xs:documentation>
 
</xs:annotation>
</xs:attribute>

attribute CaptureInfo/@email
type xs:string
properties
isRef 0
use optional
annotation
documentation
email: E-mail associated with holder of the card/bank account.
source <xs:attribute name="email" type="xs:string" use="optional">
 
<xs:annotation>
   
<xs:documentation>email: E-mail associated with holder of the card/bank account.</xs:documentation>
 
</xs:annotation>
</xs:attribute>

attribute CaptureInfo/@returnType
type ReturnType
properties
isRef 0
use optional
facets
enumeration C01
enumeration C02
enumeration C03
enumeration C04
enumeration C05
enumeration C06
enumeration C07
enumeration C08
enumeration C09
enumeration C10
enumeration C11
enumeration C12
enumeration C13
enumeration C61
enumeration C62
enumeration C63
enumeration C64
enumeration C65
enumeration C66
enumeration C67
enumeration C68
enumeration C69
enumeration R01
enumeration R02
enumeration R03
enumeration R04
enumeration R06
enumeration R07
enumeration R08
enumeration R09
enumeration R10
enumeration R11
enumeration R12
enumeration R13
enumeration R14
enumeration R15
enumeration R16
enumeration R17
enumeration R18
enumeration R19
enumeration R20
enumeration R21
enumeration R22
enumeration R23
enumeration R24
enumeration R25
enumeration R26
enumeration R27
enumeration R28
enumeration R29
enumeration R30
enumeration R31
enumeration R32
enumeration R33
enumeration R34
enumeration R35
enumeration R36
enumeration R37
enumeration R50
enumeration R51
enumeration R52
enumeration R53
enumeration R61
enumeration R62
enumeration R63
enumeration R64
enumeration R65
enumeration R66
enumeration R67
enumeration R68
enumeration R69
enumeration R70
enumeration R71
enumeration R72
enumeration R73
enumeration R74
enumeration R80
enumeration R81
enumeration R82
enumeration R83
enumeration R84
enumeration A01
enumeration A02
enumeration A03
enumeration D01
enumeration D02
enumeration D03
enumeration D04
enumeration D05
enumeration D06
enumeration D07
enumeration D08
enumeration D09
enumeration D10
enumeration D11
enumeration D12
enumeration D13
enumeration D14
enumeration E01
enumeration E02
annotation
documentation
returnType: Code defining response type generated by the processor.
source <xs:attribute name="returnType" type="ReturnType" use="optional">
 
<xs:annotation>
   
<xs:documentation>returnType: Code defining response type generated by the processor.</xs:documentation>
 
</xs:annotation>
</xs:attribute>

attribute CaptureInfo/@approvalCode
type xs:string
properties
isRef 0
use optional
annotation
documentation
approvalCode: Approval reference code generated by the processor in case of successfulauthorization (credit card only).