Skip to content

Custodial On-Chain Card Issuing Integration guide

Introduction

Audience: For apps that have custody of user funds. Card spending will be pre-funded with deposits to an on-chain contract.

Purpose: Link the guides and API reference into one end-to-end guide. This guide includes curls for each API call required to setup a partner, user and create and test a card.

Before You Get Started

Verify your chain is supported

Before you begin integrating ensure your chain and token combination is supported.

Select Funding Protocol

See the Funding Protocols guide to find which protocol would best suit your use case.

Select KYC Mode

Partner Conducted KYC is the recommended KYC mode for custodial apps that have already verified their users.

Set up your partner account

Contact support to get your:

  • API key
  • API secret
  • Partner account ID
  • Card program ID

Provision application resources

Register a Funding Channel

The number and types of Funding Channels to create depend on your specific use case and protocol.

See: Creating a Funding Channel.

Per cardholder setup

Set credentials

card_issuer_api_key="<your_card_issuer_api_key>"
card_issuer_api_secret="<your_card_issuer_api_secret>"
partner_account_id="<your_partner_account_id>"
card_program_id="<your_card_program_id>"
funding_channel_id="<your_funding_channel_id>"

Create a cardholder account

Provision each cardholder with an account and save their ID.

In the custodial case it is assumed that you have gained permission to act on the cardholders behalf. All cardholder resources on our platform will be fully owned by your app. Each request on a cardholder resource must specify the cardholder by referencing the cardholder ID in the headers. As specified in the Authentication Guide.

Call Create account:

cardholder_account_id=$(curl \
  -X POST "https://test.immersve.com/api/accounts" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: ${card_issuer_api_key}" \
  -H "X-Api-Secret: ${card_issuer_api_secret}" \
  --data "{
    \"parentAccountId\": \"${partner_account_id}\",
    \"type\": \"cardholder\",
    \"name\": \"<e.g. Cardholder Account of Joe>\"
  }" | jq -r .id)

Prove ownership of web3 address

In order to prove ownership of the respective EOA (Externally owned account), sign a challenge message using the EOA's private key. Use an address that you control and would like to use to fund card.

Quick start links for message signing:

Call Create challenge endpoint:

wallet_address="<wallet_address>"

response=$(curl -X POST "https://test.immersve.com/api/challenges" \
-H "Content-Type: application/json" \
-H "X-Api-Key: ${card_issuer_api_key}" \
-H "X-Api-Secret: ${card_issuer_api_secret}" \
-H "x-account-id: ${cardholder_account_id}" \
--data "{
    \"purpose\": \"claim-web3-address\",
    \"network\": \"<network name e.g polygon-amoy>\",
    \"address\": \"${wallet_address}\"
}")

challenge_id=$(echo $response | jq -r '.id')
message=$(echo $response | jq -r '.message')

echo "Message:${message}"

Register cardholder’s funding source

Creating a Funding Source for a cardholder enables Immersve to attribute transactions on a Funding Storage contract to individual cardholders. signature is the signature hash of the signed message from the previous step.

For more context and information on card funding and executing deposits and withdrawals see the Card Funding guide.

Call Create a funding source for an account:

signature="<signature hash of cardholder signing the challenge message with their wallet>"

funding_source_id=$(curl -X POST "https://test.immersve.com/api/funding-sources" \
-H "Content-Type: application/json" \
-H "X-Api-Key: ${card_issuer_api_key}" \
-H "X-Api-Secret: ${card_issuer_api_secret}" \
-H "X-Account-Id: ${cardholder_account_id}" \
--data "{
    \"accountId\": \"${cardholder_account_id}\",
    \"fundingAddress\": \"${wallet_address}\",
    \"fundingChannelId\": \"${funding_channel_id}\",
    \"signature\": \"${signature}\",
    \"challengeId\": \"${challenge_id}\"
}" | jq -r '.id')

Request a Card

For a more complete guide on card creation see Issue a Virtual Card.

Create a card

Post the funding source ID and your provided card program ID to the card orders endpoint and record the returned card ID.

Call Create a card:

card_id=$(curl -X POST "https://test.immersve.com/api/cards" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: ${card_issuer_api_key}" \
  -H "X-Api-Secret: ${card_issuer_api_secret}" \
  -H "X-Account-Id: ${cardholder_account_id}" \
  --data '{
    "cardProgramId": "'${card_program_id}'",
    "fundingSourceId": "'${funding_source_id}'"
  }' | jq -r .cardId)

Get card details

Call Get card details to see card status and ensure it is active:

curl -X GET "https://test.immersve.com/api/cards/${card_id}" \
  -H "X-Api-Key: ${card_issuer_api_key}" \
	-H "X-Api-Secret: ${card_issuer_api_secret}" \
	-H "X-Account-Id: ${cardholder_account_id}"

Get sensitive card details

See the Fetching Secure Card Information for a fuller picture on how to securely obtain the sensitive card details for a cardholder to spend with the card.

  1. Generate the secure card details token:
curl -X POST "https://test.immersve.com/api/cards/${card_id}/pan-token" \
  -H "X-Api-Key: ${card_issuer_api_key}" \
  -H "X-Api-Secret: ${card_issuer_api_secret}" \
  -H "X-Account-Id: ${cardholder_account_id}"

# The response will contain a secure time-limited callback URL
# which can be used to obtain the sensitive card details:
# {
#   "callbackUrl": "https://test-sec.immersve.com/api/cards/secure?tokenId=C4762D4F15BB1EC617999FDE15B41F33-1000881758"
# }

pan_token_callback_url=<callbackUrl>

  1. Get the sensitive card details:
  curl -X GET "${pan_token_callback_url}"

Get KYC and Contact Details Prerequisites

The Get spending prerequisites endpoint can be used to check whether the KYC and contact details requirements for a cardholder have been satisfied. If no KYC or contact details parameters are returned it means that all requirements have been met.

curl -X POST "https://test.immersve.com/api/spending-prerequisites" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: ${card_issuer_api_key}" \
	-H "X-Api-Secret: ${card_issuer_api_secret}" \
  -H "X-Account-Id: ${cardholder_account_id}" \
  --data '{
    "cardProgramId": "'${card_program_id}'",
    "fundingSourceId": "'${funding_source_id}'",
    "spendableAmount": 100,
    "spendableCurrency": "USD",
    "kycType": "partner-conducted",
    "kycRegion":"NZL"
  }'

Contact Details

Immersve requires users contact details (phone number and email) for the following reasons, this should be explained to customers:

  • Adding cards to Apple/Google Pay wallets (X-Pay)
  • Performing 3DS validation for online transactions

If a user doesn’t provide contact details, they risk online transactions being rejected and might not be able to add cards to X-Pay wallets.

Before you share contact details with Immersve you must collect user consent via checkbox can be done at the same time as KYC information sharing.

Call Update contact details:

curl -X PATCH "https://test.immersve.com/api/accounts/${cardholder_account_id}/contact-details" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: ${card_issuer_api_key}" \
  -H "X-Api-Secret: ${card_issuer_api_secret}" \
  -H "X-Account-Id: ${cardholder_account_id}" \
  --data '{
	  "email": {
		  "emailAddress": "joe@cardholder.email",
		},
    "phone": {
		  "phoneNumber": "+64123456789",
	  }
  }'

Partner Conducted KYC

See: Partner Conducted KYC.

Perform a test card transaction

Perform a card transaction using our merchant simulator. This is the best test of the full setup.

Deposit funds

Before spending with a card, funds must be deposited to a funding source connected to the card. Use the Get spending prerequisites endpoint to get the correct Smart Contract write transaction for the specified amount, chain, and token.

For more information on executing deposits and withdrawals see the Card Funding guide.

curl -X POST "https://test.immersve.com/api/spending-prerequisites" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: ${card_issuer_api_key}" \
	-H "X-Api-Secret: ${card_issuer_api_secret}" \
  -H "X-Account-Id: ${cardholder_account_id}" \
  --data '{
   "cardProgramId": "'${card_program_id}'",
   "fundingSourceId": "'${funding_source_id}'",
   "spendableAmount": 100,
   "spendableCurrency": "USD"
  }'

Ensure card is funded

Verify that the balance is reflected on the Funding Source.

Call List funding sources:

curl -X GET "https://test.immersve.com/api/accounts/${cardholder_account_id}/funding-sources" \
  -H "X-Api-Key: ${card_issuer_api_key}" \
  -H "X-Api-Secret: ${card_issuer_api_secret}" \
  -H "X-Account-Id: ${cardholder_account_id}"

Authorize a transaction

Call the simulator endpoint with the sensitive card details.

Call Authorize a transaction:

curl -X POST "https://test.immersve.com/api/simulator/authorize" \
  -H "X-Api-Key: ${card_issuer_api_key}" \
	-H "X-Api-Secret: ${card_issuer_api_secret}" \
  -H "X-Account-Id: ${cardholder_account_id}"
  --data '{
    "transactionType": "purchase",
    "transactionAmount": "10",
    "cardPan": "1234567812345678",
    "cardExpiry": "202510",
    "cardCvv": "123"
  }'