Orange Path Token Management

The orange path is the digital wallet flow in which the card network flags a provisioning request as high risk and asks the cardholder to contact their issuer before the card can be added. This guide shows how to detect an orange path token with the Card Token Updated webhook topic and approve it with the Approve Card Token endpoint.

Orange Path Flow

When a cardholder lands on the orange path flow Immersve sends a Card Token Updated webhook. See below for the example payload:

{
  "topic": "card-token-updated",
  "payload": {
    "event": {
      "type": "created",
      "createdAt": "2026-10-15T02:11:40.000Z"
    },
    "token": {
      "id": "c7f3e2a1b4d94e8f9a0b1c2d3e4f5a6b",
      "requestor": "apple-pay",
      "status": "awaiting-approval",
      "description": "iPhone",
      "provisioningRequestedAt": "2026-10-15T02:11:40.000Z"
    },
    "card": {
      "id": "b11a6eac773cc13b9669f6bc0caba93a"
    },
    "cardholder": {
      "id": "9ce69d31277108d46d2cb19fa772705e"
    }
  },
  "messageId": "msg-1234",
  "listenerId": "listener-1234",
  "listenerAccountId": "partner-account-1",
  "deliveryAttempt": 1,
  "createdAt": "2026-10-15T02:11:41Z",
  "sentAt": "2026-10-15T02:11:42Z",
  "keyId": "9ce69d31277108d46d2cb19fa772705e",
  "issuer": "api.immersve.com"
}

The fields below identify an orange path token and tell you what to do with it:

• event.type — created, meaning the wallet has just requested the token.
• token.status — awaiting-approval, meaning the wallet has told the cardholder to contact the issuer to finish adding the card.
• token.id — The identifier to pass as cardTokenId when you approve the token.

Approving a Token

Once you are satisfied a cardholder is not high risk, call the Approve Card Token endpoint with the token.id from the webhook. The token becomes active and the cardholder can start paying with their digital wallet.