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 Payment API

The Payment API from Helcim — 7 operation(s) for payment.

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

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

This API exposes 7 operations across 7 paths, and defines 23 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.

7 operations 7 paths 23 schemas 7 POST

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 Payment 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 7

Across 7 paths, the API surfaces 7 operations — 7 POST. Each is listed below with its method, path, parameters, and response codes.

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

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are SuccessfulPaymentResponse (18 properties), BankAccount (15 properties), SuccessfulAchTransactionResponse (12 properties), VerifyRequest (9 properties). Each schema is shown below with its type and property counts.

SuccessfulPaymentResponse
object
18 properties
CaptureRequest
object
4 properties 3 required
FailedPaymentResponse
object
1 property
Pickup
object
2 properties 1 required
VerifyRequest
object
9 properties 5 required
PreauthRequest
InvoiceWithTip
InvoiceCreateAfterProcessing
object
5 properties
CardData
object
1 property 1 required
BankToken
object
1 property 1 required
InvoiceBase
object
2 properties
LineItem
object
6 properties 3 required
Address
object
9 properties 3 required
SuccessfulAchTransactionResponse
object
12 properties
PaymentRequest
Tax
object
2 properties 2 required
BankAccount
object
15 properties 11 required
BankData
object
1 property 1 required
CardToken
object
1 property 1 required
PaymentRequestBase
object
9 properties 4 required
Card
object
4 properties 4 required
Shipping
object
3 properties 3 required
Discount
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

helcim-payment-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 Customer API
Helcim Device API
Helcim General API
Helcim Invoice API
Where this information came from

This is an independent, third-party profile of Helcim Payment 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.