Payments
Real-time Account Updater

Simulate an Account Updater Subscription update

Simulate an asynchronous update for a subscribed card so you can test your webhook integration without waiting for a real push from the card networks. First subscribe a card using the test card 4242424242424242, then call this endpoint with the type of update you want to simulate.

Evervault delivers a real-time.card.updated webhook to your registered endpoint, identical to a production push. The card networks only push a subset of results asynchronously, so this endpoint accepts only the update types that can arrive over a webhook.

Updates can only be simulated for a subscription to 4242424242424242. A new-account-number update returns 4111111111111111 as the replacement card, as an Evervault encrypted string.

This endpoint is only available to Sandbox apps.

post/payments/cards/subscriptions/{subscription_id}/simulate

Request

Path parameters

subscription_idstring required

The identifier of the subscription to simulate an update for.

Request body

type'new-account-number' | 'new-expiry-date' | 'account-closed' required

The update to simulate. Accepts only the updates the card networks push asynchronously.

Example request

{
  "type": "new-expiry-date"
}

Response

The simulated update was accepted and a real-time.card.updated webhook will be delivered to your registered endpoint. The body describes the update that was dispatched.

subscriptionstring required

The identifier of the subscription this update belongs to.

result'new-account-number' | 'new-expiry-date' | 'account-closed' required

The type of update pushed by the card networks. Push updates fire only when there is an actual change, so no-change, no-match, contact-cardholder, and opt-out results never appear here.

Example response

{
  "subscription": "aus_8da9a7fbde01",
  "result": "new-account-number",
  "update": {
    "card": {
      "number": "ev:debug:Tk9D:number:nTepvAI585M7lUVp:AkJ6Brzat0E7ui8DSKCSXO7AopU/+GFuBekQ6cGx7eTl:sfihK53itmHp+URxomnTITUpwQwM5nnRrnQ0qdIOUlA=:$",
      "expiry": {
        "month": "12",
        "year": "29"
      }
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.