VFN_Credit()

This subprocedure calls Verifone’s Credit service.

Subprocedure Prototype

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

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

D  pRequestDS                         LikeDS(VFN_CreditReqDS_t) Const
 
D  pResponseDS                        LikeDS(VFN_CreditRspDS_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_CREDIT // Description: // This is a test program to illustrate how to call the VFN_Credit() // subprocedure to processes a payment refund. // // This program assumes you have already called VFN_StartSession(), // and 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 CreditReqDS LikeDS(VFN_CreditReqDS_t) Inz(*LikeDS); // This will store parsed response data from the API call Dcl-Ds CreditRspDS LikeDS(VFN_CreditRspDS_t) Inz(*LikeDS); reset ErrorDS; reset CreditReqDS; reset CreditRspDS; // This must be a device that has already been successfully registered // with VFN_Register() and which exists in VFNDVC. CreditReqDS.DeviceID = 'test'; // The Credit (refund) request has a number of optional parameters. // For simplicity, we will use only parameters that are required // or recommended to refund a CREDIT transaction. CreditReqDS.TransAmount = 13.27; CreditReqDS.PaymentType = 'CREDIT'; CreditReqDS.CTroutd = '5'; // if VFN_Credit() 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_Credit( CreditReqDS : CreditRspDS : ErrorDS ); // handle error WriteToJobLog( 'Message ID: ' + ErrorDS.MessageId + NewLine ); WriteToJobLog( 'Message: ' + ErrorDS.Message + NewLine ); *INLR = *On; return; else; // The Credit (refund) operation returns many fields. For simplicity, // we will print only some important ones to the job log to // confirm a successful refund transaction. WriteToJobLog( 'Response Text: ' + CreditRspDS.ResponseText + NewLine ); WriteToJobLog( 'Result: ' + CreditRspDS.Result + NewLine ); WriteToJobLog( 'Result Code: ' + CreditRspDS.ResultCode + NewLine ); WriteToJobLog( 'Termination Status: ' + CreditRspDS.TerminationStatus + NewLine ); WriteToJobLog( 'Client Transaction Routing ID: ' + CreditRspDS.CTroutD + NewLine ); WriteToJobLog( 'Approved Amount: ' + CreditRspDS.ApprovedAmount + NewLine ); WriteToJobLog( 'Payment Type: ' + CreditRspDS.PaymentType + NewLine ); // Please see QRPGLECPY,VFNCB for the other fields // in VFN_CreditRspDS_t endif; *INLR = *On; return;

Data Structures

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

Required

The ID of the payment device, registered in VFNDVC, that is processing the transaction.

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  TransAmount                   8P 2

Required

For VX Devices, this value is limited to a 7P 2 field.

D  EBTSnapEligible...
D                                8P 2
 
D  PaymentType                        Like(VFN_Var1Kv_t)
 
D  PaymentSubtype...
D                                     Like(VFN_Var1Kv_t)
 
D  ManualEntry                    N
 
D  PaymentTypes                       Like(VFN_Var1Kv_t)

MX Solutions Devices only

D  CTroutd                      10A   Varying
 
D  OrigAcctNum                  20A   Varying

MX Solutions Devices only

D  ForceFlag                      N
 
D  AcctNum                      25A   Varying
 
D  CardExpMonth                  2A
 
D  CardExpYear                   2A
 
D  Encrypt                        N
 
D  BarCode                     100A   Varying
 
D  PinCode                      10A   Varying
 
D  CVV2                         10A   Varying
 
D  CreditPlanNbr                 5A   Varying

MX Solutions Devices only

D  PromoCode                    10A   Varying

MX Solutions Devices only

D  OrderDateTime                  Z   Inz(*LOVAL)

MX Solutions Devices only

This timestamp field will be formatted internally in order to match Verifone's requirements.

D  Reference                    40A   Varying

MX Solutions Devices only

D  CardToken                    40A   Varying
 
D  BankUserData                 50A   Varying
 
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_CreditRspDS_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.

D  TransSeqNum                        Like(VFN_Var1Kv_t)
 
D  IntrnSeqNum                        Like(VFN_Var1Kv_t)
 
D  Troutd                             Like(VFN_Var1Kv_t)
 
D  CTroutd                            Like(VFN_Var1Kv_t)
 
D  AuthCode                           Like(VFN_Var1Kv_t)
 
D  LPToken                            Like(VFN_Var1Kv_t)
 
D  AcctNum                            Like(VFN_Var1Kv_t)
 
D  CardExpMonth                  2A
 
D  CardExpYear                   2A
 
D  CardEntryMode                      Like(VFN_Var1Kv_t)
 
D  Cardholder                         Like(VFN_Var1Kv_t)
 
D  ApprovedAmount...
D                                     Like(VFN_Var1Kv_t)
 
D  AvailableBalance...
D                                     Like(VFN_Var1Kv_t)
 
D  FSAvailBalance...
D                                     Like(VFN_Var1Kv_t)
 
D  CBAvailBalance...
D                                     Like(VFN_Var1Kv_t)
 
D  PaymentMedia                       Like(VFN_Var1Kv_t)
 
D  PaymentType                        Like(VFN_Var1Kv_t)
 
D  PPCV                               Like(VFN_Var1Kv_t)
 
D  EbtType                            Like(VFN_Var1Kv_t)
 
D  AuthRespCode                       Like(VFN_Var1Kv_t)
 
D  HostRespCode                       Like(VFN_Var1Kv_t)
 
D  BankUserdata                       Like(VFN_Var1Kv_t)
 
D  SAFNum                             Like(VFN_Var1Kv_t)
 
D  MerchID                            Like(VFN_Var1Kv_t)
 
D  TermID                             Like(VFN_Var1Kv_t)
 
D  ReceiptData                        Like(VFN_Var1Kv_t)
 
D  TransDate                          Like(VFN_Var1Kv_t)
 
D  TransTime                          Like(VFN_Var1Kv_t)
 
D  BatchTraceID                       Like(VFN_Var1Kv_t)
 
D  VspCode                            Like(VFN_Var1Kv_t)
 
D  VspResultDesc...
D                                     Like(VFN_Var1Kv_t)
 
D  VspTrxID                           Like(VFN_Var1Kv_t)
 
D  CardToken                          Like(VFN_Var1Kv_t)