Helcim.js »

Response Fields

Once the transaction is completed and the form is submitted, POST data will be sent back to the merchant's server (webpage). The POST data will include the fields listed below. The POST field [xml] will also contain an XML structure of the response.

Field Name	Type	Description
response	Integer	1 = Success, 0 = Failure
responseMessage	String	The transaction response message.
noticeMessage	Integer	The transaction notice, such as "Order Updated".
date	String	The transaction date, format: YYYY-MM-DD
time	String	The transaction time, format: HH:MM:SS
type	String	The transaction type, such as "Purchase" or "Verify".
amount	Decimal	The amount processed.
cardHolderName	String	The cardholder's name.
cardNumber	String	The credit card number (masked).
cardExpiry	String	The credit card expiry date.
cardToken	String	The credit card token.
cardType	String	The credit card type.
transactionId	String	The transaction ID.
avsResponse	String	The address verify (AVS) response.
cvvResponse	String	The CVV response.
approvalCode	String	The transaction approval code.
orderNumber	String	The order number.
customerCode	String	The customer code.
currency	String	The transaction currency.
bankAccountType	String	The bank account type, either "CHK" or "SAV".
bankAccountCorporate	String	"C" for corporate, "P" for personal.
bankAccountToken	String	The bank account token.
bankFinancialNumber	String	The bank financial ID (Canada-only).
bankTransitNumber	String	The bank account transit number (masked).
bankAccountNumber	String	The bank account number (masked).
xml	String	The XML response (XML document format).

Code Samples

PHP POST Array Response Sample

XML Credit Card Response Sample

XML Bank Account (EFT/ACH) Response Sample

POST Array Response Sample PHP

[response] => 1
[responseMessage] => APPROVED
[noticeMessage] => Order Created - Customer Created
[date] => 2017-06-21
[time] => 12:23:31
[type] => purchase
[amount] => 100.00
[cardHolderName] => John Smith
[cardNumber] => 5454****5454
[cardExpiry] => 1025
[cardToken] => 5440c5e27f287875889421
[cardType] => MasterCard
[transactionId] => 112415310
[avsResponse] => X
[cvvResponse] => M
[approvalCode] => 102542
[orderNumber] => INV10010
[customerCode] => CST2000
[currency] => CAD
[bankAccountType] => CHK
[bankAccountCorporate] => P
[bankAccountToken] => 6dc57d55b60fce3f9c6a5d
[bankFinancialNumber] => 001
[bankTransitNumber] => *******0300
[bankAccountNumber] => **********56666
[xml] => XML-DOCUMENT-SEE-BELOW

Credit Card Response Sample XML

<?xml version=\"1.0\"?>
<message>
	<response>1</response>
	<responseMessage>APPROVED</responseMessage>
	<noticeMessage>Order Created - Customer Created</noticeMessage>
	<date>2017-06-21</date>
	<time>12:23:31</time>
	<type>purchase</type>
	<amount>100.00</amount>
	<cardHolderName>John Smith</cardHolderName>
	<cardNumber>5454****5454</cardNumber>
	<cardExpiry>1025</cardExpiry>
	<cardToken>5440c5e27f287875889421</cardToken>
	<cardType>MasterCard</cardType>
	<transactionId>112415310</transactionId>
	<avsResponse>X</avsResponse>
	<cvvResponse>M</cvvResponse>
	<approvalCode>102542</approvalCode>
	<orderNumber>INV10010</orderNumber>
	<customerCode>CST2000</customerCode>
</message>

Bank Account (EFT/ACH) Response Sample XML

<?xml version=\"1.0\"?>
<message>
	<response>1</response>
	<responseMessage>APPROVED</responseMessage>
	<noticeMessage>Bank Account Created - Customer Created</noticeMessage>
	<date>2017-06-21</date>
	<time>12:23:31</time>
	<transactionType>EFT/ACH Verify</transactionType>
	<amount>200.00</amount>
	<currency>USD</currency>
	<approvalCode>101292</approvalCode>
	<bankAccountType>CHK</bankAccountType>
	<bankAccountCorporate>P</bankAccountCorporate>
	<bankAccountToken>5440c5e27f287875889421</bankAccountToken>
	<bankFinancialNumber>001</bankFinancialNumber>
	<bankTransitNumber>******200</bankTransitNumber>
	<bankAccountNumber>********109291</bankAccountNumber>
	<customerCode>CST2000</customerCode>
</message>