Processor Backup

Hellgate API (2.0)

Getting started

This reference is key for your comprehensive understanding of Hellgate® and, as such, essential for the successful use of our payment orchestration products.

Hellgate® APIs make use of RESTful conventions when possible and where it makes sense. All calls use the standard HTTP verbs to express access semantics, like GET, POST, PATCH, and DELETE. Other related conventions for our API can be found in the section below.

Beta Features

Hellgate® offers various features as part of our beta release track. These features are clearly labeled with a Beta badge in the documentation and interface.

By default, accounts do not have access to beta features unless explicitly subscribed to beta releases. If you would like to enable beta features, please contact your account manager for subscription options.

⚠️ Beta features are experimental and subject to change or removal at any time. They may also have limited support and stability.

JSON Conventions

  • Resources are addressable by a UUIDv4 id property.
  • Property names are always in snake_case.
  • Hellgate® does not support empty strings. To unset a string value, use an explicit null value instead.
  • Temporal data is encoded in ISO 8601 strings.

Authentication

Hellgate® supports API keys to authenticate requests.

The keys are passed in via the HTTP header x-api-key.

curl --header 'X-API-Key: <SECRET>' \
  --request POST 'https://api.hellgate.io/...'

The keys must be handled with care and kept secure. Never hardcode the API keys in your source code, but keep them solely on your backend systems.

API Use

API Versions

Hellgate® API will be updated regularly, to include new features and updates to existing ones. We package these changes into versions that can be addressed using a header field (x-hellgate-version).

If the there is no version specified in the header, the most recent version is being used.

curl --header 'x-hellgate-version: <SELECTED VERSION>' \
  --request POST 'https://api.hellgate.io/...'

Hellgate® sets the x-hellgate-version header on API responses, to tell the integrator which version is in use.

Idempotency

To prevent your system from handling requests twice and thus, for example, charging a customer twice, Hellgate® supports idempotency on requests to the API.

The behavior is controlled via the header field x-idempotency-Key.

curl --header 'x-idempotency-key: <key>' ...

Pagination

Endpoints that return lists of objects support cursor-based pagination requests. By default, Hellgate® returns up to 50 objects per API call. If the number of objects in a response from a support endpoint exceeds the default, then an integration can use pagination to request a specific set of the results and/or to limit the number of returned objects.

If an endpoint supports pagination, the response body follows this structure:

{
  "current_page": 1,
  "page_size": 50,
  "total_items": 200,
  "total_pages": 4,
  "data": [...]
}

The single pages can be requested with query parameters:

ParameterTypeDescription
limitintegerThe maximum amount of objects to be returned on a page.
pageintegerThe requested number of the page to return.

Request Errors

Hellgate® uses the standard errors to indicate the client errors on the gateway level.

The response payload for processing errors follows a standard format.

{
  "status": "the HTTP status code",
  "classifier": "the classifer of the error",
  "message": "interesting for humans..."
}

Business Errors

The processing errors refer to the primary functions of Hellgate® and not necessarily to the related business logic. For example, a failed authorization due to insufficient funds will result in a 200 response, as the payment layer could successfully process the request (even though the business result is negative).

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL https://hellgate.io
Starfish GmbH & Co. KG hello@starfish.team
License Hellgate® API Terms
Languages
Servers
Hellgate® Sandbox
https://sandbox.hellgate.io/
Hellgate® Production
https://api.hellgate.io/

Customer Initiated

Operations

Payment Modifications

Operations

Payment Data

Operations

Customer Initiated

Hellgate® allows to process EMVCo 3-D Secure authentication requests as standalone request.

For example, these endpoints can be used to process payment authentication centrally and process the subsequent authorization requests conditionally on different payment processors.

The secion of customer initiated authentications consists of three use-cases:

Use-Case Description
One OffA standard situation in which a single payment amount shall undergo 3-D Secure authentication.
Initial RecurringAn authentication of the first payment in the sequence of recurring payments.
Initial InstallmentAn authentication of the first payment in the sequence of installment payments.
Operations

Merchant Initiated (3RI)

Hellgate® supports requestor-initiated EMVCo 3-D Secure authentication requests as standalone transactions.

All requests in this section must be linked to a prior customer-initiated authentication.

Operations

Authentication Data

Access the results of prior authentications for reference.

Operations

Credentials on File

Operations

Create Hellgate® Tokens

Hellgate® Tokens are powerful instrument to manage card holder data in a PCI/DSS compliant way.

Compliance as a Service

Achieve PCI / DSS compliance in almost no time using our certified managed compliance service.

No Acquirer Lock-In

Transparently use the cardholder data across all connected processors to implement a non lock-in acquiring setup.

Network Tokens

For every card which is tokenized on Hellgate®, network-tokens can be automatically provisioned. This allows for more secure transactions, better conversion, and ultimately lower processing cost.

Operations

Token Management

All cards stored with Hellgate® can be managed via the endpoints in this section.

The CVC2 security code is only kept in an ephemeral cache for a few minutes. The API allows to manage this resource with these endpoints:

  • check if the CVC2 is still availble
  • request a new session to renew the CVC2 with our SDK
  • consume the token after a successful authorization on an external processor
Operations

Network Tokens

Hellgate® supports Network Tokens with major card schemes.

The lifecycle of network tokens is automatically managed. When activated a network token is automatically provisioned and maintained through its life-cycle.

The use of Network Tokens requires prior activation by your account manager.

Operations

Compliance Service

Operations

Merchants

Hellgate® accounts support two operating models.

This is the default model for accounts.

  • It is not possible to add sub-merchants (via POST /merchants)
  • It is not possible to delete the primary merchant (via DELETE /merchants/{id})
Operations

Processor Backup

In case your precious payment-method data is currently locked into an acquirer processor, Hellgate® allows you to migrate the tokens automatically. Currently we support stripe.com, but more processors are on our list. Please ask you account manager for more information.

Detailed documentation on how to migrate your stripe payment methods can be found on the Hellgate® Developer Documentation.

Operations

Request a token import

Request

Requests the import of cardholder data from a third-party vault (currently supported source is stripe.com).

The import processed in the background and its status can be queried by the returned import ID. During preparation and processing of a job it is not possible to create another import.

Bodyapplication/json
providerstringrequired

The source from where cardholder data shall be imported. Hellgate® supports currently stripe.com as input source.

Value"stripe"
stripeobject

This property holds the configuration data for the import from stripe. It must be present if the selected provider is stripe.

curl -i -X POST \
  https://sandbox.hellgate.io/tokens/imports \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "provider": "stripe"
  }'

Responses

Success response

Bodyapplication/json
idstring(uuid)

The ID of the import.

created_atstring(date-time)

The timestamp when the import was requested.

finished_atstring(date-time)

The timestamp when the import was finished.

It is only available if the import was successfully finished or was aborted.

providerstring
Value"stripe"
statusstring
Enum"preparing""running""finished""aborted"
Example: "preparing"
stripeobject
attemtsinteger

The amount of attempts to import a token.

successesinteger

The amount of successful imports.

failuresinteger

The amount of failures while importing a token.

Response
application/json
{
  "id": "63820065-af1a-42fa-b96f-8d928fc6c2ec",
  "created_at": "2023-10-10T00:00:00Z",
  "provider": "stripe",
  "status": "preparing",
  "stripe": {
    "api_key": "[REDACTED]"
  },
  "attemts": 0,
  "successes": 0,
  "failures": 0
}

Get import details

Request

Show details of a token import

Path
idstring(uuid)required

The ID of the import.

curl -i -X GET \
  'https://sandbox.hellgate.io/tokens/imports/{id}' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Success response

Bodyapplication/json
idstring(uuid)

The ID of the import.

created_atstring(date-time)

The timestamp when the import was requested.

finished_atstring(date-time)

The timestamp when the import was finished.

It is only available if the import was successfully finished or was aborted.

providerstring
Value"stripe"
statusstring
Enum"preparing""running""finished""aborted"
Example: "preparing"
stripeobject
attemtsinteger

The amount of attempts to import a token.

successesinteger

The amount of successful imports.

failuresinteger

The amount of failures while importing a token.

Response
application/json
{
  "id": "63820065-af1a-42fa-b96f-8d928fc6c2ec",
  "created_at": "2023-10-10T00:00:00Z",
  "provider": "stripe",
  "status": "preparing",
  "stripe": {
    "api_key": "[REDACTED]"
  },
  "attemts": 0,
  "successes": 0,
  "failures": 0
}

Abort an import

Request

Abort a running token import.

This is possible while the import is not finished or already aborted.

Path
idstring(uuid)required

The ID of the import.

curl -i -X POST \
  'https://sandbox.hellgate.io/tokens/imports/{id}/abort' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Success response

Bodyapplication/json
idstring(uuid)

The ID of the import.

created_atstring(date-time)

The timestamp when the import was requested.

finished_atstring(date-time)

The timestamp when the import was finished.

It is only available if the import was successfully finished or was aborted.

providerstring
Value"stripe"
statusstring
Enum"preparing""running""finished""aborted"
Example: "preparing"
stripeobject
attemtsinteger

The amount of attempts to import a token.

successesinteger

The amount of successful imports.

failuresinteger

The amount of failures while importing a token.

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created_at": "2019-08-24T14:15:22Z",
  "finished_at": "2019-08-24T14:15:22Z",
  "provider": "stripe",
  "status": "preparing",
  "stripe": {
    "api_key": "[REDACTED]"
  },
  "attemts": 0,
  "successes": 0,
  "failures": 0
}

Get import failures

Request

Path
idstring(uuid)required

The ID of the import.

Query
limitinteger[ 1 .. 500 ]

The desired amount of records per page. The parameter defaults to 50 if it is omitted and has a maximum of 500.

pageinteger>= 1

The desired number of the page to return.

curl -i -X GET \
  'https://sandbox.hellgate.io/tokens/imports/{id}/failures?limit=1&page=1' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Success response

Bodyapplication/json
dataArray of objects
paginationobject

The meta-data describing lists of data from the Hellgate® API. The pages are indexed from 1 up to the total_pages.

Example: {"current_page":1,"page_size":1,"total_items":1,"total_pages":1}
Response
application/json
{
  "data": [
    { … }
  ],
  "pagination": {
    "current_page": 1,
    "page_size": 1,
    "total_items": 1,
    "total_pages": 1
  }
}

Reconciliation

Operations
Starfish GmbH & Co. KG © 2024