How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Helcim Customer API

The Customer API from Helcim — 11 operation(s) for customer.

Helcim Customer API is one of 9 APIs that Helcim publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 17 operations across 11 paths, and defines 14 schemas. It is described by OpenAPI 3.2.0, at version 2.2.0.

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

17 operations 11 paths 14 schemas 2 DELETE9 GET2 PATCH2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.2.0
Base URL
https://api.helcim.com/v2
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Helcim Customer 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 17

Across 11 paths, the API surfaces 17 operations — 2 DELETE, 9 GET, 2 PATCH, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

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

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are BankAccountResponse (16 properties), Req (14 properties), Pad (13 properties), Address (9 properties). Each schema is shown below with its type and property counts.

CustomerRequest
object
6 properties
Message
object
1 property
Req-2
object
4 properties
Req
object
14 properties 8 required
BankAccountResponse
object
16 properties
CustomerUpdateRequest
object
6 properties
Pad
object
13 properties
Res-3
object
1 property
FailedPaymentResponse
object
1 property
Res-2
object
2 properties
CardResponse
object
8 properties
Address
object
9 properties 3 required
Customer
object
8 properties
Res
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

helcim-customer-api-openapi.yml Raw ↑

Other APIs Helcim publishes across the network.

Helcim ACH Payment API
Helcim Card Batch API
Helcim Card Terminal API
Helcim Card Transaction API
Helcim Device API
Helcim General API
Helcim Invoice API
Helcim Payment API
Where this information came from

This is an independent, third-party profile of Helcim Customer API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.