InstallCardReturn
- Timothy Armstrong
This method accepts an object of type InstallCardRequest and sends back the object with the updated information in it. Customer information is not required on a return request.
Required Input Parameters
Field |
Data Type |
Required |
Description |
Security Code |
GUID |
Yes |
Assigned by InstallerNet |
ProgramID |
INT |
Yes |
Assigned by InstallerNet |
TransactionID |
VarChar(14) |
Yes |
Client Transaction number |
TransactionType |
Char(1) |
Yes |
"S" for sale or "R" for return |
PurchaseDate |
DateTime |
Yes |
|
CardModel |
VarChar(20) |
Yes |
|
ReceiptNumber |
VarChar(50) |
Yes |
|
Cost |
MONEY |
Yes |
Client cost for card. If mis-match, and error will be returned |
InstallCardID |
VarChar(14) |
Yes |
|
Output Parameters
Field |
Data Type |
Required |
Description |
Security Code |
GUID |
Yes |
Assigned by InstallerNet |
ProgramID |
INT |
Yes |
Assigned by InstallerNet |
TransactionID |
VarChar(14) |
Yes |
Client Transaction number |
TransactionType |
Char(1) |
Yes |
"S" for sale or "R" for return |
Customer Information |
Class |
Yes |
|
CustInfo.FirstName |
VARCHAR(50) |
Yes |
|
CustInfo.LastName |
VARCHAR(50) |
Yes |
|
CustInfo.Address |
VARCHAR(50) |
Yes |
Shipping address |
CustInfo.Address2 |
VARCHAR(50) |
No |
Shipping address 2 |
CustInfo.City |
VARCHAR(50) |
Yes |
Shipping City |
CustInfo.State |
CHAR(2) |
Yes |
Shipping State |
CustInfo.ZipCode |
VARCHAR(10) |
Yes |
Shipping Zip Code |
CustInfo.Country |
VARCHAR(5) |
Yes |
USA or CAN |
CustInfo.Phone |
VARCHAR(12) |
Yes |
Format must be 999-999-9999 |
CustInfo.AltPhone |
VARCHAR(12) |
No |
Format must be 999-999-9999 |
CustInfo.Email |
VARCHAR(50) |
No |
Required if Delivery Method is Electronic |
PurchaseDate |
DateTime |
Yes |
|
CardModel |
VarChar(20) |
Yes |
|
ShippingMethod |
VarChar(50) |
No |
Required if Delivery method is Physical |
DeliveryMethod |
CHAR(1) |
Yes |
"E" = Electronic |
ReceiptNumber |
VarChar(50) |
Yes |
|
Cost |
MONEY |
Yes |
Client cost for card. If mis-match, and error will be returned |
LineItem |
INT |
Yes |
Line item on the client purchase order to the customer. Default to 1 if you do not use line items. |
ClientProductNumber |
VarChar(50) |
No |
|
InstallCardID |
Varchar(14) |
Yes |
InstallCard number |
Errors |
Class |
No |
If no errors were encountered, the class will include one message with error code of 0. |
Error.Code |
INT |
Yes |
Code that describes the error that occurred during processing |
Error.Message |
VARCHAR(100) |
Yes |
Message that corresponds to the code returned |
ReturnStatus |
VARCHAR(10) |
Yes |
Yes – return successful |