T_ATHSCG - Authorization with a Surcharge

**FREE
// Example Program: T_ATHSCG
// Description:
//  This is a test program to illustrate how to call the CTI_Run()
//  subprocedure to perform an authorization that includes a surcharge.
//
//  Surcharging is only available on the FDC Nashville Global, Worldpay
//  VAP, and Visa Platform Connect processors, and each requires the
//  merchant account to be enabled for surcharging before use. On Worldpay
//  VAP, a surcharge sent to an account that isn't enabled will cause the
//  transaction to fail.
//
//  The surcharge amount must already be included in the grand total
//  (PTGNDAMT). CTI does not add it for you. The surcharge is also sent
//  separately in SCGAMT so the issuer and acquirer can track it.
//
//  To achieve this, generate a unique ID with CTI_NextUniqueId(), and
//  then populate and write a record to CTIWSHDR. Then, call CTI_Run()
//  passing in your unique ID as well as the other parameters shown.
//
//  CTI_Run() will return *On if no error was encountered, or *Off
//  if an error occurred. If an error occurred, you should look at
//  the fields in ErrorDS to retrieve information about the error.
//
//  Otherwise, you can perform a CHAIN against the CTIWSRSP physical
//  file, and retrieve the result fields.

Ctl-Opt ActGrp(*Caller) BndDir('CTIBND') Option(*NoDebugIO);

Dcl-F CTIWSHDR Disk(*Ext) Keyed Qualified Usage(*Input:*Output);
Dcl-F CTIWSRSP Disk(*Ext) Keyed Qualified Usage(*Input);

Dcl-Ds HDR ExtName('CTIWSHDR':*Output) Qualified End-Ds;
Dcl-Ds RSP ExtName('CTIWSRSP':*Input) Qualified End-Ds;

/COPY QRPGLECPY,CTICB

// 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 stores the unique ID for this API call
Dcl-S UniqueId Like(CTI_UniqueId_t) Inz;

// This holds any error information returned by the API call
Dcl-Ds ErrorDS LikeDS(CTI_ErrorDS_t) Inz(*LikeDS);

// Modify these fields to specify different card details
Dcl-S CardNumber Char(20) Inz('4111111111111111');
Dcl-S CardCV Char(4) Inz('1234');

// Modify this field to use your merchant ID
Dcl-S MerchantId Like(CTI_MerchantId_t) Inz('ikrengel');

reset ErrorDS;

// Each API call requires a unique ID
UniqueId = CTI_NextUniqueId();

// CTIWSHDR needs to be populated with the transaction data
clear HDR;
HDR.UID = UniqueId;
HDR.CRTDT = %Timestamp();
HDR.ATHRUN = CTI_TRUE;
HDR.MCHID = MerchantId;
HDR.MCHREFCD = 'MYREFCD135';
HDR.CCCRDTYP = '001'; // 001=Visa, 003=AmEx
HDR.CCEXPMM = '10';
// HDR.CCEXPYY needs to contain a four digit year
//  To make this example stay current, we're automatically
//  adjusting the year to be currentYear+1
HDR.CCEXPYY = %Char( %SubDt( %Date() : *Y ) + 1);
HDR.BTFNAM = 'Jim';
HDR.BTLNAM = 'Jones';
HDR.BTST1 = '123 Central & Main';
HDR.BTCTY = 'Mankato';
HDR.BTSTT = 'MN';
HDR.BTPSTCD = '56001';
HDR.BTCNTRY = 'US';
HDR.BTEML = 'asdf@asdf.com';
HDR.PTCUR = 'USD';

// A 12.12 purchase with a 0.36 surcharge. The grand total must include
//  the surcharge.
HDR.PTGNDAMT = '12.48';
HDR.SCGAMT = '0.36';
// D = the surcharge is debited from the customer's account
// C = the surcharge is credited to the customer's account
HDR.SCGSGN = 'D';

write CTIWSHDR.CTIWSHDRR HDR;

if not CTI_Run( UniqueId : ErrorDS : CardNumber : CardCV : MerchantId );
  // If CTI_Run() returns *Off then an error occurred.

  // You should check ErrorDS subfields for info:
  //  ErrorDS.Subproc = Name of CTI subprocedure that threw error
  //  ErrorDS.MessageId = Message ID of the error message
  //  ErrorDS.Message = Error message description
  //  ErrorDS.LogFile = Path to a log file created in the IFS that can
  //   be used for troubleshooting. Log files are generated
  //   automatically whenever an error occurs. You can also force log
  //   files to generate by modifying the value of the LOGALL field in
  //   CTICFGCER for the provided Merchant ID.
  //  ErrorDS.Source =
  //    - CTI_SOURCE_INTERNAL is a general product error.
  //      This could be due to issues with input data, or the
  //      inability to access physical files, etc.
  //
  //    - CTI_SOURCE_TRANSMIT is a product error that specifically
  //      occurred during HTTPS communication with the CyberSource
  //      webservice. This could be due to issues with your network
  //      configuration, proxy setup, internet connection, etc.
  //
  //    - CTI_SOURCE_REMOTE is an error message provided by CyberSource.
  WriteToJobLog( 'Error Message Id: ' + ErrorDS.MessageId + NewLine );
  WriteToJobLog( 'Error Message: ' + ErrorDS.Message + NewLine );
  WriteToJobLog( 'Error Source: ' + ErrorDS.Source + NewLine );

  // All error information is also written to the file CTIERR.
else;
  // If CTI_Run() returned *On the request was successful. You can
  //  access the results in the CTIWSRSP file using the same UniqueID
  //  that was used to create the request record in CTIWSRSP.

  chain UniqueId CTIWSRSP.CTIWSRSPR RSP;
  if %Found(CTIWSRSP);
    // For this sample code we're writing the response data to the job
    //  log, but generally you would extract the data and pass it into
    //  your own data tables. The CTIWSHDR, CTIWSITM, and CTIWSRSP files
    //  should not be used for long-term data storage and should instead
    //  be considered short-term transactional files.
    WriteToJobLog( 'CCAMT: ' + RSP.CCAMT + NewLine );
    WriteToJobLog( 'CCATHCD: ' + RSP.CCATHCD + NewLine );
    WriteToJobLog( 'RSNCD: ' + %Char(RSP.RSNCD) + NewLine );
    WriteToJobLog( 'CCRSNCD: ' + RSP.CCRSNCD + NewLine );
    WriteToJobLog( 'REQID: ' + RSP.REQID + NewLine );
    WriteToJobLog( 'CCPRCRSP: ' + RSP.CCPRCRSP + NewLine );
    // ISSRSPCD is only returned by some processors. A value of 0B1
    //  means the surcharge amount is not permitted on Visa cards
    //  (U.S. acquirers only).
    WriteToJobLog( 'ISSRSPCD: ' + RSP.ISSRSPCD + NewLine );
  endif;
endif;

// Write unique ID to job log for easy reference
WriteToJobLog( 'T_ATHSCG Unique ID: ' + %Char(UniqueId) + NewLine );

*INLR = *On;
return;