Skip to main content (Press Enter)
Helcim Logo
Click here if you return to contents

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
0 - Invalid API Token1 The API Token is invalid, or not entered.
0 - Missing or Invalid Fields - Account ID The Account ID is invalid, or not entered.

Related Articles

Refund (Return)
Capture (Force)
Response Fields
Void
Pre-Authorization (Preauth) with Customer Code
Preauthorization (Preauth) with Card Token
Refund (Return) with Card Token
Purchase (Sale)
Purchase Using a Card Token
Purchase Using Mag-Data
Purchase Using a Customer Code
Request Fields
Pre-Authorization (Preauth)
Verification - Only

Was this article helpful?

Feedback submitted - Thank you!
Click here if you return to the content