Get a setup request - Hellgate Cloud Platform

GET

customers

{customer_id}

setups

{id}

Get a setup request

curl --request GET \
  --url https://commerce1.on-hellgate.dev/customers/{customer_id}/setups/{id} \
  --header 'X-API-Key: <api-key>'

{
  "created_at": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updated_at": "2023-11-07T05:31:56Z",
  "data": {},
  "external_id": "<string>",
  "failure_details": [
    {
      "classifier": "<string>",
      "message": "<string>"
    }
  ],
  "payment_method": {
    "token": "<string>"
  }
}

Authorizations

X-API-Key

string

header

required

Headers

X-Account-ID

string

Identifies the account. Required when authenticating via mTLS — omit when using an API key (account is inferred from the key).

Path Parameters

customer_id

string

required

Customer ID

string

required

Setup ID

Response

Success

created_at

string<date-time>

required

string<uuid>

required

status

enum<string>

required

Available options:

IN_PROGRESS,

SUCCESS,

FAILURE

type

enum<string>

required

Available options:

CARD,

SEPA_MANDATE,

ACH_MANDATE

updated_at

string<date-time>

required

data

object

external_id

string

failure_details

FailureDetailResponse · object[]

Show child attributes

payment_method

object

Show child attributes

Handle a setup callback

⌘I

Get a setup request

curl --request GET \
  --url https://commerce1.on-hellgate.dev/customers/{customer_id}/setups/{id} \
  --header 'X-API-Key: <api-key>'

{
  "created_at": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updated_at": "2023-11-07T05:31:56Z",
  "data": {},
  "external_id": "<string>",
  "failure_details": [
    {
      "classifier": "<string>",
      "message": "<string>"
    }
  ],
  "payment_method": {
    "token": "<string>"
  }
}