Complete reference for all fields returned in PayFacto API v1.0 responses. Parameters are grouped by functional category. Not every field is returned on every endpoint — refer to individual endpoint articles for which fields are always returned vs conditionally returned.
All PayFacto API responses are returned as JSON key-value pairs. Always check returnCode (or recurReturnCode for recurring endpoints) first to determine whether the operation succeeded before reading other fields. A value of 00 indicates success.
Contents
Always check these fields first. A returnCode of 00 indicates success. Any other value means the operation failed or was declined.
Store transactionNumber and invoiceNumber from every successful transaction response — they are required for Void and Refund operations. Display authorizationNumber on every customer receipt.
Three separate date/time fields are returned. timeStamp reflects the PayFacto server clock; trxDate and trxTime reflect the banking acquirer clock and may differ.
These fields identify what kind of transaction was processed and how the card was read.
Card data is always returned masked for PCI compliance. The token field is only present when tokenization is enabled on the merchant account.
All monetary amounts are returned as integers in the smallest currency unit, zero-padded left to 11 digits. Optional amount fields (tip, tax, cashback, surcharge) are only present when applicable.
Verification result fields are only returned when the corresponding data was sent in the request. Your application is responsible for evaluating these results and deciding whether to proceed with the transaction.
EMV fields are only returned for chip card transactions. They contain the raw EMV data required for receipt printing and chargeback documentation.
These fields echo back values sent in the request. They are useful for correlating responses to requests in asynchronous or high-volume environments.
These fields are returned only when the payment was guaranteed via Interac Online. Both fields must be displayed on the merchant's confirmation page.
The captured signature image is returned Base64-encoded. Decode and render it on the merchant receipt when the cvmResults field indicates a signature is required.
These fields are returned by recurring billing endpoints (/v1/recur/*). Use recurReturnCode (not returnCode) to determine success on these endpoints.
These fields are returned by DataCandy gift and loyalty card endpoints. Store transactionConfirmationNumber from every DataCandy response — it is required for commit, cancel, and unlock operations.