|
XML Tag |
Definition |
Rules |
|
comcorp |
Five digit system number assigned to each corp. |
|
|
opr |
Three character field |
3 characters, legal operator id |
|
custlevelpin |
4 character field |
Four digit customer level pin |
|
lockacct_pid |
5 character field |
5 digit unique locking pid (1,001 - 65, 535) (05-23-2001) |
|
bd_house |
6 character house number |
legal values; numeric, 1 - 999999 |
|
bd_cust |
2 character customer number |
legal values; 1 - 99 |
|
bd_batch |
4 character field |
legal values; 1 - 8999 |
|
bd_batype |
1 character field |
legal values; P = payment, A = adjustment |
|
bd_amount |
9 character field |
#nnnnn.nn, # = may be minus (-) sign for adjustments (valid range if adjustment is -99999.99 to 99999.99; 0.00 is excluded) |
|
bd_pmtkind |
1 character field |
If payment, legal values; 1=cash, 2=check, 3=money order, 4=credit card; if adjustment = blank [creditcardinfo is required if payment type = 4] |
|
bd_adjrsn |
2 character field |
If adjustment, legal values = adjtable table values; if payment = blank |
|
creditcardinfo |
Beginning creditcardinfo delimiter |
|
|
cpccrd_cardtype |
1 character field |
Valid value in Code36 table (166) |
|
cpccrd_cardnumber |
19 character field |
Credit card number |
|
addcreditcard |
1 character field |
Y= Add card to database, N= don't add card to database; only allowed/processed if card does not currently exist in the database. |
|
cpccrd_cardname |
26 character field |
Name on the credit card |
|
cpccrd_expiredate |
4 character field |
Expiration date of card, formatted as MMYY |
|
priorauth |
6 character field |
Prior authorization number |
|
merchantid |
30 character field |
Merchant Id to use with prior authorization |
|
cpccrd_billaddress |
20 character field |
Billing address |
|
cpccrd_zipcode |
6 character field |
Billing address zip code |
|
cpccrd_zip4 |
4 character field |
Billing address zip4 code |
|
/creditcardinfo |
Ending creditcardinfo delimiter |
|
|
bd_rptctr |
2 character field |
If adjustment, legal reporting center value; if payment = blank |
|
bd_age |
1 character field |
If adjustment, legal values = blank, 3, 6, 9 or X; if payment = blank |
|
adj_comment |
character field |
If adjustment, Alpha numeric, maximum = 350 characters, Use GetControlParams, cp_adjcommaxln tag to determine storage lenght; if payment = blank |
|
XML Tag |
Definition |
Rules |
|
errorcode |
short |
|
|
errormessage |
char |
|
|
creditserverresponse |
81 characters |
The response message from the Protobase credit card server Will be blank if input payment type is not equal to 4 or if error is returned. |
|
avscd |
1 character field |
The AVS response code from the Protobase credit card server Will be blank if input payment type is not equal to 4 or if error is returned. |
|
authcode |
6 character field |
Authorization number returned from the Payment Card Processing applications. Will be blank if input payment type is not equal to 4 or if error is returned. |
|
merchantid |
30 character field |
Merchant Id number Will be blank if input payment type is not equal to 4 or if error is returned. |
|
5/7/01 |
Changed position in the XML document of bd_house and bd_cust to match API code. |
|
5/7/01 |
Changed YYMM to MMYY in cpccrd_expiredate field. |
|
5/23/01 |
Added lockacct_pid data field for locking functionality. |
|
6/6/01 |
Added credotserverresponse, avscd, authcode and merchantid to Output XML Tags. |
|
8/25/01 |
Update to Rules column for adj_comment tag field. |
|
8/29/01 |
Update to Rules column for bd_age tag. |
| 9/7/01 | Added rule clarification for addcreditcard field. |
| 10/3/01 | Corrected the definition for bd_batch tag, correct size is 4. |
1. When taking an "adjustment", if the XML document contains an adjustment reason that is equal to the PAYCARDRETADJRSN (from Order3params; returned as part of the GetOrderParams API) then the Payment Card logic will be invoked and a Payment Card number will be required.