VFN_Authorize()

This subprocedure calls Verifone’s Authorize service.

Subprocedure Prototype

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

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

D  pRequestDS                         LikeDS(VFN_AuthorizeReqDS_t) Const
 
D  pResponseDS                        LikeDS(VFN_AuthorizeRspDS_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_AUTH // Description: // This is a test program to illustrate how to call the // VFN_Authorize() subprocedure. // // 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 AuthReqDS LikeDS(VFN_AuthorizeReqDS_t) Inz(*LikeDS); // This will store parsed response data from the API call Dcl-Ds AuthRspDS LikeDS(VFN_AuthorizeRspDS_t) Inz(*LikeDS); reset ErrorDS; reset AuthReqDS; reset AuthRspDS; // This must be a device that has already been successfully registered // with VFN_Register() and which exists in VFNDVC. AuthReqDS.DeviceID = 'test'; // These fields can be assigned a log file name, and will write the // request and response xml data to the logging directory. AuthReqDS.RequestLog = 'T_AUTH_Request.xml'; AuthReqDS.ResponseLog = 'T_AUTH_Response.xml'; // This data structure should be populated per the Verifone documentation // and many of the fields are considered optional. AuthReqDS.AllowDupTran = ''; AuthReqDS.AuthCode = ''; AuthReqDS.CardExpMonth = ''; AuthReqDS.CardExpYear = ''; AuthReqDS.CardToken = ''; AuthReqDS.CmrclFlag = ''; AuthReqDS.CustomerStreet = ''; AuthReqDS.CustomerZip = ''; AuthReqDS.ForceFlag = ''; AuthReqDS.ManualEntry = ''; AuthReqDS.PaymentType = ''; AuthReqDS.RefTroutd = ''; AuthReqDS.TaxAmount = 0; AuthReqDS.TaxInd = ''; AuthReqDS.TransAmount = 0; // if VFN_Authorize() 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_Authorize( AuthReqDS : AuthRspDS : ErrorDS ); // handle error WriteToJobLog( 'Message ID: ' + ErrorDS.MessageId + NewLine ); WriteToJobLog( 'Message: ' + ErrorDS.Message + NewLine ); *INLR = *On; return; else; // Now you can check the response data structure for any status info // or data returned from the device: WriteToJobLog( 'Response Text: ' + AuthRspDS.ResponseText + NewLine ); WriteToJobLog( 'Result: ' + AuthRspDS.Result + NewLine ); WriteToJobLog( 'Response Code: ' + AuthRspDS.ResultCode + NewLine ); WriteToJobLog( 'Termination Status: ' + AuthRspDS.TerminationStatus + NewLine ); // Please see QRPGLECPY,VFNCB for the other fields // in VFN_AuthorizeRspDS_t endif; *INLR = *On; return;

Data Structures

D VFN_AuthorizeReqDS_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  PaymentType                        Like(VFN_Var1Kv_t)
 
D  PaymentSubtype...
D                                     Like(VFN_Var1Kv_t)
 
D  AuthCode                     16A   Varying
 
D  ManualEntry                    N   Inz(*OFF)
 
D  CustomerStreet...
D                               20A   Varying
 
D  CustomerZip                   9A   Varying
 
D  RefTroutd                    10A   Varying
 
D  BillPay                        N
 
D  ForceFlag                      N
 
D  TaxAmount                     8P 2
 
D  TaxInd                        1A
 
D  CmrclFlag                     1A
 
D  AcctNum                      25A   Varying

MX Solutions Devices only

D  CardExpMonth                  2A
 
D  CardExpYear                   2A
 
D  Encrypt                        N

MX Solutions Devices only

D  BarCode                     100A   Varying

MX Solutions Devices only

D  PinCode                      10A   Varying

MX Solutions Devices only

D  CVV2                         10A   Varying

MX Solutions Devices only

D  CreditPlanNbr                10A   Varying

MX Solutions Devices only

D  PurchaseAPR                  12A   Varying

MX Solutions Devices only

D  APRType                       1A

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  AllowDupTran                  6A

MX Solutions Devices only

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_AuthorizeRspDS_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  LPToken                            Like(VFN_Var1Kv_t)
 
D  PaymentMedia                       Like(VFN_Var1Kv_t)
 
D  PaymentType                        Like(VFN_Var1Kv_t)
 
D  PPCV                               Like(VFN_Var1Kv_t)
 
D  AcctNum                            Like(VFN_Var1Kv_t)
 
D  AuthCode                           Like(VFN_Var1Kv_t)
 
D  AvailableBalance...
D                                     Like(VFN_Var1Kv_t)
 
D  ApprovedAmount...
D                                     Like(VFN_Var1Kv_t)
 
D  CardEntryMode                      Like(VFN_Var1Kv_t)
 
D  Cardholder                         Like(VFN_Var1Kv_t)
 
D  CardExpMonth                  2A
 
D  CardExpYear                   2A
 
D  AVSCode                            Like(VFN_Var1Kv_t)
 
D  Cvv2Code                           Like(VFN_Var1Kv_t)
 
D  MerchDecl                          Like(VFN_Var1Kv_t)
 
D  MerchRef                           Like(VFN_Var1Kv_t)
 
D  Reference                          Like(VFN_Var1Kv_t)
 
D  TraceCode                          Like(VFN_Var1Kv_t)
 
D  AuthRespCode                       Like(VFN_Var1Kv_t)
 
D  SAFNum                             Like(VFN_Var1Kv_t)
 
D  BankUserdata                       Like(VFN_Var1Kv_t)
 
D  ReceiptData                        Like(VFN_Var1Kv_t)
 
D  TransDate                          Like(VFN_Var1Kv_t)
 
D  TransTime                          Like(VFN_Var1Kv_t)
 
D  TrainingMode                       Like(VFN_Var1Kv_t)
 
D  VspCode                            Like(VFN_Var1Kv_t)
 
D  VspResultDesc...
D                                     Like(VFN_Var1Kv_t)
 
D  VspTrxID                           Like(VFN_Var1Kv_t)
 
D  LtyAcctNum                         Like(VFN_Var1Kv_t)
 
D  LtyPhone                           Like(VFN_Var1Kv_t)
 
D  LtyEmail                           Like(VFN_Var1Kv_t)
 
D  LtyTokenID                         Like(VFN_Var1Kv_t)
 
D  RewardReceiptText...
D                                     Like(VFN_Var1Kv_t)
 
D  RewardID                           Like(VFN_Var1Kv_t)
 
D  RewardAmount                       Like(VFN_Var1Kv_t)
 
D  LoyaltyVAS                         Like(VFN_Var1Kv_t)
 
D  Publisher                          Like(VFN_Var1Kv_t)
 
D  LoyaltyPayload...
D                                     Like(VFN_Var1Kv_t)
 
D  SignatureData...
D                                     Like(VFN_Var1Kv_t)
 
D  MimeType                           Like(VFN_Var1Kv_t)
 
D  DuplicateTransaction...
D                                     Like(VFN_Var1Kv_t)
 
D  CardToken                          Like(VFN_Var1Kv_t)
 
D  HostRespCode                       Like(VFN_Var1Kv_t)
 
D  MerchID                            Like(VFN_Var1Kv_t)
 
D  TermID                             Like(VFN_Var1Kv_t)
 
D  Lane                               Like(VFN_Var1Kv_t)
 
D  TxnPosEntryMode...
D                                     Like(VFN_Var1Kv_t)