Skip to main content
POST
/
customers
/
{customer_id}
/
cards
Create a card
curl --request POST \
  --url https://commerce1.on-hellgate.dev/customers/{customer_id}/cards \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "cardholder_name": "<string>",
  "expiration_month": 123,
  "expiration_year": 123,
  "masked_card_number": "<string>",
  "provider": "<string>",
  "token": "<string>"
}
'
import requests

url = "https://commerce1.on-hellgate.dev/customers/{customer_id}/cards"

payload = {
"cardholder_name": "<string>",
"expiration_month": 123,
"expiration_year": 123,
"masked_card_number": "<string>",
"provider": "<string>",
"token": "<string>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
cardholder_name: '<string>',
expiration_month: 123,
expiration_year: 123,
masked_card_number: '<string>',
provider: '<string>',
token: '<string>'
})
};

fetch('https://commerce1.on-hellgate.dev/customers/{customer_id}/cards', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://commerce1.on-hellgate.dev/customers/{customer_id}/cards",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'cardholder_name' => '<string>',
'expiration_month' => 123,
'expiration_year' => 123,
'masked_card_number' => '<string>',
'provider' => '<string>',
'token' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://commerce1.on-hellgate.dev/customers/{customer_id}/cards"

payload := strings.NewReader("{\n \"cardholder_name\": \"<string>\",\n \"expiration_month\": 123,\n \"expiration_year\": 123,\n \"masked_card_number\": \"<string>\",\n \"provider\": \"<string>\",\n \"token\": \"<string>\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://commerce1.on-hellgate.dev/customers/{customer_id}/cards")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"cardholder_name\": \"<string>\",\n \"expiration_month\": 123,\n \"expiration_year\": 123,\n \"masked_card_number\": \"<string>\",\n \"provider\": \"<string>\",\n \"token\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://commerce1.on-hellgate.dev/customers/{customer_id}/cards")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"cardholder_name\": \"<string>\",\n \"expiration_month\": 123,\n \"expiration_year\": 123,\n \"masked_card_number\": \"<string>\",\n \"provider\": \"<string>\",\n \"token\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "cardholder_name": "<string>",
  "expiration_month": 123,
  "expiration_year": 123,
  "masked_card_number": "<string>",
  "provider": "<string>",
  "status": "<string>",
  "token": "<string>"
}
{
"classifier": "<string>",
"code": 123,
"message": "<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

Body

application/json

Body

cardholder_name
string
required
expiration_month
integer
required
expiration_year
integer
required
masked_card_number
string
required
provider
string
required
token
string
required

Response

Success

cardholder_name
string
expiration_month
integer
expiration_year
integer
masked_card_number
string
provider
string
status
string
token
string