Helcim Logo Support & Tutorials

© Copyright 2006-2018 Helcim Inc.

All Rights Reserved.

Helcim Commerce API » Processing Payments » Card Payments »

Response Fields

IMPORTANT: Response Fields for the credit card payments API's.

Field Name Type Description
message - XML structure
response Integer 1 = Success, 0 = Failure
responseMessage String The transaction response message.
notice Integer The transaction notice, such as "Order Updated".
transaction - XML structure
transactionId Integer The transaction ID.
type String  The transaction type (purchase, refund, pre-auth, capture, verify).
date String The transaction date, format: YYYY-MM-DD
time String The transaction time, format: HH:MM:SS
cardHolderName String The cardholder's name.
amount Decimal The transaction amount.
currency String The transaction currency.
cardNumber String The credit card number (masked).
cardToken String The credit card token.
expiryDate String The credit card expiry date.
cardType String The credit card type.
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.
xml String The XML response (XML document format).

Code Samples

Sample Response Fields Response XML

<?xml version="1.0"?>
<message>
    <response>1</response>
    <responseMessage>APPROVED</responseMessage>
    <notice></notice>
    <transaction>
        <transactionId>122929</transactionId>
        <type>preauth</type>
        <date>2017-07-07</date>
        <time>10:23:20</time>
        <cardHolderName>John Smith</cardHolderName>
        <amount>45.00</amount>
        <currency>CAD</currency>
        <cardNumber>5454********5454</cardNumber>
        <cardToken>4f3a1feab9468e7774af54</cardToken>
        <expiryDate>1019</expiryDate>
        <cardType>MasterCard</cardType>
        <avsResponse>X</avsResponse>
        <cvvResponse>M</cvvResponse>
        <approvalCode>T2E4ST</approvalCode>
        <orderNumber>Test11</orderNumber>
        <customerCode>12A1187</customerCode>
    </transaction>
</message>