VFN_Authorize()
This subprocedure calls Verifone’s Authorize service.
Subprocedure Prototype
|
Returns *OFF if an error occurs during processing, *ON otherwise. |
|
|
|
|
|
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
|
|
|
Required The ID of the payment device, registered in VFNDVC, that is processing the transaction. |
|
Specifies the file name or path of the request log file. Will have no effect if logging is not enabled. Example: |
|
Specifies the file name or path of the response log file. Will have no effect if logging is not enabled. Example: |
|
Required For VX Devices, this value is limited to a 7P 2 field. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
MX Solutions Devices only |
|
|
|
|
|
MX Solutions Devices only |
|
MX Solutions Devices only |
|
MX Solutions Devices only |
|
MX Solutions Devices only |
|
MX Solutions Devices only |
|
MX Solutions Devices only |
|
MX Solutions Devices only |
|
MX Solutions Devices only |
|
MX Solutions Devices only This timestamp field will be formatted internally in order to match Verifone's requirements. |
|
MX Solutions Devices only |
|
|
|
|
|
MX Solutions Devices only |
|
Override the default value set in VFN_Register() or REGVFNDVC. Default Value: |
|
Override the default value set in VFN_Register() or REGVFNDVC. Default Value: |
|
Override the default value set in VFN_Register() or REGVFNDVC. Default Value: |
|
|
|
This field corresponds to the field RESPONSE_TEXT in your device's Verifone documentation. |
|
This field corresponds to the field RESULT in your device's Verifone documentation. |
|
This field corresponds to the field RESULT_CODE in your device's Verifone documentation. |
|
This field corresponds to the field TERMINATION_STATUS in your device's Verifone documentation. |
|
This field corresponds to the field COUNTER in your device's Verifone documentation. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|