Shared Objects
These objects are found in both the request and response objects.
Account
| Field | Type | Description | Required |
|---|---|---|---|
| AccountNumber | N | Consumer's Account Number. This represents the Consumer's Credit Card Number. | N |
| ExpirationMonth | N | Account/Credit Card Expiration Month in MM format. Example: January = 01 | N |
| ExpirationYear | N | Account/Credit Card Expiration Year in YYYY format. Example: 2016 | N |
| NameOnAccount | AN | Name on the Consumer's Account/Credit Card. | N |
| CardCode | N(4) | This is the CVV Code present on the back (or on the front in the case of AMEX) of a Consumer's Credit Card . This is required on Credit Card transactions. | |
| CardBin | N(6) | Represents the first six numbers of the CardNumber field | |
| CardType | String | Type of cards used for purchase. Possible Values: VSA - Visa MSC - Mastercard VSD - Visa Delta/Debit (UK) VSE - Visa Electron MAE - Maestro (UK, Spain & Austria) AMX - American Express DSC - Discover DIN - Diners CBLA - Carte Blanche CB JCB - JCB ENR - EnRoute JAL - JAL CTB - Carte Bleue DNK - Dankort CSI - CartaSi EAN - Encoded Account Number UATP - UATP MAEI - Maestro (International) CB - Cartes Bancaires ELO - ELO UPI - UnionPay International EFTPOS - eftpos Australia | |
| CardLastFour | N(4) | Represents the last four numbers of the CardNumber field |
Address
| Field | Type | Required |
|---|---|---|
| FullName | AN | N |
| FirstName | AN | N |
| MiddleName | AN | N |
| LastName | AN | N |
| Address1 | AN | N |
| Address2 | AN | N |
| Address3 | AN | N |
| City | AN | N |
| State | AN | N |
| PostalCode | AN | N |
| CountryCode | AN | N |
| Phone1 | AN | N |
| Phone2 | AN | N |
Consumer
| Field | Type | Description | Required |
|---|---|---|---|
| Email1 | AN(255) | Consumer's primary E-mail Address. | N |
| Email2 | AN(255) | Consumer's alternate E-mail Address. | N |
| ShippingAddress | Address Object | Consumer's Shipping Address. | N |
| BillingAddress | Address Object | Consumer's Billing Address. | N |
| Account | Account Object | Consumer's Account Information. | N |
Token
| Field | Type | Description | Required |
|---|---|---|---|
| Token | AN(20) | If the merchant account has tokenization enabled through Cardinal or another payment platform, the token will be returned in this field | |
| CardCode | N(4) | The CVV2 on the back of the card that was the token represents. This field is required when using Processor Module. | |
| ExpirationMonth | N(2) | Account/Credit Card Expiration Month in MM format. Example: January = 01 | |
| ExpirationYear | N(4) | Account/Credit Card Expiration Year in YYYY format. Example: 2016 |