Consume a token - Hellgate Cloud Platform

POST

/

tokens

/

{id}

/

consume

Consume a token

curl --request POST \
  --url https://sandbox.hellgate.io/tokens/{id}/consume \
  --header 'X-API-Key: <api-key>'

{
  "code": 401,
  "message": "No valid means of authentication was provided",
  "classifier": "UNAUTHORIZED"
}

Authorizations

X-API-Key

string

header

required

Path Parameters

id

string<uuid>

required

The ID of the Commerce token

Response

Success response (No Content)

Forward card dataThis endpoint allows to securely forward cardholder data to a certified third-party provider. It will inject sensitive cardholder data, referenced by a Commerce token, into the request before forwarding it. Commerce requires certain HTTP headers for this feature. These headers are reserved and cannot be used by the caller: | Header | Required | Description | | ----------------- | -------- | ------------------------------------------------------------ | | `x-api-key` | Yes | Authentication of the request. | | `x-hellgate-token`| Yes | Identify the Commerce token to use for the request. | | `x-destination-url` | Yes | Define the target URL to which the request shall be forwarded. | | `x-hellgate-version` | No | Define the API version to use for the request. | Refer to the general documentation about [forwarding senstive data](/products/commerce/v2/guides/forwarding) for more information.

⌘I

Consume a token

curl --request POST \
  --url https://sandbox.hellgate.io/tokens/{id}/consume \
  --header 'X-API-Key: <api-key>'

{
  "code": 401,
  "message": "No valid means of authentication was provided",
  "classifier": "UNAUTHORIZED"
}