Helcim Logo Support & Tutorials

© Copyright 2006-2018 Helcim Inc.

All Rights Reserved.

Helcim Commerce API » Processing Payments » Misc Payments »

Cash Transaction

This API call let's you process a cash transaction. The response is an XML of the cash transaction.

Request Fields

Field Name Type Required Description
transactionOtherType String Yes cash
accountId Integer Yes The Helcim Commerce account ID.
apiToken String Yes API token used for authentication and access control. 
orderNumber Integer Yes The order number.
amount Decimal No The transaction amount.
currency String Yes  The transaction currency.

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 cash transaction.
transactionOther - XML structure
id String The transaction ID
ternderType String The tender type used (cash, check, bank transfer, cash on delivery, credit card (external) transaction, debit card (external) transaction, misc).
date String The date of the transactions
time String The time of the transaction.
amount Decimal The amount of the transactions.
currency String The transaction currency.

Errors

For all API requests, there are also generic API authentication and user access restriction errors.
Response Code Error Code Message Description
0 - Missing Fields - Currency The currency field was not entered.
0 - Missing Order Number The order number is missing.

Code Samples

Sample TransactionOtherType Cash Response XML

<?xml version="1.0"?>
<message>
    <response>1</response>
    <responseMessage>New Transaction Created - Order Status: Paid</responseMessage>
    <transactionOther>
        <id>54488</id>
        <tenderType>Cash</tenderType>
        <date>2017-07-07</date>
        <time>13:32:52</time>
        <amount>12.99</amount>
        <currency>CAD</currency>
    </transactionOther>
</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="transactionOtherType" value="cash">
<input type="hidden" name="amount" value="12.99">
<input type="hidden" name="currency" value="CAD">