MX Merchant Payment Gateway

This page details the inputs, secure inputs and outputs available for the MX Merchant Logic Item, how to complete each field, and an external link to the MX Merchant integration documentation.

PCI Pal must check any payment gateway integrations prior to going live. The documentation disclaimer (which applies throughout this guide) should be read before commencing any configuration of payment gateways.

Inputs

Input Fields	Required	Character Limits/ Required Input	Description
merchantId	Yes	Unique to the merchant (string)	Id of the merchant
amount	Yes	Must not be 0. (float)	The payment amount.
tenderType	Yes	Values: Card, Check, Cash, Multiple, Loyalty, ACH (string)	The type of tender used for the transaction
cardAccount['avsStreet']	Yes (if tenderType = Card)	(string)	Billing Street Address (required if Loss Prevention Setting is turned on)
cardAccount['avsZip']	Yes (if tenderType = Card)	(string)	Billing Postal Code (required if Loss Prevention Setting is turned on)
cardAccount['alias']	No	(string)	Client provided, easy to remember name for the card
entryClass	No	(string)	Gets or sets the ACH entry class Values: CCD, PPD, TEL, WEB
cardPresent	No	(boolean)	Is the credit card is present at the time of payment?
authOnly	No	(boolean)	Indicates that this payment should NOT be added to current batch. AuthOnly payment won't be settled.
isAuth	No	(boolean)	Should this card be authorized?
isSettledFunds	No	(boolean)	Should this transaction be settled?
customerName	No	256 Char (string)	Customer Name (Does NOT associate payment to customer)
customerCode	No	(string)	Client provided customer reference number (Associates with Customer Number). Cannot be combined with invoiceId and clientReference if B2B is on
meta	No	(string)	Memo field.
source	No	(string)	Values: API, QuickPay, Recurring, Link2Pay, Terminal
clientReference	No	17 char (string)	Client provided payment reference number; can be associated with multiple payments
invoice	No	16 char (string)	Client provided invoice number (Generated by server if not provided)
tax	No	(float)	Tax Amount (included in amount)
taxExempt	No	(boolean)	If true, tax amount must be 0
cardPresentType	No	(string)	Values: CardPresentKeyed, CardPresentSwiped, CardNotPresent
shipAmount	No	(float)	Gets/Sets the ship amount, used by level 3 data during settlement
shipToCountry	No	(string)	Gets/Sets the 3-digit alphanumeric ship-to country code, i.e. USA, used by level 3 data during settlement
shipToZip	No	(string)	Gets/Sets the ship-to zip code, used by level 3 data during settlement
vatAmount	No	(float)	Gets/Sets the vat amount, used by level 3 data during settlement
vatRate	No	(float)	Gets/Sets the VAT rate, used by level 3 data during settlement

Secure Inputs

Input Fields	Required	Character Limits/ Required Input	Description
cardAccount_number	Yes	19 chars	Secure input of the card number
cardAccount_expiry	Yes	4 chars	Secure input of the card expiry - in the format MMYY
cardAccount_cvv	Yes	3 or 4 chars	Secure input of the card CVV, either three or four digits long depending on the card

Outputs

Output Fields	Description
created	DateTime stamp when the transaction was created (string)
paymentToken	Payment token generated by Helcim (string)
id	Unique identifier of the transaction (int)
creatorName	Name of the application which created the transaction (string)
isDuplicate	Is the transaction a duplicate (boolean)
merchantId	Unique identifier of the merchant
batch	??????? (string)
batchId	Unique identifier of the batch (int)
tenderType	Tender used for the transaction (string)
currency	Currency used in transaction (string)
amount	Transaction total (string)
meta	Memo field (string)
cardAccount["cardType"]	Type of card (string)
cardAccount["entryMode"]	How the card detail was entered (string)
cardAccount["last4"]	Last four digits of the PAN (string)
cardAccount["cardId"]	Unique identifier of the card (string)
cardAccount["token"]	Tokenized PAN (string)
cardAccount["expiryMonth"]	Expiry month (MM) (string)
cardAccount["expiryYear"]	Expiry year (YY) (string)
cardAccount["hasContract"]	Does the card have a contract? (boolean)
cardAccount["cardPresent"]	Was the card present when taken? (boolean)
posData["panCaptureMethod"]	Method by which the PAN was cpatured.
risk["cvvResponseCode"]	CVV response code (whether there was a match) (string)
risk["cvvResponse"]	CVV response (whether there was a match) (string)
risk["cvvMatch"]	Did the CVV match? (boolean)
risk["avsResponse"]	Response from AVS (string)
risk["avsAddressMatch"]	Did the address match? (boolean)
risk["avsZipMatch"]	Did the postal code match? (boolean)
risk["emsResponseCode"]	EMS response code (string)
requireSignature	Is a signature required? (boolean)
settledAmount	Amount settled from the transaction (string)
settledCurrency	Currency type settled in the transaction (string)
cardPresent	Was the card present? (boolean)
authMessage	Authorization message (string)
availableAuthAmount	Available authorized amount (string)
reference	Transaction reference number (string)
tax	Taxable amount (string)
invoice	Invoice number (string)
customerCode	Customer's code (string)
customerName	Customer's name (string)
vatRate	VAT rate (string)
vatAmount	VAT amount (string)
shipAmount	Shipping amount (string)
shipToZip	Shipping postal code (string)
shipToCountry	Shipping country (string)
clientReference	Client reference number (string)
type	Type of transaction (string)
taxExempt	Is the transaction tax exempt? (boolean)
reviewIndicator	Indiciator for reviewing transaction (int)
source	Where the transaction originated (string)

MX Merchant Integration Documentation

MX Merchant Payment Gateway

Inputs

The help manual was created with Dr.Explain