HIFI Docs

POST

external-cards

Create an external card

curl --request POST \
  --url https://production.hifi.com/v3/external-cards \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "counterPartyId": "cpty_7bV1aLcs3Kf9dQ2mNpXwZ",
  "firstName": "John",
  "lastName": "Doe",
  "cardNumber": "4111111111111111",
  "expiryMonth": "09",
  "expiryYear": "28",
  "cvv": "123"
}
'

import requests

url = "https://production.hifi.com/v3/external-cards"

payload = {
    "counterPartyId": "cpty_7bV1aLcs3Kf9dQ2mNpXwZ",
    "firstName": "John",
    "lastName": "Doe",
    "cardNumber": "4111111111111111",
    "expiryMonth": "09",
    "expiryYear": "28",
    "cvv": "123"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    counterPartyId: 'cpty_7bV1aLcs3Kf9dQ2mNpXwZ',
    firstName: 'John',
    lastName: 'Doe',
    cardNumber: '4111111111111111',
    expiryMonth: '09',
    expiryYear: '28',
    cvv: '123'
  })
};

fetch('https://production.hifi.com/v3/external-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://production.hifi.com/v3/external-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([
    'counterPartyId' => 'cpty_7bV1aLcs3Kf9dQ2mNpXwZ',
    'firstName' => 'John',
    'lastName' => 'Doe',
    'cardNumber' => '4111111111111111',
    'expiryMonth' => '09',
    'expiryYear' => '28',
    'cvv' => '123'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://production.hifi.com/v3/external-cards"

	payload := strings.NewReader("{\n  \"counterPartyId\": \"cpty_7bV1aLcs3Kf9dQ2mNpXwZ\",\n  \"firstName\": \"John\",\n  \"lastName\": \"Doe\",\n  \"cardNumber\": \"4111111111111111\",\n  \"expiryMonth\": \"09\",\n  \"expiryYear\": \"28\",\n  \"cvv\": \"123\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://production.hifi.com/v3/external-cards")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"counterPartyId\": \"cpty_7bV1aLcs3Kf9dQ2mNpXwZ\",\n  \"firstName\": \"John\",\n  \"lastName\": \"Doe\",\n  \"cardNumber\": \"4111111111111111\",\n  \"expiryMonth\": \"09\",\n  \"expiryYear\": \"28\",\n  \"cvv\": \"123\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://production.hifi.com/v3/external-cards")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"counterPartyId\": \"cpty_7bV1aLcs3Kf9dQ2mNpXwZ\",\n  \"firstName\": \"John\",\n  \"lastName\": \"Doe\",\n  \"cardNumber\": \"4111111111111111\",\n  \"expiryMonth\": \"09\",\n  \"expiryYear\": \"28\",\n  \"cvv\": \"123\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "extcrd_2mNpXwZ7bV1aLcs3Kf9dQ",
  "userId": "usr_3Kf9dQ2mNpXwZ7bV1aLcs",
  "counterPartyId": "cpty_7bV1aLcs3Kf9dQ2mNpXwZ",
  "firstName": "John",
  "lastName": "Doe",
  "cardNumber": "************1111",
  "expiryMonth": "09",
  "expiryYear": "28",
  "status": "ACTIVE",
  "createdAt": "2026-07-01T10:30:00.000Z",
  "updatedAt": "2026-07-01T10:30:00.000Z"
}

{
  "type": "VALIDATION_ERROR",
  "message": "One or more fields are invalid or missing.",
  "fields": [
    {
      "code": "invalid_value",
      "message": "Must be a valid email address",
      "field": "email"
    }
  ]
}

{
  "type": "UNAUTHORIZED",
  "message": "Authentication required"
}

{
  "type": "RESOURCE_CONFLICT",
  "message": "Resource already exists or conflicts with current state"
}

{
  "type": "INTERNAL_SERVER_ERROR",
  "message": "An internal server error occurred"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Card details to tokenize and associate with the counter party.

Card details to tokenize. The card number is tokenized with the card provider and never stored in plaintext; only the last four digits are retained.

counterPartyId

string

required

Public ID of the counter party this card belongs to (prefixed with cpty_).

Example:

"cpty_7bV1aLcs3Kf9dQ2mNpXwZ"

firstName

string

required

Cardholder first name.

Example:

"John"

lastName

string

required

Cardholder last name.

Example:

"Doe"

cardNumber

string

required

Full card number (PAN).

Example:

"4111111111111111"

expiryMonth

string

required

Card expiry month (2 digits).

Required string length: 2

Example:

"09"

expiryYear

string

required

Card expiry year (2 digits).

Required string length: 2

Example:

"28"

cvv

string

required

Card verification value.

Example:

"123"

nickname

string

Client-supplied nickname for the external card.

Required string length: 1 - 100

Example:

"Jane's virtual card"

Response

External card created successfully.

An external card.

string

Public ID of the external card (prefixed with extcrd_).

Example:

"extcrd_2mNpXwZ7bV1aLcs3Kf9dQ"

userId

string

Public ID of the user this card belongs to (prefixed with usr_).

Example:

"usr_3Kf9dQ2mNpXwZ7bV1aLcs"

counterPartyId

string

Public ID of the counter party this card belongs to (prefixed with cpty_).

Example:

"cpty_7bV1aLcs3Kf9dQ2mNpXwZ"

firstName

string

Cardholder first name.

Example:

"John"

lastName

string

Cardholder last name.

Example:

"Doe"

cardNumber

string

Masked card number, exposing only the last four digits.

Example:

"************1111"

expiryMonth

string

Card expiry month (2 digits).

Example:

"09"

expiryYear

string

Card expiry year (2 digits).

Example:

"28"

nickname

string | null

Client-supplied nickname for the external card.

Example:

"Jane's virtual card"

status

enum<string>

Available options:

ACTIVE,

INACTIVE

Example:

"ACTIVE"

invalidCode

string | null

Code explaining why the external card was marked invalid; the card's status is then INACTIVE. Null otherwise.

Example:

null

invalidMessage

string | null

Human-readable detail for invalidCode. Null when invalidCode is null.

Example:

null

createdAt

string<date-time>

Example:

"2026-07-01T10:30:00.000Z"

updatedAt

string<date-time>

Example:

"2026-07-01T10:30:00.000Z"

⌘I

Create an external card

curl --request POST \
  --url https://production.hifi.com/v3/external-cards \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "counterPartyId": "cpty_7bV1aLcs3Kf9dQ2mNpXwZ",
  "firstName": "John",
  "lastName": "Doe",
  "cardNumber": "4111111111111111",
  "expiryMonth": "09",
  "expiryYear": "28",
  "cvv": "123"
}
'

import requests

url = "https://production.hifi.com/v3/external-cards"

payload = {
    "counterPartyId": "cpty_7bV1aLcs3Kf9dQ2mNpXwZ",
    "firstName": "John",
    "lastName": "Doe",
    "cardNumber": "4111111111111111",
    "expiryMonth": "09",
    "expiryYear": "28",
    "cvv": "123"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    counterPartyId: 'cpty_7bV1aLcs3Kf9dQ2mNpXwZ',
    firstName: 'John',
    lastName: 'Doe',
    cardNumber: '4111111111111111',
    expiryMonth: '09',
    expiryYear: '28',
    cvv: '123'
  })
};

fetch('https://production.hifi.com/v3/external-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://production.hifi.com/v3/external-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([
    'counterPartyId' => 'cpty_7bV1aLcs3Kf9dQ2mNpXwZ',
    'firstName' => 'John',
    'lastName' => 'Doe',
    'cardNumber' => '4111111111111111',
    'expiryMonth' => '09',
    'expiryYear' => '28',
    'cvv' => '123'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://production.hifi.com/v3/external-cards"

	payload := strings.NewReader("{\n  \"counterPartyId\": \"cpty_7bV1aLcs3Kf9dQ2mNpXwZ\",\n  \"firstName\": \"John\",\n  \"lastName\": \"Doe\",\n  \"cardNumber\": \"4111111111111111\",\n  \"expiryMonth\": \"09\",\n  \"expiryYear\": \"28\",\n  \"cvv\": \"123\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://production.hifi.com/v3/external-cards")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"counterPartyId\": \"cpty_7bV1aLcs3Kf9dQ2mNpXwZ\",\n  \"firstName\": \"John\",\n  \"lastName\": \"Doe\",\n  \"cardNumber\": \"4111111111111111\",\n  \"expiryMonth\": \"09\",\n  \"expiryYear\": \"28\",\n  \"cvv\": \"123\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://production.hifi.com/v3/external-cards")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"counterPartyId\": \"cpty_7bV1aLcs3Kf9dQ2mNpXwZ\",\n  \"firstName\": \"John\",\n  \"lastName\": \"Doe\",\n  \"cardNumber\": \"4111111111111111\",\n  \"expiryMonth\": \"09\",\n  \"expiryYear\": \"28\",\n  \"cvv\": \"123\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "extcrd_2mNpXwZ7bV1aLcs3Kf9dQ",
  "userId": "usr_3Kf9dQ2mNpXwZ7bV1aLcs",
  "counterPartyId": "cpty_7bV1aLcs3Kf9dQ2mNpXwZ",
  "firstName": "John",
  "lastName": "Doe",
  "cardNumber": "************1111",
  "expiryMonth": "09",
  "expiryYear": "28",
  "status": "ACTIVE",
  "createdAt": "2026-07-01T10:30:00.000Z",
  "updatedAt": "2026-07-01T10:30:00.000Z"
}

{
  "type": "VALIDATION_ERROR",
  "message": "One or more fields are invalid or missing.",
  "fields": [
    {
      "code": "invalid_value",
      "message": "Must be a valid email address",
      "field": "email"
    }
  ]
}

{
  "type": "UNAUTHORIZED",
  "message": "Authentication required"
}

{
  "type": "RESOURCE_CONFLICT",
  "message": "Resource already exists or conflicts with current state"
}

{
  "type": "INTERNAL_SERVER_ERROR",
  "message": "An internal server error occurred"
}

Overview

Endpoints

Create an external card

Authorizations

Body

Response