COMING SOON
The Card Alert object represents an alert that has been defined for an issued card. For example, an alert can be sent when a transaction occurs, when a payment is made, or if someone attempts to use the card with an incorrect PIN.
The status attribute defines whether the alert is currently active for the card.
financialAccountId
string (UUID)
ID of the integrated Financial Account linked to the issued card.
useEmail
boolean
Whether to send alerts by email. If set to true, email is required.
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
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:
merchantCategoryCodes
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
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:
amount
string
Threshold amount. Example: 100.99.
notifyOption
string enum, values: PARENT_CARD, CHILD_CARD, ALL
default value: PARENT_CARD
Recipient of the alert. The following values are supported:
id
string (UUID)
ID of the alert.
createdBy
object
Entity that created the card alert.
id
string (UUID)
ID of the entity. Will be blank if createdBy.type is internal.
type
string enum, values: employee, service-account, internal
Type of entity. The following values are supported:
createdAt
string (date-time), format: yyyy-MM-dd’T’HH:mm:ss.SSSz
Date and time the alert was created in the RocketKOR system.
active
boolean, default: true
Whether the alert is active.
Card Alert Object
{
"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
}
© 2022 Rocket Financial. All rights reserved. RocketFNCL, RocketKOR, RocketBNK are trade names of Rocket Financial Inc.
Services Agreement | Privacy Policy | RocketFNCL | © 2023 by Rocket Financial Inc. All rights reserved.
Services Agreement | Privacy Policy | RocketFNCL | © 2023 by Rocket Financial Inc. All rights reserved.
Services Agreement | Privacy Policy | RocketFNCL
© 2023 by Rocket Financial Inc. All rights reserved.