CardSwitcher

CARD_UPDATING

Triggered when a card update in a merchant begins.

Request example

{
  "event": "CARD_UPDATING",
  "session_id": "fb5aa994-ed1c-4c3e-b29a-b2a53222e584",
  "task_id": 25605,
  "external_user_id": "3dcbb19a-b2f1-4a7b-8792-d76027b627b3",
  "merchant": {
    "id": 11,
    "name": "Uber"
  },
  "data": {
    "card_id": "123456789"
  },
  "timestamp": 1710864923198
}

CARD_UPDATED

Triggered when a card is successfully updated in a merchant.

Request example

{
  "event": "CARD_UPDATED",
  "session_id": "fb5aa994-ed1c-4c3e-b29a-b2a53222e584",
  "task_id": 25605,
  "external_user_id": "3dcbb19a-b2f1-4a7b-8792-d76027b627b3",
  "merchant": {
    "id": 11,
    "name": "Uber"
  },
  "data": {
    "card_id": "123456789"
  },
  "timestamp": 1710864923198
}

CARD_FAILED

Triggered when a card failed to be updated in a merchant account. The reason is specified in the reason field.

Request example

{
  "event": "CARD_FAILED",
  "session_id": "fb5aa994-ed1c-4c3e-b29a-b2a53222e584",
  "task_id": 25605,
  "external_user_id": "3dcbb19a-b2f1-4a7b-8792-d76027b627b3",
  "merchant": {
    "id": 11,
    "name": "Uber"
  },
  "data": {
    "card_id": "123456789",
    "reason": "card cvv"
  },
  "timestamp": 1710864923198
}

Failure reasons:

`reason`	Description
`account`	The user's merchant account has an issue (e.g. a foreign account).
`card`	The user's card information has an issue (e.g. incorrect phone #, incorrect billing address, unsupported card type, etc.).
`card expired`	The user's card is expired.
`insufficient funds`	The user's depository account associated with their card does not have sufficient funds to cover the pre-authorization hold from the merchant.
`subscription`	The user's merchant account does not have an active subscription.
`subscription admin`	The user is not have the necessary authorization to update the payment method in the merchant account.
`third-party payment method on subscription`	The user pays for the merchant's service through a 3rd party merchant account (e.g. Spotify through Hulu)
`too close to end of billing cycle`	The user's billing cycle date is too close.
`too many attempts`	The user attempted to enter their login credentials (e.g. username, password, OTP) to the merchant account too many times.
`credentials`	The user entered incorrect credentials when logging in to the merchant.
`otp`	The user entered an incorrect OTP code when logging in to the merchant.
`credentials timeout`	The user did not enter their login credentials to the merchant account in a certain period of time.
`otp timeout`	The user did not enter their otp code to the merchant account in a certain period of time.
`questions timeout`	The user did not enter the answers to the security questions for the merchant account in a certain period of time.
`zip timeout`	The user did not enter their zip code associated with their merchant account in a certain period of time.
`session not authenticated`	Knot could not authenticate to the user's merchant account.
`did not receive payment method information`	Knot did not receive any card information.
`could not handle payment method information`	Knot encountered an error handling the user's card information once received.
`could not retrieve payment method information`	Knot was unsuccessful in retrieving payment method information from Unit.
`other`	Another issue with the card switch was encountered.