COMING SOON

Create a Card Alert

Create an alert for an issued card and define when the alert should be sent to the Customer.

To create an alert for a card, you will need:

ID of the integrated Financial Account linked to the issued card
Alert destination (email address or mobile number)
Alert type
Alert recipient (parent card, child card, or both)

Endpoint

POST /v1/integrated-cards/{financialAccountId}/alerts

Authorization Header

Authorization: Bearer <access_token>

Path Parameters

financialAccountId REQUIRED

string (UUID)

ID of the integrated Financial Account linked to the issued card.

Request Body

financialAccountId

string (UUID)

This parameter has been deprecated in favor of the financialAccountId path parameter.

useEmail

boolean

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

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 required.

mobileContactNumber CONDITIONAL

string, max length: 60

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

type REQUIRED

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. Required if type is not set to PROMO. 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 REQUIRED

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 REQUIRED

string

Threshold amount. Example: 100.99.

notifyOption REQUIRED

string enum, values: PARENT_CARD, CHILD_CARD, ALL

default value: 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

				
					{
  "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",
  "active": true
}

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",
  "createdBy": {
    "id": "6a545f07-cefa-47ad-bede-9489ac1b65fd",
    "type": "service-account"
  },
  "createdAt": "2023-02-13T02:04:19.161Z",
  "active": true
}