List of Events

Event Name	Description
networktoken.token.created	A network token was created for a customer
networktoken.token.refresh	A network token was updated by the card issuer

Token Create

When Customer Token Vault is active, the gateway will try to create a network token in 3 different situations:

When running a transaction (sale/auth/validate)
When adding to the Customer Vault
When creating a recurring subscription

Please note that while a token will be requested in all three instances, this webhook will only send if a network token was successfully created. The most common reason for a network token not being created in these instances is that the issuing bank of the card is not participating in network tokenization yet.

{
  "event_id": "237a6b9e-a9ad-45f5-875d-6b9baff2dd72",
  "event_type": "networktoken.token.create",
  "event_body": {
    "merchant": {
      "id": "1"
    },
    "transaction_ids": [
      "281474976710717"
    ],
    "source": "virtual_terminal",
    "token_request_status": "Completed"
  }
}

{
  "event_id": "237a6b9e-a9ad-45f5-875d-6b9baff2dd72",
  "event_type": "networktoken.token.create",
  "event_body": {
    "merchant": {
      "id": "1"
    },
    "vault_ids": [
      "328402112"
    ],
    "token_request_status": "Completed"
  }
}

{
  "event_id": "e2e9ffa3-75fc-4864-a14f-6aad9f199908",
  "event_type": "networktoken.token.create",
  "event_body": {
    "merchant": {
      "id": "1"
    },
    "recurring_ids": [
      "281474976710715"
    ],
    "token_request_status": "Completed"
  }
}

Token Refresh

Just like with regular credit card numbers, network tokens have an expiration date and are refreshed by the card issuers before they expire. The gateway will be notified in real time when these refreshes occur and will update the stored token for cards stored in the Customer Vault or in recurring subscriptions.

The webhook body will indicate which relevant vault IDs or recurring IDs are related to this token.

{
  "event_id": "235f028e-159d-452a-aae4-dbe35315ab84",
  "event_type": "networktoken.token.refresh",
  "event_body": {
    "merchant": {
      "id": "1"
    },
    "vault_ids": [
      "1480180208"
    ],
    "recurring_ids": [
      "281474976710743",
      "281474976710744"
    ]
  }
}