Payments
Real-time Account Updater

Subscribe a card for real-time account updates

Changed on

Provide an Evervault encrypted or plaintext card number and expiry, and Evervault registers the card with the card networks. When an issuer pushes an update, Evervault delivers a real-time.card.updated webhook.

Only Visa and Mastercard cards are supported. A card of any other brand is rejected with a 400 status code before the subscription is created.

The response confirms the subscription only; it doesn't return card details. Every update, including one for a card that's already outdated at subscribe time, arrives via webhook. The plaintext card number is never stored or returned.

post/payments/cards/subscriptions

Request

Request body

Example request

{
  "card": {
    "number": "ev:debug:Tk9D:number:nTepvAI585M7lUVp:AkJ6Brzat0E7ui8DSKCSXO7AopU/+GFuBekQ6cGx7eTl:sfihK53itmHp+URxomnTITUpwQwM5nnRrnQ0qdIOUlA=:$",
    "expiry": {
      "month": "12",
      "year": "29"
    }
  }
}

Response

The subscription was created.

idstring required

The unique identifier for the subscription.

status'active' | 'canceled' required

The status of the subscription.

createdAtinteger required

The time the subscription was created, in milliseconds since the Unix epoch.

Example response

{
  "id": "aus_8da9a7fbde01",
  "status": "active",
  "createdAt": 1709293284000
}

Changes