Recon
The Recon API gives the ability to access recon files via the VodaPay Gateway for merchant when providing their api-key. Merchants will request the file per day needed for their own recon processes.
Older versions of VodaPay Gateway's APIs. These that are still in use unless specified as deprecated.
https://reconapi.vodapaygatewayuat.vodacom.co.za/
https://reconapi.vodapaygateway.vodacom.co.za/
- Recon files
- Recon File Format - PA0069
Recon files
- Request
- Response
Request
{
"date": "2022-01-13"
}
Request Parameters
datechar, 10 stringRequired
The date of the recon files requested by merchant.
Response
{
"succeeded": true,
"data": ["https://amazonaws.com/file-endpoint"]
}
Request Parameters
Recon File Format - PA0069
The extended Clearing Reconciliation File Format includes back-office transactions – other debits and credits, not directly related to trading, that were considered in determining the value to be cleared. It can therefore be used to reconcile the transactions processed for the day against the result of clearing.
Clearing Reconciliation files are fixed-length text files. They are made up of records that are delimited with a carriage return line feed character. Each record is read and imported on a line by line basis. The filename must comply exactly with the following format: TR_Clearing_Recon_V2_CAID_YYYYMMDDhhmmss.txt where CAID represents the card acceptor ID code and YYYYMMDDhhmmss represents the date and time when the file was generated. Depending on client requirements, a set of Clearing Reconciliation files can be collected into a ZIP archive and delivered daily.
Reconciliation files contain three types of record: One Header record at the beginning of the file Detail records, one or more of which make up the body of the file One Trailer record at the end of the file
Header Record
- Record Identifier
- Reconciliation Date
- File Generation No
- File Type
- Data Direction
- Test/Live indicator
- Settlement Mode
Record Identifieralphanumeric, 2 charRequired
Contains the characters HD.
Reconciliation Datedate, 8 charRequired
The date in YYYYMMDD format.
File Generation Nonumeric, 4 charRequired
Unique per file. Numbering began at 1 and increments by 1 for each file sent. It will start again at 1 when 9999 is reached. Left-padded with zeros.
File Typealphanumeric, 2 charRequired
Identifies the type of file.
The options are:
- CR - credits only
- DR - debits only
- CD - both
- NA - other
Data Directionalphanumeric, 3 charRequired
Indicates the direction of data.
The options are:
- IN - inbound data
- OUT - outbound data.
Test/Live indicatoralphanumeric, 4 charRequired
Indicates whether the data is live or test.
The options are:
- LIVE - actual business data
- TEST - test data.
Settlement Modealphanumeric, 5 charOptional
Indicates the settlement mode. This applies only to transactions cleared by the PSP.
The options are:
- GROSS - gross settlement
- NETTS - nett settlement.
Detail Record
- Record Identifier
- Transaction Date Time
- Card acceptor ID code
- Card acceptor terminal ID
- Retrieval reference number
- Transaction Trace ID
- Authorisation ID
- Transaction Amount
- Transaction Type Code
- Account Reference
- PAN
- Card Expiry Date
- Budget Period
- Currency Code
- Transaction Capture Date
- Transaction Settlement Date
- Transaction Fee
- UUID
- Acquiring Institution ID Code
- Receiving Institution ID Code
- Message Type
- Response Code
- Request Transaction Amount
- Card Reference
- Cashback Amount
- Sequence Number
- Retrieval Reference Number Extended
- Extended Transaction Type
- Distribution Sign
- Distribution Party Type
- Distribution Party Account Reference
- Distribution Party Name
- VAT Calculation
- Back Office Transaction Amount
- VAT
- Cleared by PSP
Record Identifieralphanumeric, 2 charRequired
Contains the characters DL.
Transaction Date Timedate, 14 charRequired
The date in YYYYMMDDhhmmss format.
Card acceptor ID codealphanumeric, 15 charOptional
The unique Merchant Acquiring Number of the applicable Merchant. Right-pad with spaces.
Card acceptor terminal IDalphanumeric, 8 charOptional
The Merchant Terminal ID of the applicable Merchant. Right-pad with spaces.
Retrieval reference numberalphanumeric, 12 charRequired
A unique transaction identifier.
Transaction Trace IDnumeric, 6 charRequired
A secondary transaction identifier.
Authorisation IDalphanumeric, 6 charRequired
If absent, fill with spaces.
Transaction Amountnumeric, 12 charRequired
The total amount of the transaction, expressed as a positive number in cents. Left-padded with zeros.
Transaction Type Codenumeric, 2 charRequired
Transaction type code as defined in ISO 8583. Refer to the transaction type table for details.
Account Referencealphanumeric, 30 charRequired
Right-padded with spaces.
PANnumeric pad, 19 charRequired
Primary Account Number, right-padded with spaces. Mandatory but can be masked by replacing characters 7-12 with asterisks. Can be omitted by filling with spaces.
Card Expiry Datenumeric, 4 charRequired
Mandatory but can be omitted by filling with zeros. If no PAN is supplied, default to 5012.
Budget Periodnumeric, 2 charRequired
Defaults to 00 on import.
Currency Codenumeric, 3 charRequired
ISO 4217 Currency code.
Transaction Capture Datenumeric, 8 charRequired
The business date when the transaction occurred, in YYYYMMDD format.
Transaction Settlement Datenumeric, 8 charRequired
The business date when the transaction was settled between acquirer and issuer, in YYYYMMDD format.
Transaction Feenumeric, 12 charRequired
The transaction fee or interchange fee applied to the transaction, left-padded with zeros.
UUIDalphanumeric, 36 charRequired
The unique transaction identifier, expressed in GUID (Globally Unique Identifier) format.
Acquiring Institution ID Codenumeric pad, 11 charRequired
Optional - The ID of the institution originating the transaction, right-padded with spaces. Mandatory - but can be omitted by filling with spaces.
Receiving Institution ID Codenumeric pad, 11 charRequired
Optional - The ID of the institution receiving the transaction, right-padded with spaces. Mandatory - but can be omitted by filling with spaces.
Message Typenumeric, 4 charOptional
A classification for the high-level function of a transaction message.
Response Codealphanumeric, 2 charOptional
A code describing the outcome of a transaction message.
Request Transaction Amountnumeric, 12 charOptional
The transaction amount of the original request transaction.
Card Referencealphanumeric, 50 charOptional
Right-Padded with spaces.
Cashback Amountnumeric, 12 charOptional
The amount of cashback included in the transaction, expressed as a positive number in cents. Left-padded with zeros.
Sequence Numbernumeric, 5 charOptional
The number of the record within the file.
Retrieval Reference Number Extendedstring, 99 charOptional
An additional field for carrying reference information, typically an order number. Right-padded with spaces.
Extended Transaction Typestring, 4 charOptional
This field defines the general transaction type, providing more detail about the type of transaction. It allows fees collected from the merchant to be distinguished from other transactions. Values between 2301 and 23ZZ indicate merchant fees.
Distribution Signstring, 5 charOptional
Indicates debit or credit.
Distribution Party Typestring, 50 charOptional
Indicates the type of party to which the record applies.
Distribution Party Account Referencestring, 50 charOptional
The reference that is passed in the clearing instruction.
Distribution Party Namestring, 50 charOptional
The name of the distribution party in the back office.
VAT Calculationstring, 15 charOptional
Indicates whether a VAT calculation has been performed.
Back Office Transaction Amountnumeric, 12 charOptional
Indicates the value of the transaction in the back office.
VATnumeric, 12 charOptional
Indicates the VAT value in the case of a VAT-exclusive calculation.
Cleared by PSPstring, 1 charOptional
Indicates whether the transactions have been cleared by the PSP.
Y - Transactions that have been cleared by the PSP and the funds have been paid to the merchant.
N - Transactions that are to be cleared by another party.
Trailer Record
- Record Identifier
- Reconciliation Date
- File Generation No
- Total Records
- Total DR Records
- Total CR Records
- Total DR Value Cleared by PSP
- Total CR Value Cleared by PSP
- Total DR Value Not Cleared by PSP
- Total CR Value Not Cleared by PSP
Record Identifieralphanumeric, 2 charRequired
Contains the characters TR.
Reconciliation Datedate, 8 charRequired
YYYYMMDD format.
File Generation Nonumeric, 4 charRequired
Unique per file. Numbering began at 1 and increments by 1 for each file sent. It will start again at 1 when 9999 is reached. Left-padded with zeros.
Total Recordsnumeric, 8 charRequired
Total number of records in the file, including the header and trailer. Left-padded with zeros.
Total DR Recordsnumeric, 6 charRequired
Total number of debit records in the file. Left-padded with zeros. If transactions can neither be classified as Debit or Credit types, populate this field with 6 zeros.
Total CR Recordsnumeric, 6 charRequired
Total number of credit records in the file. Left-padded with zeros. If transactions can neither be classified as Debit or Credit types, populate this field with 6 zeros.
Total DR Value Cleared by PSPnumeric, 12 charRequired
Total value of those debit records in the file that are marked as cleared by the PSP, given in cents, left-padded with zeros. If transactions can neither be classified as debit or credit types, populate this field with 12 zeros.
Total CR Value Cleared by PSPnumeric, 12 charRequired
Total value of those credit records in the file that are marked as cleared by the PSP, given in cents, left-padded with zeros. If transactions can neither be classified as debit or credit types, populate this field with 12 zeros.
Total DR Value Not Cleared by PSPnumeric, 12 charRequired
Total value of those debit records in the file that are marked as not cleared by the PSP, given in cents, left-padded with zeros. If transactions can neither be classified as debit or credit types, populate this field with 12 zeros.
Total CR Value Not Cleared by PSPnumeric, 12 charRequired
Total value of those credit records in the file that are marked as not cleared by the PSP, given in cents, left-padded with zeros. If transactions can neither be classified as debit or credit types, populate this field with 12 zeros.