Helcim Logo Support & Tutorials

© Copyright 2006-2018 Helcim Inc.

All Rights Reserved.

Helcim Commerce API » Processing Payments » Card Payments »

Batch Settlement

This API call let's you settle a batch. The response is an XML of the settled batch

Request Fields

Field Name Type Required Description
transactionType String Yes settle
accountId Integer Yes The Helcim Commerce account ID.
apiToken String Yes API token used for authentication and access control. 

Response Fields (XML)

Field Name Type Description
message - XML structure
response Integer 1 or 0. Whether the transaction was approved or declined.
responseMessage String Result of transaction (Approved/Denied).
notice String Error/warning message from Helcim. 
transaction - XML structure
transactionId Integer The transaction ID.
type String The transaction type (purchase, refund, pre-auth, capture).
date String The date of the transactions
time String The time of the transaction.
cardHolderName String The card holder's name.
amount Decimal The amount of the transactions.
currency String The currency of the transaction.
cardnumber String The credit card number (first 4 and last 4 digits only).
cardToken String The credit card token.
expiryDate Integer The credit card expiry date.
cardType String The credit card type (Visa, Mastercard, Amex, Discovery).
avsResponse String The address verification response.
cvvResponse String The CVV verification response.
approvalCode String The approval code.
orderNumber String The order number.
customerCode String The customer code.

Errors

For all API requests, there are also generic API authentication and user access restriction errors.
Response Code Error Code Message Description

Code Samples

Sample Transaction Type Batch Settle Response XML

<?xml version="1.0"?>
<message>
    <response>1</response>
    <responseMessage>SETTLED - OK</responseMessage>
    <notice></notice>
    <transaction>
        <transactionId>123092</transactionId>
        <type>settle</type>
        <date>2017-07-07</date>
        <time>11:33:28</time>
        <cardHolderName></cardHolderName>
        <amount></amount>
        <currency>CAD</currency>
        <cardNumber></cardNumber>
        <cardToken></cardToken>
        <expiryDate></expiryDate>
        <cardType></cardType>
        <avsResponse></avsResponse>
        <cvvResponse></cvvResponse>
        <approvalCode></approvalCode>
        <orderNumber></orderNumber>
        <customerCode></customerCode>
    </transaction>
</message>

HTML Form Sample HTML

<input type="hidden" name="accountId" value="YOUR-ACCOUNT-ID">
<input type="hidden" name="apiToken" value="YOUR-API-TOKEN">
<input type="hidden" name="transactionType" value="settle">