Zip and Country Codes|
Development
Reference Materials
Description: Provides access to files (documents) store.
File Store Search |
|
Includes various file store search parameters.
|
| ¦_ |
Max Results
|
Allows to select the limit of available records shown on the form. Available limits: 200, 1000, 2000, 3000. |
| ¦_ |
Find
|
Executes search based on predefined criteria. |
| ¦_ |
Clear
|
Clears any selected criteria - resets the form to its original state. |
| ¦_ |
Portfolio/Merchant
|
Search criteria to locate files by an associated portfolio/merchant ID. |
| ¦_ |
Account
|
Search criteria to locate files by an associated account ID. |
| ¦_ |
Provider
|
Search criteria to locate files by an associated processor. |
| ¦_ |
File Store Code
|
Search criteria to locate files by particular code. |
| ¦_ |
Sub-Batch Code
|
Search criteria to locate files by sub-batch code. |
| ¦_ |
Status
|
Search criteria to locate files by the status of processing. |
| ¦_ |
Pending Translation
|
Indicates that transactional data is being converted from the gateway format to the processor's format. |
| ¦_ |
Pending Tokenization
|
Indicates that batch file is waiting for tokenization. |
| ¦_ |
Pending Detokenization
|
Indicates that batch file is waiting for detokenization. |
| ¦_ |
Pending Detranslation
|
Indicates that response file is processed by a processor and is being converted from a processor specific message format to the gateway format. |
| ¦_ |
Pending Account Update
|
Indicates that file is being on account update. |
| ¦_ |
Pending Aggregation
|
Indicates that file is waiting to be aggregated with another file within the system. |
| ¦_ |
Pending Upload
|
Indicates that request file awaits uploading to the processor. |
| ¦_ |
Pending Download
|
Indicates that response file awaits downloading from the processor. |
| ¦_ |
Pending Deaggregation
|
Indicates that response file is waiting to be de-aggregated within the system. |
| ¦_ |
Processed
|
Indicates that file is successfully processed. |
|
Type
|
Search criteria to locate files by the type. |
| ¦_ |
Return
|
Indicates a return file (usually declined ACH transactions), submitted from processor to UniPay. No request file is generated, before a return file is sent. |
| ¦_ |
Request Response
|
Indicates a standard pair of a request file with response, submitted to this request. |
| ¦_ |
Verification
|
Indicates a file, that is submitted to processor's system to check processing status of a previously uploaded request file. |
Request |
|
Includes additional details on request file.
|
| ¦_ |
File Name
|
Search criteria to locate file with a specific name by entering either full or partial name. |
| ¦_ |
From Date
|
Search criteria to locate file within the certain date range.
Either beginning or end date is necessary. |
| ¦_ |
To Date
|
Search criteria to locate file within the certain date range.
Either beginning or end date is necessary. |
Response |
|
Includes additional details on response file.
|
| ¦_ |
File Name
|
Search criteria to locate file with a specific name by entering either full or partial name. |
| ¦_ |
From Date
|
Search criteria to locate file within the certain date range.
Either beginning or end date is necessary. |
| ¦_ |
To Date
|
Search criteria to locate file within the certain date range.
Either beginning or end date is necessary. |
File Store List |
|
Includes the list of files found based on the search criteria specified.
|
| ¦_ |
Info
|
Includes various information about the file, such as:
- File ID - an identifier of the file generated by the gateway,
- Account ID - an identifier of the associated account,
- Processor name - a name of the processor that the file is submitted to,
- Aggregation code,
- File type - a type of the file (for example, request, response, etc)
- Operation type - a type of the operation.
|
| ¦_ |
Request File Name
|
The name of the request file.
References: File Store.Request File Name
|
| ¦_ |
Request Date
|
The date when the file was requested.
References: File Store.Request Date
|
| ¦_ |
Aggregation Date
|
The date when the file was aggregated. References: File Store.Aggregation Date
|
| ¦_ |
Response File Name
|
The name of the response file.
References: File Store.Response File Name
|
| ¦_ |
Response Date
|
The date when the response file was created.
References: File Store.Response Date
|
| ¦_ |
Status
|
Status of the file processing.
References: File Store.Status
|
| ¦_ |
Amount
|
Total amount paid for the item (including tax and discount).
References: File Store.Total Amount
|
| ¦_ |
View File
|
Allows to see detailed information about the selected file. Opens Form:
View File Store
|
| ¦_ |
Totals
|
Allows to see totals of the selected file. |
View File Store |
|
Includes the detailed information about the selected file.
|
| ¦_ |
Totals
|
Allows to see totals of the selected file. |
| ¦_ |
Close
|
Closes the form without saving any changes. |
Request |
|
Includes additional details on the request file.
|
| ¦_ |
File Name
|
The name of the request file.
References: File Store.Request File Name
|
| ¦_ |
Date
|
The date when the file was requested.
References: File Store.Request Date
|
Response |
|
Includes additional details on the response file.
|
| ¦_ |
File Name
|
The name of the response file.
References: File Store.Response File Name
|
| ¦_ |
Date
|
The date when the response file was created.
References: File Store.Response Date
|
Details |
|
Includes additional details on the selected file.
|
| ¦_ |
Merchant Account
|
Code of Merchant Account to which instance of this object is attributed to.
Depending on the context, Merchant Account Code field may contain either Merchant Code or Merchant Account Code.
The field is primarily used for data partitioning and data management, to make it easy to determine the ownership of a record within the database.
References: File Store.Merchant Account Code
|
| ¦_ |
Provider Code
|
Code of the provider that is processing the file.
References: File Store.Provider Code
|
| ¦_ |
Operation
|
Represents the type of an operation.
References: File Store.Operation CL
|
| ¦_ |
Status
|
Status of the file processing.
References: File Store.Status
|
| ¦_ |
Total Records
|
Total number of transaction records in the file.
References: File Store.Total Count
|
| ¦_ |
Total Amount
|
Total amount paid for the item (including tax and discount).
References: File Store.Total Amount
|
| ¦_ |
Awaits Response
|
Indicates whether the file is waiting for the response.
References: File Store.Is Wait Response
|
| ¦_ |
Next Attempt Date
|
The date when the next attempt of processing the file is allowed.
References: File Store.Next Attempt Date
|
Aggregated Info |
|
Includes aggregation information about the selected file.
|
| ¦_ |
Request File Name
|
The name of the request file.
References: File Store.Request File Name
|
| ¦_ |
Response File Name
|
The name of the response file.
References: File Store.Response File Name
|
| ¦_ |
ID
|
Identifier of the object used for references; auto-incremented integer value.
References: File Store.Id
|
| 