VFN_OverrideLineItem()

This subprocedure can be used to override a MERCHANDISE line item by calling Verifone’s Override Line Item service.

Subprocedure Prototype

D VFN_OverrideLineItem...
D                 PR              N   Extproc('VFN_OverrideLineItem')

Returns *OFF if an error occurs during processing, *ON otherwise.

D  pRequestDS                         LikeDS(VFN_OverrideLineItemReqDS_t)
D                                     Const
 
D  pResponseDS                        LikeDS(VFN_OverrideLineItemRspDS_t)
 
D  pErrorDS                           LikeDS(VFN_ErrorDS_t)
D                                     Options(*Nopass)

Optional parameter that, if passed, will contain error data returned from the subprocedure.

Example Code


// Example Program: T_OVRLNITM // Description: // This is a test program to illustrate how to use the // VFN_OverrideLineItem() subprocedure to change the values for an // existing MERCHANDISE line item. // // This program assumes you have already called VFN_StartSession() to // open a session with your device, and that you will call // VFN_EndSession() afterwards. Ctl-Opt DftActGrp(*No) ActGrp(*Caller) BndDir('PTTIBND'); /COPY QRPGLECPY,VFNCB // This is included for demo output purposes. Dcl-Pr WriteToJobLog Int(10) Extproc('Qp0zLprintf'); pString Pointer Value Options(*String); End-Pr; Dcl-C NewLine x'15'; // This will capture returned error information Dcl-Ds ErrorDS LikeDS(VFN_ErrorDS_t) Inz(*LikeDS); // This will be used to pass request information to the API call Dcl-Ds OverrideLineItemReqDS LikeDS(VFN_OverrideLineItemReqDS_t) Inz(*LikeDS); // This will store parsed response data from the API call Dcl-Ds OverrideLineItemRspDS LikeDS(VFN_OverrideLineItemRspDS_t) Inz(*LikeDS); reset ErrorDS; reset OverrideLineItemReqDS; reset OverrideLineItemRspDS; // This must be a device that has been successfully registered with // VFN_Register() and which exists in VFNDVC. OverrideLineItemReqDS.DeviceID = 'test'; // These fields can be assigned a log file path, and will save the // request and response xml data. OverrideLineItemReqDS.RequestLog = 'T_OVRLNITM_Request.xml'; OverrideLineItemReqDS.ResponseLog = 'T_OVRLNITM_Response.xml'; // These fields are required for all line item transactions. OverrideLineItemReqDS.RunningTaxAmount = 0.42; OverrideLineItemReqDS.RunningTransAmount = 27.42; // This is the ID of the LineItem to be overriden. This must be a line // item that has already been transmitted to the payment device. This // cannot be an OFFER line item. OverrideLineItemReqDS.LineItemId = '1'; OverrideLineItemReqDS.Description = 'New Description'; OverrideLineItemReqDS.Quantity = 1; OverrideLineItemReqDS.UnitPrice = 10; OverrideLineItemReqDS.ExtendedPrice = 10; // If VFN_OverrideLineItem() returns *Off, it means that an error // occurred as part of the overall communication process, and the // information will be in ErrorDS - ErrorDS.Message is the main field // to look at for troubleshooting. if not VFN_OverrideLineItem( OverrideLineItemReqDS : OverrideLineItemRspDS : ErrorDS ); // handle error WriteToJobLog( 'Message ID: ' + ErrorDS.MessageId + NewLine ); WriteToJobLog( 'Message: ' + ErrorDS.Message + NewLine ); *INLR = *On; return; else; WriteToJobLog( 'Response Text: ' + OverrideLineItemRspDS.ResponseText + NewLine); WriteToJobLog( 'Result: ' + OverrideLineItemRspDS.Result + NewLine ); WriteToJobLog( 'Result Code: ' + OverrideLineItemRspDS.ResultCode + NewLine ); WriteToJobLog( 'Termination Status: ' + OverrideLineItemRspDS.TerminationStatus + NewLine ); endif; *INLR = *On; return;

Data Structures

D VFN_OverrideLineItemReqDS_t...
D                 DS                  Qualified Template Inz
 
D  DeviceID                           Like(VFN_DeviceId_t)

Required

The ID of the payment device, registered in VFNDVC, on which line items are being displayed.

D  RequestLog                         Like(VFN_Var1Kv_t)

Specifies the file name or path of the request log file. Will have no effect if logging is not enabled.

Example: "req_log.txt","/tmp/logs/request.txt"

D  ResponseLog                        Like(VFN_Var1Kv_t)

Specifies the file name or path of the response log file. Will have no effect if logging is not enabled.

Example: "rsp_log.txt","/tmp/logs/response.txt"

D  RunningSubTotal...
D                                8P 2
 
D  RunningTaxAmount...
D                                8P 2

Required

Default Value: 0.00

D  RunningTransAmount...
D                                8P 2

Required

Default Value: 0.00

D  LineItemId                   10A   Varying

Required

The ID of the previously-added line item to be overridden.

D  Description                  40A   Varying
 
D  Quantity                     10P 0
 
D  UnitPrice                     8P 2
 
D  ExtendedPrice                 8P 2
 
D  ConnectTimeout...
D                                3P 0 Inz(-1)

Override the default value set in VFN_Register() or REGVFNDVC.

Default Value: -1

D  WriteTimeout...
D                                3P 0 Inz(-1)

Override the default value set in VFN_Register() or REGVFNDVC.

Default Value: -1

D  ReadTimeout...
D                                3P 0 Inz(-1)

Override the default value set in VFN_Register() or REGVFNDVC.

Default Value: -1

D VFN_OverrideLineItemRspDS_t...
D                 DS                  Qualified Template Inz
 
D  ResponseText                       Like(VFN_Var1Kv_t)

This field corresponds to the field RESPONSE_TEXT in your device's Verifone documentation.

D  Result                             Like(VFN_Var1Kv_t)

This field corresponds to the field RESULT in your device's Verifone documentation.

D  ResultCode                   10A   Varying

This field corresponds to the field RESULT_CODE in your device's Verifone documentation.

D  TerminationStatus...
D                                     Like(VFN_Var1Kv_t)

This field corresponds to the field TERMINATION_STATUS in your device's Verifone documentation.

D  Counter                      10P 0

This field corresponds to the field COUNTER in your device's Verifone documentation.