Skip to main content
POST
/
tokens
/
imports
Request a token import
curl --request POST \
  --url https://sandbox.hellgate.io/tokens/imports \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "provider": "stripe",
  "stripe": {
    "api_key": "sk_test_****"
  }
}
'
{
  "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
}

Authorizations

​
X-API-Key
string
header
required

Body

application/json
​
provider
enum<string>
required

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

Available options:
stripe
​
stripe
object

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

Response

Success response

​
id
string<uuid>

The ID of the import.

​
created_at
string<date-time>

The timestamp when the import was requested.

​
finished_at
string<date-time>

The timestamp when the import was finished.

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

​
provider
enum<string>
Available options:
stripe
​
status
enum<string>
Available options:
preparing,
running,
finished,
aborted
Example:

"preparing"

​
stripe
object
​
attemts
integer

The amount of attempts to import a token.

​
successes
integer

The amount of successful imports.

​
failures
integer

The amount of failures while importing a token.