PayFacto API v2.1.1 (Secure Payment) - Android - App-to-App - Additional Data

Complete reference for all extra parameters accepted by the PayFacto Secure Payment Android Intent. Each transaction type requires a specific subset — refer to the transaction type descriptions for the exact required and optional fields.

All parameters are passed using intent.putExtra("KEY", value) on an Android Intent. Use one intent line per parameter. Send the intent with startActivityForResult(intent, 0).

Contents

Transaction type to be processed.

Use an individual intent line for each separate transaction.

Usage Examples

• A sales transaction uses the intent.putExtra("TRANSACTION", "SALE"); line
• A refund transaction uses the intent.putExtra("TRANSACTION", "REFUND"); line
• A cash transaction uses the intent.putExtra("TRANSACTION", "CASH"); line

Possible Extra String Label Values

Amount of the transaction, expressed with a positive integer value without a decimal sign.

Usage Examples

• For a $0 transaction (when using the 001/verify credit account transaction type), use intent.putExtra("AMOUNT", "0");
• For a $10.00 transaction, use intent.putExtra("AMOUNT", "1000");

Possible Extra String Label Values

Tip amount added to a purchase/sale transaction, expressed with a positive integer value without a decimal sign.

A negative integer value will be considered as $0 for the tip amount.

If tip value is added on the request and the payment application tip feature is disabled, it will be automatically enabled.

Usage Examples

• For a $1.75 tip, use intent.putExtra("TIP", "175");
• For a $7.65 tip, use intent.putExtra("TIP", "765");
• For a $10.25 tip, use intent.putExtra("TIP", "1025");

Possible Extra String Label Values

Invoice number used for transaction processing.

When processing Completion and Void transactions, the invoice is used to recover the previous transaction to complete or void.

The maximum length for the invoice number is 6 alphanumeric characters.

If the invoice number value was previously used on an authorized transaction still in the open batch for the terminal, a response code of -4 will be returned.

Usage Examples

• If the invoice number is 123ABC, use intent.putExtra("INVOICE", "123ABC");
• If the invoice number is 123456, use intent.putExtra("INVOICE", "123456");
• If the invoice number is 1A2B, use intent.putExtra("INVOICE", "1A2B");

Possible Extra String Label Values

Operator identification (ID) used for the transaction.

• Maximum length is 15 numerical characters
• If the ID doesn't exist in payfacto it will be created

Usage Examples

• For an operator/clerk with the ID 1234, use intent.putExtra("CLERK", "1234");
• If the operator/clerk ID is 7, use intent.putExtra("CLERK", "7");

Possible Extra String Label Values

Mandatory information required for force post transactions, where the authorisation code obtained from a source other than the host server. The code provided must be entered on the terminal to ensure that the transactions on the terminal and host server match.

• Maximum length is 8 alphanumerical characters (letters and numbers)

Usage Examples

• If the offline authorization code is 12345678, use intent.putExtra("AUTHCODE", "12345678");
• If the offline authorization code is R2D2C3P0, use intent.putExtra("AUTHCODE", "R2D2C3P0");

Possible Extra String Label Values

Mandatory information with a unique value required to pass on each intent.

Usage Examples

• If the API value is 1A2B3C, use intent.putExtra("API", "1A2B3C");

Possible Extra String Label Values

Merchant language to use when displaying information on the terminal.

Currently, the PayFacto API only supports two languages: English and French.

Usage Examples

• To display terminal messages in English, use intent.putExtra("MERCHLANG", "E");
• To display terminal messages in French, use intent.putExtra("MERCHLANG", "F");

Possible Extra String Label Values

Mandatory original amount used on completion without preauthorization, expressed with a positive integer value without a decimal sign.

Usage Examples

• For an original $10.00 transaction amount, use intent.putExtra("ORIGINALAMOUNT", "1000");

Possible Extra String Label Values

Usage is intent.putExtra("TRANSACTION", "Possible Values"); with an intent line for each value you want to use.

Possible Extra String Label Values

Determines if the automatic settlement process prints the detailed report, expressed using a Boolean value.

Usage Examples

• To print the detailed report after the automatic settlement, use intent.putExtra("PRINTDETAIL", "true");
• To not print the detailed report after the automatic settlement, use intent.putExtra("PRINTDETAIL", "false");

Possible Extra String Label Values

Determines if the automatic settlement process prints the summary report, expressed using a Boolean value.

Usage Examples

• To print the summary report after the automatic settlement, use intent.putExtra("PRINTSUMMARY", "true");
• To not print the summary report after the automatic settlement, use intent.putExtra("PRINTSUMMARY", "false");

Possible Extra String Label Values

Transaction number (as a UUID representing a string, not an invoice number) representing a previous transaction to be voided provided by the host server.

Only used on void / completion / reprint / TRXDATA transactions.

Usage Examples

• The transaction number is UUID as a string, use intent.putExtra("SEQ", "150e8430-e29b-41f4-a716-446655440010");

Possible Extra String Label Values

Indicates if the tip option will be activated. Possible values are:

• 1: activates the tip option
• 0: deactivates the tip option

Any other value than 0 or 1 results in no change to the current tip settings

Usage Examples

• To activate the tip, use intent.putExtra("SETTINGTIP", "1");
• To deactivate the tip, use intent.putExtra("SETTINGTIP", "0");

Possible Extra String Label Values

Indicates if the cashback option will be activated on a debit sale transaction. Possible values are:

• 1: activates the cashback option
• 0: deactivates the cashback option

Any other value than 0 or 1 results in no change to the current cashback settings

Usage Examples

• To activate cashback, use intent.putExtra("SETTINGCASHBACK", "1");
• To deactivate cashback, use intent.putExtra("SETTINGCASHBACK", "0");

Possible Extra String Label Values

Indicates if printing of the transaction receipt will be activated in an ECR (semi-integrated) environment. Possible values are:

• 1: activates the ECR printing option
• 0: deactivates the ECR printing option

Any other value than 0 or 1 results in no change to the current ECR printing settings

Usage Examples

• To activate ECR printing, use intent.putExtra("SETTINGPRINTECR", "1");
• To deactivate ECR printing, use intent.putExtra("SETTINGPRINTECR", "0");

Possible Extra String Label Values

Indicates if "cash or card" question appears on the terminal for a sale transaction. Possible values are:

• 1: enables the "cash or card" question
• 0: disables the "cash or card" question

Any other value than 0 or 1 results in no change to the current enables the "cash or card" question settings

Usage Examples

• To activate the "cash or card" question, use intent.putExtra("SETTINGCASHORCARD", "1");
• To deactivate the "cash or card" question, use intent.putExtra("SETTINGCASHORCARD", "0");

Possible Extra String Label Values

Indicates the type of report to print when the transaction type is report (intent.putExtra("TRANSACTION", "REPORT");). Possible values are:

• 1: prints the summary report
• 2: prints the detail report
• 3: prints both reports

Usage Examples

• To print the summary report, use intent.putExtra("REPORTYPE", "1");
• To print the detail report, use intent.putExtra("REPORTYPE", "2");
• To print both reports (summary and detail), use intent.putExtra("REPORTYPE", "3");

Possible Extra String Label Values

The calculated tax amount (for all applicable jurisdictions), included in the AMOUNT field. The development partner's application calculates the total tax amount and passes that amount as the TAXAMOUNT value.

Must be:

• Less than the AMOUNT field
• A positive integer for a tax calculation or 0 for a non-taxable amount

Usage Examples

• For a taxable total sale of $11.50 where there is $1.50 in tax ($10 pre-tax amount), use intent.putExtra("TAXAMOUNT", "150");
• For a tax-exempt total sale of $7.65, use intent.putExtra("TAXAMOUNT", "0");

Possible Extra String Label Values

Setting to disable transaction to be paid via gift card. Default value is false.

Usage Examples

• For a transaction, useintent.putExtra("DISABLEGIFT", true);to disable the "Gift card" payment method;

Possible Extra String Label Values