Helcim Card Transaction & Batch API

Read access to processed card transactions and card batches, including listing and retrieving transactions and batches and settling a card batch, under the Helcim API v2.

Documentation Provider Profile APIs.io OpenAPI GitHub

Helcim Card Transaction & Batch API is one of 6 APIs that Helcim publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Card Transaction, Card Batch, and Settlement. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 48 operations across 40 paths, organized into 9 resource areas, and defines 53 schemas. It is described by OpenAPI 3.0.0, at version 2.2.0.

Requests are made against 2 base URLs: https://api.helcim.com/v2, https://api.helcim.test/v2.

48 operations 40 paths 53 schemas 2 DELETE23 GET3 PATCH13 POST7 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.0.0

API Version

2.2.0

Base URL

https://api.helcim.com/v2

Authentication

API Key

Resource Areas

Authentication & Security 1

Helcim Card Transaction & Batch API declares 1 security scheme for authenticating requests. An API key is passed in the header as api-token (ApiAccessAuth).

ApiAccessAuth — API Token with required permissions

Paths & Operations 48

Across 40 paths, the API surfaces 48 operations — 2 DELETE, 23 GET, 3 PATCH, 13 POST, 7 PUT. They span 9 resource areas: General, Payment, Card Batch, Card Transaction, Customer, Invoice, ACH Payment, Card Terminal, Device. Each is listed below with its method, path, parameters, and response codes.

General 1

GET

/connection-test

Tests connectivity to the Helcim API

connectionTest → 200400401403

Payment 7

POST

/payment/purchase

Process a Purchase Transaction

purchase 1 param body → 200default

POST

/payment/preauth

Process a Preauth Transaction

preauth 1 param body → 200default

POST

/payment/capture

Process a Capture Transaction

capture 1 param body → 200default

POST

/payment/verify

Process a Verify Transaction

verify 1 param body → 200default

POST

/payment/refund

Process a Refund Transaction

refund 1 param body → 200default

POST

/payment/reverse

Process a Reverse Transaction

reverse 1 param body → 200default

POST

/payment/withdrawdeprecated

Process a Withdraw Transaction

withdraw 1 param body → 200default

Card Batch 3

GET

/card-batches

Get Card Batches

get-card-batches 3 params → 200default

GET

/card-batches/{cardBatchId}

Get Card Batch

get-card-batch 2 params → 200default

POST

/card-batches/{cardBatchId}/settle

Settles an Open Card Batch

settle-card-batch 1 param → 200default

Card Transaction 2

GET

/card-transactions

Collects up to 1000 Card Transactions

get-card-transactions 9 params → 200default

GET

/card-transactions/{cardTransactionId}

Get Card Transaction by id

get-card-transaction 1 param → 200default

Customer 17

GET

/customers

Get customers

get-customers 5 params → 200default

POST

/customers

Create customer

create-customer body → 200default

GET

/customers/{customerId}

Get customer

get-customer 1 param → 200default

PUT

/customers/{customerId}

Update customer

update-customer 1 param body → 200default

GET

/customers/{customerId}/cards

Get customer cards

get-customer-cards 2 params → 200default

GET

/customers/{customerId}/cards/{cardId}

Get customer card

get-customer-card 2 params → 200default

DELETE

/customers/{customerId}/cards/{cardId}

Delete customer card

delete-customer-card 2 params → 204404default

PATCH

/customers/{customerId}/cards/{cardId}/default

Set customer card as default

set-customer-card-default 2 params → 200default

GET

/customers/{customerId}/pads

Get all PADS for a customer.

get-pads 1 param → 200204400403500

GET

/customers/{customerId}/bank-accounts

Get customer bank accounts.

get-customer-bank-accounts 4 params → 200default

POST

/customers/{customerId}/bank-accounts

Create a bank account.

create-bank-account 1 param body → 201400403500

GET

/customers/{customerId}/bank-accounts/request-new

Request bank account information from a customer.

request-new-bank-account 1 param → 200400403500

GET

/customers/{customerId}/bank-accounts/{bankAccountId}

Get customer bank account

get-customer-bank-account 2 params → 200default

DELETE

/customers/{customerId}/bank-accounts/{bankAccountId}

Delete customer bank account.

delete-customer-bank-account 2 params → 204400403404500

PATCH

/customers/{customerId}/bank-accounts/{bankAccountId}/default

Set customer bank account as default

set-customer-bank-account-default 2 params → 200default

GET

/customers/{customerId}/bank-accounts/{bankAccountId}/pads/{padId}

Get a PAD by its ID.

get-pad 3 params → 200400403500

PUT

/customers/{customerId}/bank-accounts/{bankAccountId}/pads/{padId}

Update a PAD by its ID.

update-pad 3 params body → 200400403500

Invoice 4

POST

/invoices

Create invoice

create-invoice body → 200default

GET

/invoices

Get invoices

get-invoices 11 params → 200default

GET

/invoices/{invoiceId}

Get invoice

get-invoice 1 param → 200default

PUT

/invoices/{invoiceId}

Update invoice

update-invoice 1 param body → 200default

ACH Payment 8

PUT

/ach/withdraw

Process an ACH withdraw.

ach-withdraw 1 param body → 200400403500

GET

/ach/transactions

Collects all ACH transactions.

get-many-ach-transactions 10 params → 200400403500

GET

/ach/transactions/{transactionId}

Retrieves a single ACH transaction.

get-ach-transaction-by-id 1 param → 200400403500

PUT

/ach/transactions/{transactionId}/refund

Refund an ACH transaction.

ach-refund 2 params body → 200400403500

PUT

/ach/transactions/{transactionId}/void

Void an ACH transaction.

ach-void 2 params → 200400403500

PATCH

/ach/transactions/{transactionId}/cancel

Cancel a pending ACH transaction.

ach-cancel 2 params → 200400403500

GET

/ach/batches

Collects all ACH batches.

get-many-ach-batches → 200400403500

PUT

/ach/batches/{batchId}/settle

Settle an ACH batch.

ach-batch-settle 2 params → 200400403500

Card Terminal 1

GET

/card-terminals

Get card terminals

card-terminals 2 params → 200default

Device 5

GET

/devices

Get Devices

get-devices 4 params → 200403404500

GET

/devices/{code}

Get Device Information

get-device 1 param → 200403404500

POST

/devices/{code}/payment/purchase

Start A Purchase

start-purchase 1 param body → 202403404409500

POST

/devices/{code}/payment/refund

Start A Refund

start-refund 1 param body → 202403404409500

GET

/devices/{code}/ping

Send a Ping Event to a Device

ping-device 1 param → 202403404409500

Schemas 53

The contract defines 53 schemas that model the data the API accepts and returns. The most detailed are InvoiceResponse (27 properties), TransactionEft (20 properties), SuccessfulPaymentResponse (18 properties), BankAccountResponse (16 properties). Each schema is shown below with its type and property counts.

Card

object

4 properties 4 required

Address

object

9 properties 3 required

PaymentRequestBase

object

9 properties 4 required

InvoiceBase

object

2 properties

InvoiceWithTip

Shipping

object

3 properties 3 required

Pickup

object

2 properties 1 required

Tax

object

2 properties 2 required

Discount

object

2 properties 2 required

LineItem

object

6 properties 3 required

InvoiceCreateAfterProcessing

object

5 properties

PaymentRequest

CardToken

object

1 property 1 required

CardData

object

1 property 1 required

FailedPaymentResponse

object

1 property

SuccessfulPaymentResponse

object

18 properties

PreauthRequest

CaptureRequest

object

4 properties 3 required

VerifyRequest

object

9 properties 5 required

BankAccount

object

15 properties 11 required

BankToken

object

1 property 1 required

BankData

object

1 property 1 required

SuccessfulAchTransactionResponse

object

12 properties

CardBatch

object

15 properties

Customer

object

8 properties

CustomerRequest

object

6 properties

CustomerUpdateRequest

object

6 properties

CardResponse

object

8 properties

Pad

object

13 properties

Res

object

1 property

Message

object

1 property

BankAccountResponse

object

16 properties

Req

object

14 properties 8 required

Res-2

object

2 properties

Res-3

object

1 property

Req-2

object

4 properties

OrderField

object

2 properties

InvoiceResponse

object

27 properties

InvoiceUpsertRequest

object

14 properties 2 required

Req-3

object

5 properties 4 required

TransactionEft

object

20 properties

Res-4

object

1 property

Req-4

object

1 property 1 required

Res-5

object

1 property

Res-6

object

1 property

Res-7

object

1 property

AchBatch

object

14 properties

Res-8

object

1 property

CardTerminal

object

5 properties

Device

object

2 properties

FailedResponse

object

1 property

PaymentRequest-2

object

4 properties 2 required

RefundRequest

object

2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs Helcim publishes across the network.

Helcim Payment API

AE Profile APIs.io

Helcim ACH Payment API

AE Profile APIs.io

Helcim Customer API

AE Profile APIs.io

Helcim Invoice API

AE Profile APIs.io

Helcim Card Terminal & Device API

AE Profile APIs.io

#Card Transaction#Card Batch#Settlement

← Back to H APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Helcim Card Transaction & Batch API

Metadata

Authentication & Security 1

Paths & Operations 48

Schemas 53

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Helcim Card Transaction & Batch API

Metadata

Authentication & Security 1

Paths & Operations 48

Schemas 53

Specification

Source

More from Helcim 5

API Details

Provider

Explore more