VFN_Credit()
This subprocedure calls Verifone’s Credit 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_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
|
|
|
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 This timestamp field will be formatted internally in order to match Verifone's requirements. |
|
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. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|