Chapter 126: Stored Value Card Balance Inquiry
Overview: You can inquire on the remaining amount available on a stored value card:
• Using the Stored Value Card Balance Inquiry (MSVB) menu option; see Stored Value Card Balance Inquiry (MSVB).
• In order entry and maintenance; see Order Entry/Maintenance Balance Inquiry.
• Before performing batch authorization against the card during pick slip generation or drop ship processing; see Batch Authorization Balance Inquiry.
In this chapter:
• Stored Value Card Balance Inquiry (MSVB)
• Stored Value Card Balance Inquiry Screen (MSVB)
• Order Entry/Maintenance Balance Inquiry
• Batch Authorization Balance Inquiry
• Stored Value Card Balance Inquiry Request Message
• Stored Value Card Balance Inquiry Response Message
Stored Value Card Balance Inquiry (MSVB)
Purpose: Use the Stored Value Card Balance Inquiry menu option to submit a stored value card balance inquiry request.
Stored value card balance inquiry illustration:
Stored Value Card Balance Inquiry Screen (MSVB)
Use this screen to specify the stored value card whose balance you wish to know.
Note: Depending on the user’s authority to credit card information, the system writes a record to the Credit Card Audit file when this window is displayed.
How to display this screen:
• Enter MSVB in the Fast path field or select Stored Value Card Balance Inquiry from a menu.
• Press F9 on the Customer Selection Screen.
OER1409 ENTER Stored Value Card Balance Inquiry 7/14/05 11:26:58
Pay type . . . . .
Card number . . . .
Balance . . . . . :
Enter=Submit request F3=Exit F12=Cancel |
Field |
Description |
Pay type |
The code for the stored value card pay type assigned to the stored value card number whose remaining balance you are inquiring. The pay type you enter must be a stored value card pay type or an error message displays: Pay type not eligible for balance inquiry. Numeric, 2 positions; required. |
Card number |
The stored value card number whose balance you are inquiring. The system validates the card number meets the card length and leading digits defined for the pay type; see Create Pay Type Screen. Also, if bin numbers are defined for the pay type, the system validates that the card number begins with a valid bin number; see Work with Bin Numbers Screen. Alphanumeric, 20 positions; required. |
Balance |
The remaining balance on the stored value card. This field is blank until you receive a balance inquiry response from the service bureau. However, the service bureau may return a blank balance if the stored value card number exists, but has not yet been activated or the remaining balance is zero. Numeric, 9 positions with a 2-place decimal; display-only. |
Screen Option |
Procedure |
Submit a stored value card balance inquiry request |
Press Enter. |
Step-by-step instructions: Use the following steps to submit a stored value card balance inquiry request from the Stored Value Card Balance Inquiry Screen (MSVB).
1. Enter a stored value card pay type and card number and press Enter.
2. The system looks at the Authorization service field defined for the stored value card pay type to determine the service bureau that performs balance inquiries for the stored value card pay type.
• If the service bureau uses a CWIntegrate site, the system looks at the SVC balance inquiry integration layer process field defined for the service bureau to determine the integration layer process used to process stored value card balance inquiries. The delivered integration layer process is SVC_BALANC.
• If the service bureau uses data queues and Java programs, the system looks at the Provider Network Address field defined for the service bureau and the settings in the associated Properties file to communicate with the service bureau.
3. The Stored Value Card Balance Inquiry process sends the Stored Value Card Balance Inquiry Request Message in online format to the service bureau and waits for a balance inquiry response.
• If a response is received from the service bureau, the system displays the remaining balance amount for the stored value card in the Balance field. However, this field may remain blank if the stored value card number exists, but has not yet been activated, or the remaining balance is zero.
• If a response is not received from the service bureau, the system displays the message: No response from service.
Determining the Merchant ID
The system looks at the Authorization service field defined for the stored value card pay type to determine the service bureau that performs balance inquiries for the stored value card pay type. Once the service bureau is determined, the system uses the following hierarchy to determine the merchant ID for stored value card balance inquiries generated through the Stored Value Card Balance Inquiry (MSVB) menu option.
• Pay type: Use the Merchant # defined for the pay type in the CC Paytype Cross Ref file. See Create CC Paytype Cross Reference Screen.
• Service bureau: If a Merchant ID has not been defined for the pay type in the CC Paytype Cross Ref file, use the Merchant ID defined for the service bureau in the Authorization Service file. See First Create Authorization Services Screen.
Order Entry/Maintenance Balance Inquiry
Purpose: You can submit a stored value card balance inquiry request from within an order during order entry and maintenance.
Order Entry/Maintenance balance inquiry illustration:
Use the following steps to submit a stored value card balance inquiry request from order entry/maintenance.
1. At the Enter Payment Method screen, enter 14 next to a stored value card payment method and press Enter.
You can also select this option at the Enter Credit Card For window. However, an error message displays if you have not yet created the stored value card payment method on the order: Must create pay method before Balance Inquiry.
2. The system looks at the Authorization service field defined for the stored value card pay type to determine the service bureau that performs balance inquiries for the stored value card pay type.
• If the service bureau uses a CWIntegrate site, the system looks at the SVC balance inquiry integration layer process field defined for the service bureau to determine the integration layer process used to process stored value card balance inquiries. The delivered integration layer process is SVC_BALANC.
• If the service bureau uses data queues and Java programs, the system looks at the Provider Network Address field defined for the service bureau and the settings in the associated Properties file to communicate with the service bureau.
3. The Stored Value Card Balance Inquiry process sends the Stored Value Card Balance Inquiry Request Message in online format to the service bureau and waits for a balance inquiry response.
• If a response is received from the service bureau, the system displays the Balance Inquiry For Window, indicating the remaining balance on the stored value card.
• If a response is not received from the service bureau, the system displays the message: No response from service.
Use this window to review the remaining balance on a stored value card during order entry/maintenance.
When a balance is received, you can:
• Press Enter to add the stored value card balance as the amount to charge for the stored value card payment on the order. You can also enter a lesser amount in the Balance field if you wish to use a partial amount of the remaining balance on the card as payment on the order.
• Press F12 to return to the previous screen without adding the stored value card balance as the amount to charge on the order.
Note:
• Depending on the user’s authority to credit card information, the system writes a record to the Credit Card Audit file when this window is displayed.
• This screen may return a blank balance if the stored value card number exists, but has not yet been activated by the service bureau or the remaining balance is zero.
How to display this screen: This screen displays when a balance inquiry response is received from the service bureau, after you send a stored value card balance inquiry request to the service bureau by:
• Entering 14 next to a stored value card payment method at the Enter Payment Method screen.
• Pressing F14 at the Enter Credit Card For window.
Balance Inquiry for:
Pay type . . . . : 3 STORED VALUE CARD
Card number . . . : SVCE8142****
Balance . . . . . . 50.00
Enter=Update payment with balance F3=Exit F12=Cancel |
Field |
Description |
Pay type |
The code and description of the stored value card pay type assigned to the stored value card number whose remaining balance you are inquiring. Code: Numeric, 2 positions; display-only. Description: Alphanumeric, 30 positions; display-only. |
Card # |
The stored value card number whose balance you are inquiring. If you do not have authority to the Display Full Credit Card Number (B14) secured feature, the stored value card number displays in the format specified at the Credit Card Number Layout Screen for the associated pay type. For example, 4788********1443 may display instead of the entire stored value card number. See Credit Card Number Format for an overview. Alphanumeric, 20 positions; display-only. |
Balance |
The remaining balance on the stored value card. Numeric, 9 positions with a 2-place decimal; required. |
Batch Authorization Balance Inquiry
Purpose: You can submit a stored value card balance inquiry request before performing batch authorization against a stored value card.
Batch authorization balance inquiry illustration:
In order to perform a balance inquiry before batch authorization:
• the Perform Balance Inquiry during Batch Authorizations (J19) system control value must be set to Y.
• another pay type must not exist on the order that can cover the amount to authorize.
Use the following steps to submit a stored value card balance inquiry request before performing batch authorization against the stored value card.
1. Submit pick slip generation or drop ship processing that includes an order with a stored value card pay type that requires batch authorization.
2. The system looks at the Authorization service field defined for the stored value card pay type to determine the service bureau that performs balance inquiries for the stored value card pay type.
• If the service bureau uses a CWIntegrate site, the system looks at the SVC balance inquiry integration layer process field defined for the service bureau to determine the integration layer process used to process stored value card balance inquiries. The delivered integration layer process is SVC_BALANC.
• If the service bureau uses data queues and Java programs, the system looks at the Provider Network Address field defined for the service bureau and the settings in the associated Properties file to communicate with the service bureau.
3. The Stored Value Card Balance Inquiry process sends the Stored Value Card Balance Inquiry Request Message in batch format to the service bureau and waits for a balance inquiry response.
• If the stored value card is the catch-all pay type on the order, the balance request amount is the pick slip amount minus any open authorizations that already exist for the stored value card on the order.
• If the stored value card pay type has a defined amount on the order, the balance request amount is the pay type amount minus any open authorizations that already exist for the stored value card on the order.
4. If a response is received from the service bureau, and:
• The balance is equal to or greater than the balance request amount, the system continues with authorization processing to authorize the stored value card for the amount.
• The balance is less than the balance request amount and the stored value card payment is the catch-all payment on the order, the system does not authorize the stored value card and does not generate a pick slip for the order. In addition, the system writes an order payment history message indicating the stored value card did not have the available funds: H INSUFFICIENT FUNDS ON STORED VALUE CARD SVC_BALANC. Also, if a Hold Reason for Stored Value Cards with Insufficient Funds (J18) is defined, the system places the order on hold.
• The balance is less than the balance request amount and the stored value card payment is not the catch-all payment on the order, the system authorizes the stored value card for the remaining balance and authorizes the catch-all payment for the remaining amount to authorize. In addition, the system writes an order payment history message indicating the charge amount for the stored value card pay type was changed to the remaining balance: M Amount: 50.00 to 25.00 SVC_BALANC.
Note: If a balance inquiry response is not received from the service bureau, for example, due to communication errors, the system will continue with batch authorization.
CWValueCard: If you use CWValueCard as your service bureau, the system does not validate that the card number sent to CWValueCard is valid until after the batch balance inquiry has been performed. If the card is an invalid number, the balance inquiry response will indicate that the balance on the card is zero, instead of returning a response code of 30 Invalid Card Number.
Examples: The following examples explain what happens to a stored value card pay type on an order, based on the remaining balance on the card.
Example: |
Balance: |
Results: |
Order total = $100.00 Stored value card = catch-all |
$120.45 |
The system authorizes the stored value card pay type for $100.00. Once the stored value card on the order is authorized, the system generates a pick slip. The remaining balance on the stored value card is $20.45. |
Order total = $100.00 Stored value card = catch-all Credit card = $25.00 |
$45.50 |
Because the stored value card does not have $75.00 remaining to apply to the order, the system does not authorize the pay types on the order and does not generate a pick slip for the order. If a Hold Reason for Stored Value Cards with Insufficient Funds (J18) is defined, the system places the order on hold. The remaining balance on the stored value card is $45.50. |
Order total = $100.00 Stored value card = $75.00 Credit card = catch-all |
$45.50 |
The system authorizes the stored value card for $45.50 and authorizes the credit card for $54.50. Once the pay types on the order are authorized, the system generates a pick slip. The remaining balance on the stored value card is zero. An order payment history message is created: M Amount: 75.00 to 45.50 SVC_BALANC |
Order total = $100.00 Stored value card = catch-all Open SVC authorization on order = 75.00 |
$30.00 |
The system authorizes the stored value card pay type for $25.00 (Order total $100.00 - Open SVC authorization $75.00 = $25.00). Once the stored value card on the order is authorized, the system generates a pick slip. The remaining balance on the stored value card is $5.00. |
Order total = $140.00 Stored value card = $75.00 Credit card = catch-all Open SVC authorization on order = $50.00 |
$30.00 |
The system authorizes the stored value card pay type for $25.00 (Pay type amount $75.00 - Open SVC authorization $50.00 = $25.00) and authorizes the credit card for $65.00. Once the pay types on the order are authorized, the system generates a pick slip. The remaining balance on the stored value card is $25.00. |
Stored Value Card Balance Inquiry Request Message
Purpose: The stored value card balance inquiry request contains stored value card information to send from CWDirect to the service bureau to determine the remaining balance on a stored value card.
The system creates the stored value card balance inquiry request using the Authorization Request XML Message (CWAuthorizationRequest); because of this, only the elements and attributes specific to stored value card balance inquiry are explained below. See Authorization Request XML Message (CWAuthorizationRequest) for more information on the additional values in this message.
• If the balance inquiry request is generated during order entry/maintenance or the Stored Value Card Balance Inquiry (MSVB) menu option, the system generates the Authorization Request XML Message (CWAuthorizationRequest) in online mode.
• If the balance inquiry request is generated before batch authorization, the system generates the Authorization Request XML Message (CWAuthorizationRequest) in batch mode.
Attribute Name |
Type |
Length |
Comments |
See Authorization Request XML Message (CWAuthorizationRequest) for more information on the attributes for this element. |
|||
|
|||
mode |
alpha |
10 |
Indicates the mode of communication. Online displays for stored value card balance inquiries generated during order entry/maintenance or the Stored Value Card Balance Inquiry (MSVB) menu option. Batch displays for stored value card balance inquiries generated before batch authorization. |
|
|||
serviceID |
alpha |
3 |
The code for the service bureau performing stored value card balance inquiry. |
See Authorization Request XML Message (CWAuthorizationRequest) for more information on the attributes for this element. |
|||
|
|||
companyID |
alpha |
3 |
The company from where the stored value card balance inquiry request was sent. |
createDate |
numeric |
8 |
The date (in MMDDYYYY format) the stored value card balance inquiry request was sent to the service bureau. |
orderType |
alpha |
8 |
Indicates the type of order, for example phone order or mail order, where the stored value card used as payment is located. Mail indicates mail order. Phone indicates telephone order. Internet indicates web order. CWDirect: • looks at the value in the Internet order field in the Order Header file. If this field is set to I, the order is a web order. • determines if the order type for the order matches the order type defined in the E-Commerce Order Type (G42) system control value. If the order type matches, the order is a web order. • looks at the value defined in the Forecasting order category field in the Order Type file. If this value is 1, the order is a mail order. If this value is 2, the order is a phone order. |
transactionType |
alpha |
10 |
Indicates if the transaction is a debit or credit. Debit displays for stored value card balance inquiry. |
merchantReference |
numeric |
20 |
A unique number made up of the CWDirect company code + order number + order payment method sequence number + authorization sequence number. For example, 5550000695101000, where 555 is the company code, 00006951 is the order number, and 01 is the order payment method sequence number; the authorization sequence number is always 000. For balance inquiry transactions from the Stored Value Card Balance Inquiry menu option (MSVB), this is the company code + local workstation job number. |
transactionSeq Number |
numeric |
15 |
000000000000000 displays for stored value card balance inquiry. |
orderID |
numeric |
8 |
The order number where the stored value card payment method requesting a balance inquiry is located. |
paymentID |
numeric |
2 |
The order payment method sequence number for this stored value card payment method on the order. |
authID |
numeric |
3 |
000 displays for stored value card balance inquiry. |
payCategory |
numeric |
15 |
A description of the pay category associated with the stored value card balance inquiry request. Credit card displays, indicating the stored value card is associated with the credit card pay category. This is the description associated with the pay category code defined for the credit card pay type in the Pay Type file. |
vendorPayment Method |
alpha |
5 |
The vendor pay type code associated with the credit card authorization request; this is the code the authorization service uses to identify a method of payment; for example SV. This is the vendor pay type code defined for the credit card pay type in the Credit Card Paytype Cross Reference file. |
cardType |
alpha |
30 |
Indicates the type of card being processed. Stored value card displays for stored value card balance inquiry. |
actionCode |
alpha |
30 |
Indicates the action to take against the transaction being processed. Balance displays for stored value card balance inquiry. |
alpha |
20 |
The number assigned to the stored value card requesting balance inquiry. If you use credit card encryption, the system decrypts the stored value card number before sending it to the external system. |
|
expirationDate |
numeric |
4 |
Stored value cards are not assigned an expiration date. |
numeric |
10 |
Stored value card balance inquiries do not pass an authorization amount. |
|
currencyCode |
alpha |
3 |
The currency code used by the authorization service to define a currency. Stored value cards are only processed in US currency. This is the authorization service currency code in the Authorization Service Currency file. |
ecommerceIndicator |
alpha |
3 |
Indicates if the order associated with the stored value card balance inquiry request was placed on the web storefront. Valid values: YES = the order was placed over the web storefront. NO = the order was not placed over the web storefront. This is the e-commerce indicator (future use status 1 field) defined for the order in the Order Header file. |
Sample Stored Value Card Balance Inquiry Request Message:
- <Message source="RDC" target="IL" type="CWAuthorizationRequest" resp_qmgr="CWIAS400" resp_q="CWDIRECT.FROM.PAYMENTECH.SVCBAL.LOADRUNNER">
- <CWAuthorizationRequest mode="Online">
<Service serviceID="PMT" />
<Merchant companyID="555" merchantID="848481" merchantSubID="SUBCODE987" merchantName="PAYMENTECH AUTH/DEP" merchantDivision="778522" chargeDescription="PAYMENTECH AUTH/DEP" receivingCode="RECEIVECDE" startupInfo="STARTUP INFORMATIONX" signon="TEST987654" password="PASSWORDAZ" presentersID="192864" pidPassword="COMMERCI" submittersID="192864" sidPassword="COMMERCI" industryFormatCode="INDCD" addressVerificationFlag="YES" />
<AuthRequest companyID="555" createDate="01262004" orderType="Mail" transactionType="Debit" merchantReference="5550000695101000" transactionSeqNumber="000000000000000" orderID="00006951" paymentID="01" authID="000" payCategory="Credit card" vendorPaymentMethod="SV" cardType="Stored Value Card" actionCode="Balance" ccAccountNumber="6035718888880273249" expirationDate="" authAmountText=".00" authAmount="00" currencyCode="840" ecommerceIndicator="NO" firstName="BERNADETTE MIRA" initial="T" lastName="LETENDRE-BOTTGER" addressLine1="109 SAMPLE LANE" addressLine2="LOT 3" addressLine3="THIRD ADDRESS LINE" addressLine4="FOURTH ADDRESS LINE" city="TEMPLETON" state="MA" zip="01468" country="USA" phoneType="Evening/Home" phoneNumber="5082222222" email="BMIRANDA@EXAMPLE.COM" />
</CWAuthorizationRequest>
</Message>
Stored Value Card Balance Inquiry Response Message
Purpose: The stored value card balance inquiry response indicates the remaining balance on the stored value card.
The system creates the stored value card balance inquiry response using the Authorization Response XML Message (CWAuthorizationResponse); because of this, only the elements and attributes specific to stored value card balance inquiry are explained below. See Authorization Response XML Message (CWAuthorizationResponse) for more information on the additional values in this message.
• If the balance inquiry request is generated during order entry/maintenance or the Stored Value Card Balance Inquiry (MSVB) menu option, the system generates the Authorization Response XML Message (CWAuthorizationResponse) in online mode.
• If the balance inquiry request is generated before batch authorization, the system generates the Authorization Response XML Message (CWAuthorizationResponse) in batch mode.
Attribute Name |
Type |
Length |
Comments |
See Authorization Request XML Message (CWAuthorizationRequest) for more information on the attributes for this element. |
|||
|
|||
mode |
alpha |
10 |
Indicates the mode of communication. Online displays for stored value card balance inquiries generated during order entry/maintenance or the Stored Value Card Balance Inquiry (MSVB) menu option. Batch displays for stored value card balance inquiries generated before batch authorization. |
action |
|
|
Response displays, indicating the message contains a stored value card balance inquiry response. |
|
|||
companyID |
alpha |
3 |
The company from which the stored value card balance inquiry was sent. |
merchantReference |
numeric |
20 |
A unique number made up of the CWDirect company code + order number + order payment method sequence number + authorization sequence number. For example, 5550000695101000, where 555 is the company code, 00006951 is the order number, and 01 is the order payment method sequence number; the authorization sequence number is always 000. The system uses this value to determine the stored value card that requested balance inquiry. |
orderID |
numeric |
8 |
The order number where the stored value card payment method that requires balance inquiry is located. |
paymentID |
numeric |
2 |
The order payment method sequence number for this stored value card payment method on the order. |
authID |
numeric |
3 |
000 displays for stored value card balance inquiry. |
alpha |
10 |
The balance inquiry response for the stored value card. |
|
actionCode |
alpha |
10 |
Indicates the type of transaction. Balance displays for stored value card balance inquiry. |
previousBalance |
alpha |
12 |
The previous balance on the stored value card. Right justified, zero filled, with 2 implied decimals. |
numeric |
12 |
The current balance on the stored value card. Right justified, zero filled, with 2 implied decimals. |
|
Sample Stored Value Card Balance Inquiry Response Message:
- <Message source="CWIntegrate" target="CWDirect" type="CWAuthorizationResponse">
- <CWAuthorizationResponse mode="Online" type="Detail" action="Response">
<AuthResponse companyID="555" merchantReference="5550000695101000" orderID="00006951" paymentID="01" authID="000" vendorResponse1="100" actionCode="Balance" previousBalance="000000050000" currentBalance="000000047300" />
</CWAuthorizationResponse>
</Message>
| Chapter 125: Working with Physical Stored Value Card Assignment (WPSA) | Contents | SCVs | Search | Glossary | Reports | XML | Index | Chapter 127: Stored Value Card Authorization Reversal |
SO14_04 CWDirect 18.0 August 2015 OTN