If you order and update cards using our web services (Mastercard Web Services (MCWS)), you can still enroll cardholders into Alerts and Notifications. For comprehensive documentation on web service offerings, see APIs and Web Services or contact your Comdata Account Manager or Relationship Manager.
Add MasterCard Operation
The Add Mastercard function is a request record used to order a Mastercard via MCWS. If you want to enroll the card in Alerts and Notifications, complete the cardholderEmail, mobilePhoneNumber, and alertServiceFlag fields.
| Function: | Add Mastercard cards to an account |
| Web Service Method: | addMasterCards |
| Applicable Card Type: | Comdata MasterCards (physical & ghost), Corpay MasterCards (physical & ghost) |
| Other Notes: | Authentication requires a different user ID and password compared to the COWS 2.0 and COWS 2.1 operations due to a change in the security model. |
Request Record – Add MasterCard
| Element Name | Data Type | Max Len | Req | Comment / Example Value |
|---|---|---|---|---|
| <cardDetails> | ||||
| accountCode | xsd:string | 5 | Y | Comdata/Corpay-assigned Account code |
| custId | xsd:string | 5 | Y | Comdata/Corpay-assigned Customer ID (4-digit customer IDs will include a leading zero) |
| cardStatus | xsd:string | 1 | N | A (active), B (blocked) |
| profileFlag | xsd:string | 1 | N | Y (yes) or N (no) |
| profileValue | xsd:string | 3 | Y | 3-digit number identifying the profile group for the cardholder, if applicable |
| cardFirstName | xsd:string | 15 | Y | Value assigned to the First Name field |
| cardLastName | xsd:string | 20 | Y | Value assigned to the Last Name field |
| driverLicenseNumber | xsd:string | 20 | N | Driver’s License Number (US or Canadian) |
| driverLicenseState | xsd:string | 2 | N | Use 2-letter state abbreviation (US) or province abbreviation (Canada) |
| tripNumber | xsd:string | 10 | N | This number identifies a trip |
| vehicleNumber | xsd:string | 6 | N | Vehicle Number, also known as Unit Number |
| employeeNumber | xsd:string | 16 | Y | Employee number assigned to this card |
| vehicleVINNumber | xsd:string | 30 | N | VIN (vehicle identification number) |
| vehicleDescription | xsd:string | 30 | N | Brief, free form description of a vehicle |
| vehicleLicensePlateNumber | xsd:string | 15 | N | Vehicle license plate number |
| registrationExpiration | xsd:string | 4 | N | MMYY |
| miscellaneous1 | xsd:string | 15 | N | Miscellaneous storage field one |
| miscellaneous2 | xsd:string | 15 | N | Miscellaneous storage field one |
| miscellaneous3 | xsd:string | 15 | N | Miscellaneous storage field one |
| cardExpiration | xsd:string | 4 | N | Card expiration date provided by customer (MMYY) |
| cardholderEmail | xsd:string | 100 | N | Cardholder’s email address. Example: [email protected] |
| mobilePhoneNumber | xsd:string | 10 | N | ########## example: 5555555555 |
| alertServiceFlag | xsd:boolean | 5 | N | true or false: Default is false |
| vehicleTankCapacity | xsd:string | 10 | N | 9999999999 |
| cardParams | xsd:list | N | Future fields | |
| <mailingDetails> | ||||
| mailingMethod | xsd:string | 1 | N | Numbers 0-9, no 2 option 0 – UPS Worldwide 1 – UPS Next Day Air 3 – UPS 2nd Day 4 – FedEx Priority 5 – UPS Ground 6 – FedEx Two Day Expedited 7 – FedEx Ground 8 – USPS International 9 – FedEx International |
| mailName | xsd:string | 30 | N | Company Name |
| mailAttentionTo | xsd:string | 3o | N | Attention to Person |
| mailAddress1 | xsd:string | 3o | N | Mailing Address Line 1 |
| mailAddress2 | xsd:string | 3o | N | Mailing Address Line 2 |
| mailCity | xsd:string | 20 | N | Mailing City |
| mailState | xsd:string | 2 | N | 2-letter abbreviation for the state (US) or province (Canada) |
| mailZip | xsd:string | 10 | N | Mailing zip code, Example – US: 12345 or 12345-6789, Canada: A1A 1A1 |
| mailCountry | xsd:string | 3 | N | Mailing Country Code, example: USA, MEX, CAN |
| mailingParams | xsd:list | N | Future fields | |
| </mailingDetails> | ||||
| </cardDetails> | ||||
| <options> | ||||
| maskCard | xsd:boolean | 5 | N | true – mask cardNumber false – unmask cardNumber default is to mask cardNumber in the response |
| optionParams | xsd:list | N | Placeholder for future fields | |
| <cardAddParams> | ||||
| cardAddParamName | xsd:string | N | These are where future fields will go when needed. |
|
| cardAddParamName | xsd:string | N | These fields are where future fields will go when needed. |
|
| </cardAddParams> |
Response Record – Add MasterCard
| Element Name | Data Type | Max Len | Comment/Example Value |
|---|---|---|---|
| <> | |||
| <> | |||
| status | xsd:string | 20 | Success or Failure |
| errorMessage | xsd:string | 80 | Displays only if status is a failure. See Error Table. |
| errorCode | xsd:string | 10 | Displays only if status is a failure. See Error Table. |
| requestUID | xsd:string | 40 | Unique identifier to inquire the status of the cardAdd request |
| accountCode | xsd:string | 5 | Comdata-assigned Account code |
| custID | xsd:string | 5 | Comdata-assigned Customer ID (4-digit customer IDs will include a leading zero) |
| cardNumber | xsd:string | 16 | New card number if created (number masked if maskCard is flagged “true” in the request) |
| employeeNumber | xsd:string | 16 | Employee number assigned to this card |
| cardToken | xsd:string | 10 | Card token assigned to this card |
| cardAddResponseParams | xsd:list | Future fields | |