CTI_QueryTransaction()
This subprocedure is used to query a transaction using the CyberSource REST Transaction Query API. This subprocedure requires a record for your merchant ID in CTICFGRPT, and you must populate the record with a shared and secret key pair for use with CyberSource’s HTTP Signature Authentication. For more information on generating these keys, please see this guide from CyberSource: Create a Shared Secret Key for HTTP Signature Authentication
The ADDRPTKEY command can be used to easily create a record for your merchant ID and generated security keys in CTICFGRPT.
The query response will be downloaded to an IFS file in the download directory specified in your CTICFGMCH record. This file can be parsed with the CTI_ParseTransactionQuery() subprocedure.
If an error occurs, this subprocedure will return *OFF, and information about the error will be present in the pErrorDS parameter which contains a CTI_ErrorDS_t data structure.
Subprocedure Prototype
|
Returns *OFF if an error occurs during processing, *ON otherwise. |
|
Unique ID generated with CTI_NextUniqueID() Required |
|
A data structure containing configuration information for the query to be performed Required |
|
Error data structure used to capture subprocedure and CyberSource errors Required |
Data Structures
|
|
|
Merchant ID used to process the transaction Required |
|
CyberSource environment where the report will be retrieved from Required Valid Values:
|
|
Unique label to identify the security key in CTICFGRPT to be used Default Value: |
|
CyberSource unique identifier for the transaction to be queried |
|
Name of the file where the report will be downloaded. This file will be saved in the default download directory set for the specified merchant ID in CTICFGMCH |
|
|
|
Name of subprocedure returning error |
|
Message ID of error message |
|
Error message text |
|
Error message source |
|
IFS filepath of generated log file |
Input Table Files
|
Record CyberSource Report API Configuration Record |
|
Key Merchant ID for the reporting account |
|
Key CyberSource environment for which the security key was generated |
|
Key Optional unique identifier for the security key, to allow multiple keys for one merchant ID/environment |
|
CyberSource HTTP Signature Authentication shared key |
|
CyberSource HTTP Signature Authentication secret key |