COMING SOON

Update, Activate, or Deactivate a Card Alert

Update an alert that has been created for an issued card. You can also use this API to activate or deactivate an alert.

To update an alert, you will need:

ID of the alert

Endpoint

PUT /v1/alerts/{id}

Authorization Header

Authorization: Bearer <access_token>

Path Parameters

id REQUIRED

string (UUID)

ID of the alert.

Request Body

financialAccountId

string (UUID)

ID of the integrated Financial Account. The issued card is linked to this Financial Account.

useEmail

boolean

Whether to send alerts by email. If set to true, email is mandatory.

email CONDITIONAL

string (email)

Email address to which alerts are sent. Required if useEmail is set to true.

useContactNumber

boolean

Whether to send SMS alerts. If set to true, mobileContactNumber is mandatory.

mobileContactNumber CONDITIONAL

string, max length: 60

Phone number to which SMS alerts are sent. Required if useContactNumber is set to true.

type

string enum, values: BALANCE_THRESHOLD, DEBIT_TRANSACTION_POSTED, CREDIT_TRANSACTION_POSTED, BILL_PAYMENT, MCC, WRONG_PIN_ATTEMPT, INSUFFICIENT_FUNDS, PROMO

Type of alert. The following values are supported:

BALANCE_THRESHOLD Card balance threshold.
DEBIT_TRANSACTION_POSTED A debit transaction has been posted.
CREDIT_TRANSACTION_POSTED A credit transaction has been posted.
BILL_PAYMENT A bill payment has been made.
MCC Alert for a specific Merchant Category Code (MCC).
WRONG_PIN_ATTEMPT An attempt has been made to use the card with the wrong PIN.
INSUFFICIENT_FUNDS Insufficient funds on the card account.
PROMO Promo code.

merchantCategoryCodes CONDITIONAL

array

List of Merchant Category Codes (MCCs) that will trigger the alert. Mandatory if type is set to MCC. A maximum of 20 MCC values are allowed.

threshold CONDITIONAL

object

Threshold that will trigger the alert. Required if type is set to BALANCE_THRESHOLD.

type

string enum, values: GREATER_THAN_OR_EQUALS_TO, LOWER_THAN_OR_EQUALS_TO

Type of threshold. The following values are supported:

GREATER_THAN_OR_EQUALS_TO Greater than or equal to.
LOWER_THAN_OR_EQUALS_TO Lower than or equal to.

amount

string

Threshold amount. Example: 100.99.

notifyOption

string enum, values: PARENT_CARD, CHILD_CARD, ALL, default: PARENT_CARD

Recipient of the alert. The following values are supported:

PARENT_CARD Parent card.
CHILD_CARD Child card.
ALL Both the parent and child card.

active

boolean, default: true

Whether the alert is active.

Returns

Returns the Card Alert object. This object contains the alert details.

SAMPLE REQUEST

				
					{
  "mobileContactNumber": "2821234567"
}

SAMPLE RESPONSE

				
					{
  "financialAccountId": "7d08a89d-2ac5-4ed3-a6ca-ad7c974c994e",
  "useEmail": true,
  "email": "user@example.com",
  "useContactNumber": true,
  "mobileContactNumber": "2821234567",
  "type": "CREDIT_TRANSACTION_POSTED",
  "merchantCategoryCodes": [
    "6530"
  ],
  "threshold": {
    "type": "GREATER_THAN_OR_EQUALS_TO",
    "amount": "100.99"
  },
  "notifyOption": "PARENT_CARD",
  "id": "9671d896-ec04-4796-9864-0d165a5dda83",
  "createdAt": "2023-02-13T02:04:19.161Z",
  "active": true
}