Response Parameters

accountType

The account type represents the client's account in which the financial transaction took place.

Format	Length	Possible Values
Alphanumeric	1	“C” chequing account “S” savings account

amount

Same as request parameter Amount

authorizationNumber

The authorization number is obtained following the successful completion of the transaction. The display of the authorization number is mandatory for all successful payments.

Format	Length	Possible Values
Alphanumeric	8	Example: “APPROV99”

avsStatus

This parameter posts the verification status in relation to the code provided in the request.

Format	Length	Possible Values
Alphanumeric	1	“M” Address and ZIP/Postal match “N” Address and ZIP/Postal do NOT match “Z” ZIP/Postal matches, but Address does NOT match “A” Address matches, but ZIP/Postal does NOT match “U” AVS unavailable or not supported

See Address Verification Status (AVS) Result Codes for complete result

bankTerminalNumber

This number identifies the terminal at the banking acquirer's that processed the transaction.

Format	Length	Possible Values
Alphanumeric	8	“00000000”

batchNumber

The batch number identifies the batch used by the terminal to process the transaction.

Format	Length	Possible Values
Numeric	4	“0000”

cardNumber

Same as request parameter CardNumber

cardType

Same as request parameter CardType

cashbackAmount

This parameter is the cash back amount of the financial transaction.
The value also contains the decimal part of the transaction. Left (0) padding.

Format	Length	Possible Values
Numeric	11	Example : $4,29 is “00000000429”

companyNumber

Same as request parameter CompanyNumber

customerNumber

Same as request parameter CustomerNumber

cvmResults

This parameter is the cardholder verification method result. This parameter is used to determine if a signature line must be printed on a receipt.

Format	Length	Possible Values
Alphanumeric	6	“030000”

Signature line must be printed if the 2 first digits of the CVM are: 03, 05, 43, 45, 1E or 5E

cvv2Cvc2Status

This parameter posts the verification status in relation to the code provided in the request

Format	Length	Possible Values
Alphanumeric	1	“M” Matches “N” Not Matches “ “ Unknown

demoMode

This parameter indicate if the terminal is in demo mode or not

Format	Length	Possible Values
Alphanumeric	4	“true” Demo mode is ACTIVE

email

This email entered on the hosted payment page.

Format	Length	Possible Values
Alphanumeric	250	“test@test.com”

emvAID

This parameter is the EMV Application identifier

Format	Length	Possible Values
Alphanumeric	32	“AID: A000000277”

emvLabel

This parameter is the EMV label

Format	Length	Possible Values
Alphanumeric	16	Examples: “Interac” “Visa” “Mastercard”

emvTC

This parameter is the EMV Transaction cryptogram.

Format	Length	Possible Values
Alphanumeric	40	“TC: A2E51243D4C7E551” “AAC: A2E51243D4C7E551”

emvTSI

This parameter is the EMV transaction status information.

Format	Length	Possible Values
Alphanumeric	4	“F800”

emvTVR

This parameter is the EMV terminal verification result.

Format	Length	Possible Values
Alphanumeric	10

errorDescription

This parameter is an description on the error. It give more information on the result code. Only present on NOT APPROVED transaction.

Format	Length	Possible Values
Alphanumeric	50

expirationDate

Same as request parameter ExpirationDate

holderName

This parameter is a the cardholder name entered on the hosted payment page

Format	Length	Possible Values
Alphanumeric	50

invoiceNumber

Same as request parameter InvoiceNumber

iopIssuerConfirmationNumber

Same as request parameter IopIssuerConfirmationNumber

iopIssuerName

Same as request parameter IopIssuerName

languageCode

Same as request parameter LanguageCode

merchantNumber

Same as request parameter MerchantNumber

operatorId

Same as request parameter OperatorID

receiptDisp

The “display receipt” message is generated by the PayFacto Network. It can also be used to create a receipt.

Format	Length	Possible Values
Alphanumeric	32	” APPROVED-THANK-YOU “

referenceNumber

The reference number is obtained following the successful completion of the transaction.

Format	Length	Possible Values
Alphanumeric	10	Example: “0000000000”

returnCode

The return code identifies the exact status of a transaction result, indicating whether the transaction succeeded or failed. The return code for a successful transaction completion is ” 00”. All other return codes mean that a problem lead to a transaction failure. For a complete list, refer to the document on return codes.

Format	Length	Possible Values
Alphanumeric	4	Example: “ 00” or “9121”

secureID

This parameter is the identifier of a secure redirection/PayFactoObjects session.

Format	Length	Possible Values
Alphanumeric	35	“127584m4sc8698590p0r13605tu6o3ofjpi”

sequenceNumber

The sequence number is generated by the banking acquirer.

Format	Length	Possible Values
Alphanumeric	12	“000011112222”

serverNumber

The server number identifies the PayFacto Network server in which the transaction was processed.

Format	Length	Possible Values
Alphanumeric	4	“0000”

signatureBase64Png

The base64 encoded PNG image of the captured signature.
Since PNG is a compressed format, the length of the returned value is not static. The image as an uncompressed BPM is around 5000 bytes, usually much less when compressed into PNG (around 700 bytes).

Format	Length	Possible Values
Alphanumeric(Base64)	Around 700 bytes	A 310×100 PNG encoded to base64

surchargeAmount

This parameter is the surcharge amount of the financial transaction.
The value also contains the decimal part of the transaction. Left (0) padding.

Format	Length	Possible Values
Numeric	11	Example : $4,29 is “00000000429”

taxAmount

This parameter is the tax amount of the financial transaction.
The value also contains the decimal part of the transaction. Left (0) padding.

Format	Length	Possible Values
Numeric	11	Example : $4,29 is “00000000429”

terminalDisp

The terminal displays the transaction message for the user of the terminal, the POS cash register or the Internet page.

Format	Length	Possible Values
Alphanumeric	24	“APPROVED “

terminalInvoiceNumber

This parameter is the terminal invoice number

Format	Length	Possible Values
Numeric	12

terminalNumber

The terminal number identifies the terminal in the PayFacto Network used to process the transaction.

Format	Length	Possible Values
Numeric	5	“00000”

threeDSStatus

This parameter posts the verification status in relation to the code provided in the request

Format	Length	Possible Values
Alphanumeric	1	“P” Passed validation “F” Failed validation “N” Not validated or not supported

See 3D Secure Result Codes (VbV CAVV/ SafeKey AEVV) for complete results.

timeStamp

This field identifies the date and time the transaction was processed in the payment server.
The format is: “YYYYMMDD-HHMMSSCC”

Format	Length	Possible Values
Alphanumeric	17	“20170501-01010101

tipAmount

This parameter is the tip amount of the financial transaction.
The value also contains the decimal part of the transaction. Left (0) padding.

Format	Length	Possible Values
Numeric	11	Example : $4,29 is “00000000429”

token

This parameter is the identifier of a token linked to a cardholder.

Format	Length	Possible Values
Alphanumeric	35	“127584m4sc8698590p0r13605tu6o3ofjpi”

transactionNumber

The transaction number is obtained on a request. This number is a unique identifier for PayFacto gateway.

Format	Length	Possible Values
Numeric	12	“000111222333”

trxCode

This code determines which transaction was processed.

Format	Length	Possible Values
Alphanumeric	2	“00” Purchase “01” Pre-Authorization “02” Completion “03” Refund “04” Void Purchase “05” Void Refund “06” Void Completion “07” Force Post “08” Verify Account “50” Refund without card “51” Standalone Completion “52” Purchase with Token “53” Refund with Token “54” Pre-Authorization with Token “98” Recover “99” Cash

trxDate

This represents the date at the banking acquirer's. The value of this parameter may differ from the value in the Timestamp parameter.
Format: MMDDYYYY.

Format	Length	Possible Values
Numeric	8	“05132017”

trxMethod

The transaction method is the code that summarizes the transaction as a whole

Format	Length	Possible Values
Alphanumeric	3	“D@1” “T@1”

Description:
‘D@’ means the card was swiped in the terminal
‘T@’ means the card number was entered manually (credit card only)
‘1’ means the system authorized the transaction.
‘M’ means Manual
‘S’ means Swipe
‘D’ means Dipped
‘C’ means Chip
‘T’ means Tap (Contactless)

trxTime

This field represents the time at the banking acquirer's. The value of this parameter may differ from the value in the timestamp parameter.
Format: HHMMSS

Format	Length	Possible Values
Numeric	6	“010101”

trxType

The transaction type is directly related to the card used by the client to carry out the transaction.

Format	Length	Possible Values
Alphanumeric	1	“C” Credit card transaction “D” Debit card transaction “F” Fidelity card transaction (gift card)

id

Id associated with the function (customer, subscription, session)

Format	Length	Possible Values
Numeric	12	000001144391

accountNumber

Reference for the merchant

Format	Length	Possible Values
Alphanumeric	50	123456a789bc1012d

client

Subscriber number

Format	Length	Possible Values
Alphanumeric	8	123b56a8

currencyCode

Same as request parameter CurrencyCode

description

Reference for the merchant

Format	Length	Possible Values
Alphanumeric, Special characters	50	123456@789bc1012d

startDate

Same as request parameter StartDate

Format	Length	Possible Values
Alphanumeric	1	“C” Credit card transactions “D” Debit card transaction

endDate

End date in the format “YYYYMMDD” or 8 spaces

Format	Length	Possible Values
Numeric	8	20180430

frequency

Same as request parameter Frequency

lastInvoiceDate

Date of the last invoice. Format “YYYYMMDD”.

Format	Length	Possible Values
Numeric	8	20180430

name

Subscriber name.

Format	Length	Possible Values
Alphanumeric and spaces	50

nextInvoiceDate

Date of the next invoice. Format “YYYYMMDD”.

Format	Length	Possible Values
Numeric	8	20180430

numberOfPayments

Same as request parameter NumberOfPayments

recurReturnCode

Return code of the function.

Format	Length	Possible Values
Alphanumeric and spaces	4

status

Same as request parameter Status

subscriptionId

Subscription identifier number

Format	Length	Possible Values
Numeric	12

transactionReturnCode

Return code of the function.

Format	Length	Possible Values
Alphanumeric and spaces	4

recurReturnCode

Return code of the function.

Format	Length	Possible Values
Alphanumeric and spaces	4

DataCandy Fields

balanceAmount

The balance in dollars available on the card.

Format	Length	Possible Values
Numeric	12	000000001000 (for 10.00$)

startDate (DataCandy)

startDateDataCandy

The start date of the card, if later than the activation date. If this parameter is not returned, the card is active when activated.

Format	Length	Possible Values
Alphanumeric	10	2019-12-31

accountTypeNumber

The account type number.

Format	Length	Possible Values
Numeric	1	See DataCandy documentation

remainingAmount

The amount remaining on the transaction.

Format	Length	Possible Values
Numeric	12	000000001000 (for 10.00$)

totalBalanceAmount

The total balance on the card including all locked amounts.

Format	Length	Possible Values
Numeric	12	000000001000 (for 10.00$)

transactionConfirmationNumber

The transaction confirmation number. This number must be kept and saved for committing and possibly later cancelling the transaction. It is also used for unlocking the card once it has been locked.

Format	Length	Possible Values
Numeric	Any	Any

pic

Card’s profile complete or not.

Format	Length	Possible Values
Numeric	1	Either 1 (complete) or 0 (incomplete)

ctm

A multiple line consumer targeted message to be printed on the receipt. Each line is separated by a pipe “|” character.

Format	Length	Possible Values
String	155	Test123

Related Articles
Request Parameters
Parameter AccountNumber Amount BatchNumber CardHolderAddress CardHolderAVV CardHolderPostalCode CardNumber CardType CompanyNumber CurrencyCode CustomerNumber Cvv2Cvc2Number Description DisplayText Email EndDate ExpirationDate FailureUrl Frequency ID ...
Endpoint : Recurring - Get Response
Recurring - Get Response Upon a successful redirection to the merchant success or failure URL, you must used this transaction to get the result of the recurring web session. You must issue a RecurAck or RecurNACK to accept or refuse the token ...
Endpoint : Redirect - Get Response
Upon a successful redirection to the merchant success or failure URL, you must used this transaction to get the result of the payment transaction. You must issue a ACK or NACK to accept or refuse the transaction. Timing See the ACK transaction ...
API Specifications
Overview To communicate with the Payment API you should submit HTTP POST requests to the corresponding endpoints. There are differ endpoints for Test and Production. The API uses FORM parameters (key-value parameters passed in an HTTP POST URL) for ...
Credit and Debit on Semi-Integrated Terminals
Transaction Flow Semi-Integrated Process Flow Send basic transaction information from the Point of Sale (POS) workstation with a transactional application to the merchant environment (back office) server. The merchant must collect the essential data ...