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.
Some of the features offered by Hellgate® are gated and require explicit activation. These features are clearly labeled with a Gated badge.
In order to get access you need to contact your account manager.
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.
id property.snake_case.null value instead.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.
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.
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>' ...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:
| Parameter | Type | Description |
|---|---|---|
limit | integer | The maximum amount of objects to be returned on a page. |
page | integer | The requested number of the page to return. |
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..."
}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).
https://sandbox.hellgate.io/
https://api.hellgate.io/
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 Off | A standard situation in which a single payment amount shall undergo 3-D Secure authentication. |
| Initial Recurring | An authentication of the first payment in the sequence of recurring payments. |
| Initial Installment | An authentication of the first payment in the sequence of installment payments. |
Hellgate® Tokens are powerful instrument to manage card holder data in a PCI/DSS compliant way.
Achieve PCI / DSS compliance in almost no time using our certified managed compliance service.
Transparently use the cardholder data across all connected processors to implement a non lock-in acquiring setup.
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.
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:
The desired amount of records per page. The parameter defaults to 50 if it is omitted and has a maximum of 500.
It allows sorting the result by created_at. e.g sort=created_at+asc or sort=created_at+desc
Requested status in list format e.g network_token_status=active or network_token_status=active,inactive
Requested card schemes in list format e.g scheme=VISA or scheme=VISA,MASTERCARD
https://sandbox.hellgate.io/tokens
https://api.hellgate.io/tokens
curl -i -X GET \
'https://sandbox.hellgate.io/tokens?business_key=string&from=2019-08-24T14%3A15%3A22Z&limit=1&network_token_status=active&page=1&scheme=VISA&sort=string&to=2019-08-24T14%3A15%3A22Z' \
-H 'X-API-Key: YOUR_API_KEY_HERE'Success response
{ "data": [ { … } ], "pagination": { "current_page": 1, "page_size": 1, "total_items": 1, "total_pages": 1 } }
https://sandbox.hellgate.io/tokens/{id}
https://api.hellgate.io/tokens/{id}
curl -i -X GET \
'https://sandbox.hellgate.io/tokens/{id}' \
-H 'X-API-Key: YOUR_API_KEY_HERE'Success response
The url linking to the card art endpoint
The date-time the payment-method was created (following ISO 8601)
The date-time when the token will expire. Applicable only for ephemeral tokens.
The time the Hellgate Token was invalidated, because the underlying payment instrument was invalidated by the scheme.
The issuer idenfication number (IIN) - also known as BIN
The full lenght of the card number, but masked to conform to PCI/DSS requirments
A two letter country code. ISO 3166-1 alpha-2
The status of the associated network token.
| Status | Description |
|---|---|
active | The network token is active and can be used. |
inactive | The network token is inactive, which prevents using it. The reason can be for example suspended network token. |
pending | A network token is currently being provisioned. As soon as this is available, the status is changed to active. |
failed | A network token failed to be provisioned. |
deleted | The network token is deleted and cannot be used again. It is also not possible to activate the network token again. |
not_available | A network token can not be provisioned with the current configuration. |
The scheme in which the card was issued
The type of ID&V submitted during the creation of the Hellgate token..
This attribute holds the original business key under which the cardholder data was stored on the system from which it was imported to Hellgate®.
It can be used for reconciliation or reference purposes.
{ "id": "5d6b2c9a-9b0b-4b0c-8c7d-9e9d5d7e9d5d", "cardholder_name": "John Doe", "card_art_url": "https://api.hellgate.io/tokens/card-art/374c911a-8125-40eb-acb8-a26efd25f02b", "created_at": "2023-10-01T00:00:00Z", "expiry_month": 4, "expiry_year": 2033, "expires_at": "2023-10-07T00:00:00Z", "issuer_identification_number": "424242", "masked_account_number": "424242******4242", "network_token_status": "active", "scheme": "VISA" }
https://sandbox.hellgate.io/tokens/{id}
https://api.hellgate.io/tokens/{id}
curl -i -X DELETE \
'https://sandbox.hellgate.io/tokens/{id}' \
-H 'X-API-Key: YOUR_API_KEY_HERE'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.
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.