Skip to content

Card state change
Webhook

Request

Notification that a card has changed state. The following events trigger a notification:

  • Activate a physical card.
  • Remove a managed card.
  • Report a physical card as lost.
  • Report a physical card as stolen.
  • Mark a virtual card as compromised.
  • Card has expired.
  • Block a managed card.
  • Unblock a managed card.
  • Update card renewal type.

Please note that since a card can have multiple blocks, an unblock event (for which a notification is sent) may not always result in the card state being updated to Active.

Headers
call-refstring

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

published-timestampinteger, (int64)required

The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.

signaturestringrequireddeprecated

The signature to verify the authenticity of this request. This is the base64 hash (HmacSHA256) of the published-timestamp using your API key.

signature-v2stringrequired

The signature to verify the authenticity of this request. This is the base64 hash (HmacSHA256) of the call-ref + payload + published-timestamp using your API key.

Bodyapplication/jsonrequired
idobject(InstrumentId)required
timestampstring^[0-9]+$required

The timestamp of the state change, using epoch timestamp with millisecond precision.

eventTypestring(StateChangeEventType)required
Enum:"ENABLED""ACTIVATED""BLOCKED""UNBLOCKED""DESTROYED"
stateobject(StateChangeState)
cardTypestring(CardType)required
Enum:"VIRTUAL""PHYSICAL"
renewalTypestring(CardRenewalType)required

Indicates how the card will be handled once it is close to expiring.

  • RENEW: The card will be automatically renewed, keeping the same card number but with a new expiry date and CVV.
  • NO_RENEW: Once the expiry date is reached, the card is destroyed.
Enum:"RENEW""NO_RENEW"
Payload
{
  "id": {
    "id": "string",
    "type": "managed_cards"
  },
  "timestamp": "string",
  "eventType": "ENABLED",
  "state": {
    "state": "ACTIVE",
    "blockedReason": "USER",
    "destroyedReason": "SYSTEM"
  },
  "cardType": "VIRTUAL",
  "renewalType": "RENEW"
}

Responses

Success - No Content