IPC Integration Attributes

Input Request Attributes

The IPC transaction request is a Name Value pair format. There is a name (number) associated with all the attributes of the transaction. The EPOS application needs to send a list of attributes and their values in the request. Each attribute Name Value pair is separated by a Line Feed.

This is the list of input attributes for a transaction:



Description

Attribute Name

Data Type

Length

Mandatory/Conditional/Optional

Transaction reference, which uniquely identifies the transaction with a user defined tag.

We recommend that the Transaction Reference field contains only characters defined in ‘Data Type’ however if Transaction Reference contains special characters then IPC will sanitize the Transaction Reference Filed, excluding ‘Data Type’ characters. IPC will use the sanitized Transaction Reference to process the transaction. IPC will send the original Transaction Reference in output response.

For cancel, use the transaction reference of original transaction to be cancelled.

Note: For hVantiv Acquirer, the maximum length of MTR should be 11.

Note: For every Alipay Transactions, the Merchant Transaction Reference field should be unique, else the Transaction will be declined by Emboss.

Note: For Alipay Sale Transactions, the Merchant Transaction Reference field (#1) should NOT contain any special characters, only alpha-numeric characters are supported in it.

1

Alpha Numeric, Hyphen(-), Underscore(_)

0-30

M

Transaction Type, Transaction Type indicates the type of financial transaction

Transaction Type

Description

0

Sale (Goods and Services)

1

Pre-authorisation

2

Pre Sales Completion

3

Cancel Transaction

Alipay Cancel Transaction using BarCode.

8

TaxFree Voucher (VAT Refund Voucher) for Cash Transaction ##

12

Sale with Token

13

Refund with Token

15

Get Territory

18

Newday Card Account Payment

20

Returns

22

Printing Duplicate Merchant Receipt (Valid for Retail Mode)

23

Printing Duplicate Customer Receipt

24

Check Pinpad connection

25

Get total number of offline stored transactions

26

Get Serial number of connected Pinpad

30

CheckCard

34

CheckStatus

35

Last transaction result

36

X Report

37

Z Report

51

Gift Card Redemption

Alipay Sale Transaction using BarCode.

52

Gift Card / Alipay refunds using barcode

Note : IPC-231 supports both full and multiple partial refund attempts against an Alipay sale transaction.

53

Gift Card Top Up

55

Gift Card Check Balance

58

Account verification request

90

Hide IPC Window

91

Show IPC Window

99

Close IPC application

2

Integer

N/A

M

Transaction Amount

Transaction amount is in major currency units e.g. 3=10.23

Amount must be non-zero, non negative and less than 9999999.99.

Note: Transactions above the terminal’s ceiling limit will be cancelled even if they are less than 9999999.99. The Ceiling limit is defined by acquirer and varies by acquirer.

Only 2 digits are allowed after the decimal point

3

Decimal

NA

M

Masked PAN, present in case of pre sales completion and cancel transaction. Required for cancel transaction unless a check card is cancelled. Required for E-giftcard transactions also.

For Alipay Transactions using BarCode this field will be required and will contain the BarCode value displayed on the Consumer’s Alipay app.


Alipay Notes:

1.For Alipay BarCode transactions, the starting value for the BarCodes will range from 25 to 30.

2. For Alipay BarCode transactions, the BarCode Value for Sale, Refund and Cancel transactions will be provided in plain text with NO masked digits.

5

Alpha Numeric


13-19

Alipay – 16 to 24

C1

Card Expiry Date, present in case of pre sales completion and cancel transaction in MMYY format. Required for cancel transaction unless a check card is cancelled.

Note:

The expiry date parameter in pre sales completion and Cancel transactions has been retained for backwards compatibility, however any expiry date corresponding to MMYY format is accepted. Optional for E-giftcard transactions.

For Alipay Transactions, Card Expiry Date is “OPTIONAL”. But if the Expiry Date is provided during an Alipay Sale Transaction by the Merchant, then same should be provided while requesting a Refund for that transaction, else the Refund will be declined by Emboss

6

Integer

4

C1

Optional for Alipay Transaction

CNP indicator specifies if the transaction is cardholder not present. Value is 1 if CNP transaction otherwise 0.

12

Integer

1

C2

Transaction reference. For Pre Sales, specifies the reference of the pre sales transaction to be completed. For Cancel, specifies the reference of the transaction to be Voided. (Returned in field 28 of IPC response message. Refer response message details).

Note – For Alipay Refund and Cancel transactions the PGTR field is required.

13

Alpha Numeric

12-14

C3

Keyed transaction indicator, specifies if the transaction is keyed transaction. Value is 1, if Keyed transaction otherwise 0. Keyed is allowed only for Sale and Refund transaction.

Value is 2, if forced Keyed referral transaction.

18

Integer

1

O

Token Reference

19

Alpha Numeric

20

C4

Cash Tender amount

Cash Tender amount is in major currency units e.g. 20=10.23

20

Decimal

NA

C5

Remove Card flag. This is Boolean field and mandatory in the request of Check Card functionality. If this field is True then IPC will ask for remove card after returning card details. If this field is False then IPC will wait for a while for transaction request.

25

Boolean

NA

M

Go online flag. This is a Boolean field and optional in the Check Card request. It indicates that IPC needs to go online to check whether card is Credit or Debit. If this flag is not provided in the input request then IPC will check online or offline according to configuration of the Online Credit/debit option in IPC Configuration General Tab.

26

Boolean

NA

O

Cash transaction indicator, specifies if the transaction is cash transaction. Value must be 1.

28

Integer

1

C5

Authorisation Code: This field is optional for transaction Terminal Key Recovery by Merchant keyed referral transaction.

30

Alpha Numeric

2-6

O

Newday Discount code/amount: This field is optional in Sale and Refund request. The code and amount values are to be provided concatenated into an alpha numeric string separated by operators “,” and “|”. This field has no effect if the tendered card is not a Newday card.

72

Alpha Numeric

NA

O

Transaction Purpose : This field is mandatory field in Account Verification Request & optional for Sale with Token transaction, Value for this field is single character and currently allowed character is only N (Ad-hoc or pay as a you go).

103

Alphabet

1

AVR-M

Sale with Token-O

Send Attempt: This field is only meant for Alipay Transactions and optional for Merchants. If provided it should be incremented in line with the transaction retries performed. Allowed values are 1 to 9 only. If not provided a default value (1) will be sent to Alipay.

108

Numeric

1 to 9

Alipay Sale-O

Alipay Refund-O

Alipay Cancel-O

Quantity: This field is only meant for Alipay Transactions and optional for Merchants. If not provided a default value (1) will be sent to Alipay.

109

Numeric

1 to 32,7679

Alipay Sale-O

Alipay Refund-NA

Alipay Cancel-NA

Transaction name: This field is only meant for Alipay Transactions and optional for Merchants. If not provided an empty string will be sent to Alipay.

110

Alpha Numeric

256 Character without Special Symbol

Alipay Sale-O

Alipay Refund-NA

Alipay Cancel-O


Payment Instrument Identifier: This field is only meant for Alipay Transactions and required for Merchants. The value for Alipay BarCode Transaction will be 029.

111

Integer

029 for Alipay Barcode Trasnaction

M


Boots Card Indicator. This is Boolean field and mandatory in the request of Check Card functionality to check the Boots card. If this field is True then IPC will ask for Insert Boots Card on pinpad

112

Boolean

NA

M


End of message indicator, values always 0.

99

Integer

1

M

  • C1 – Required for E-giftcard, pre sales completion and cancel transaction but expiry date is optional for E-giftcard transaction

  • C2 – Card not present transaction

  • C3 – Transaction Type Sale Completion (2=2)

  • C4 – Mandatory for Transaction Type 12 (Sale with token) & 13 (Refund with token)

  • C5 – Mandatory for Cash Transaction

  • Only Alphanumeric or numbers are allowed in all the input attribute fields, except in the case of Transaction reference

  • TaxFree Voucher (VAT Refund ) for Cash Transaction is valid only if Merchant is enabled for TaxFree