Payments
Card Account Updates

Simulate a Card Update

Simulates an update to a Card so that you can test your Card Account Updater integration. This endpoint is only available for Sandbox Apps.

post/payments/cards/{card_id}/simulate

Request

Path parameters

card_idstring required

The id of the Card

Request body

OR
OR

Example request

{
  "expiry": {
    "month": "12",
    "year": "29"
  },
  "number": "4242424242424242",
  "externalCustomerReference": "00-4bf92f3577b34da6a3ce929d3e0e4736-00f067aa0ba902b7-01"
}

Response

Returns the updated Card object.

idstring

The unique identifier for the card.

numberstring required

The Evervault encrypted card number. This can be decrypted using Relay decryption or using a function.

binstring required

The first 6 or 8 digits of the card number.

lastFourstring required

The last 4 digits of the card number.

brand'visa' | 'mastercard' | 'american-express' | 'discover' | 'diners-club' | 'jcb' | 'unionpay'

The card brand associated with the payment card.

funding'debit' | 'credit' | 'prepaid' | 'deferred-debit' | 'charge'

The card funding type specifies the method by which transactions are financed.

segment'consumer' | 'commercial' | 'business' | 'government' | 'payouts' | 'all'

The card segment indicates the primary market or usage category of the card.

countrystring iso-3166-1-alpha-2

The country where the card was issued.

currencystring iso-4217-alphabetic

The currency of the card.

issuerstring

The name of the card issuer.

status'active' | 'replaced' | 'closed' | 'invalid'

The current status of the card.

replacementstring nullable

The ID of the replacement card. This field is only present if the card has been replaced.

automaticUpdates'enabled' | 'issuer-not-enrolled' | 'disabled'

The status of Card Account Updater on this card. Evervault currently supports Card Account Updates for Visa, Mastercard and American Express cards.

createdAtinteger required

The Unix timestamp of when the card was created.

updatedAtinteger nullable

The Unix timestamp of when the card was last updated.

Example response

{
  "id": "card_eead1d640d7c",
  "number": "ev:debug:Tk9D:number:nTepvAI585M7lUVp:AkJ6Brzat0E7ui8DSKCSXO7AopU/+GFuBekQ6cGx7eTl:sfihK53itmHp+URxomnTITUpwQwM5nnRrnQ0qdIOUlA=:$",
  "expiry": {
    "month": "9",
    "year": "26"
  },
  "bin": "424242",
  "lastFour": "4242",
  "brand": "visa",
  "funding": "credit",
  "segment": "consumer",
  "country": "gb",
  "currency": "gbp",
  "issuer": "Gringotts Wizarding Bank and Trust Company",
  "status": "active",
  "replacement": null,
  "automaticUpdates": "enabled",
  "createdAt": 169297262323,
  "updatedAt": null
}

Changes

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