Jump to Content
Guides
API Reference
Changelog
v1.0
v2.1
v2.2
helcim.com
API Reference
helcim.com
v2.2
Guides
API Reference
Changelog
Tests connectivity to the Helcim API
Search
All
Pages
Start typing to search…
JUMP TO
The Helcim API
General
Tests connectivity to the Helcim API
get
Payment
Process Purchase Transaction
post
Process Preauth Transaction
post
Process Capture Transaction
post
Process Verify Transaction
post
Process Refund Transaction
post
Process Reverse Transaction
post
Process Withdraw Transaction
post
Card Batch
Get Card Batches
get
Get Card Batch
get
Settles an Open Card Batch
post
Card Transaction
Collects up to 1000 Card Transactions
get
Get Card Transaction by id
get
Customer
Get customers
get
Create customer
post
Get customer
get
Update customer
put
Get customer cards
get
Delete customer card
delete
Get customer card
get
Set customer card as default
patch
Get all PADS for a customer.
get
Get customer bank accounts.
get
Create a bank account.
post
Request bank account information from a customer.
get
Get customer bank account
get
Set customer bank account as default
patch
Get a PAD by its ID.
get
Update a PAD by its ID.
put
Invoice
Get invoices
get
Create invoice
post
Get invoice
get
Update invoice
put
ACH Payment
Process an ACH withdraw.
put
Collects all ACH transactions.
get
Retrieves a single ACH transaction.
get
Refund an ACH transaction.
put
Void an ACH transaction.
put
Cancel a pending ACH transaction.
patch
Collects all ACH batches.
get
Settle an ACH batch.
put
Card Terminal
Get card terminals
get
Device
Get Devices
get
Get Device Information
get
Start A Purchase
post
Start A Refund
post
Send a Ping Event to a Device
get
Recurring API
Payment Plans
Get payment plan collection
get
Patch payment plans
patch
Create payment plans
post
Delete payment plan
delete
Get payment plan
get
Subscriptions
Get subscription collection
get
Patch subscriptions
patch
Create subscriptions
post
Delete subscription
delete
Get subscription
get
Delete linked subscription add-ons
delete
Patch subscription add-ons
patch
Link add-ons to a subscription
post
Delete a linked subscription add-on
delete
Mark payment paid
patch
Add-Ons
Get add-on collection
get
Patch add-ons
patch
Create add-ons
post
Delete add-on
delete
Get add-on
get
Procedures
Process a subscription payment
post
HelcimPay.js
Helcim Pay
Creates a HelcimPay.js Checkout Session
post
Uploads the logo to be displayed on the HelcimPay.js modal
post
Tests connectivity to the Helcim API
get
https://api.helcim.com/v2/connection-test
Language
Shell
Node
Ruby
PHP
Python
Credentials
Header
Header
URL
Base URL
https://api.helcim.com/v2
/connection-test
RESPONSE
Click
Try It!
to start a request and see the response here!