Card
Card product
CARD_PRODUCT_CHANGED
The card API triggers the CARD_PRODUCT_CHANGED notification when a card product is created, activated, updated, or settings changed.
Event parameters are eventTypeCode/routing_code:
ext.cards.products.changed.
{
"notificationId": "ID-9999",
"notificationTypeCode": "CARD_PRODUCT_CHANGED",
"destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
"originalMessageDateTime": "2024-07-17T13:29:07.768Z",
"data": {
"accountOwnerTypeCode": "PRIVATE",
"applicationStatusCode": "WAITING",
"bin": "483312",
"binAdditional": "12",
"cardDeliveryMethod": "POST",
"cardVendorId": "11",
"creditTypeCode": "REVOLVING_MONTHLY",
"currencyCode": "EUR",
"defaultExpiryMonths": 5,
"additionalCardAllowed": true,
"avsRequired": true,
"cardAccount": true,
"closedLoop": true,
"renewable": true,
"replaceable": true,
"usableBeforeDelivery": true,
"xpaysAllowed": true,
"issuingCountryCode": "EE",
"orderPlasticAutomatically": true,
"panLength": 16,
"panNumberRange": {
"startValue": 0,
"endValue": 0
},
"panServiceCode": "201",
"pinDeliveryMethod": "DIGIPIN",
"productClass": "DEBIT",
"productCode": "PRODUCT-1",
"productName": "Example product",
"productScheme": "MASTERCARD",
"productType": "PHYSICAL",
"profileId": "ID-1",
"reportingProductCode": "CCP001",
"settlementCurrencyCode": "EUR",
"statusCode": "ACTIVE",
"tenantCode": "TUUM.BRANCH1",
"tokenisationAuthenticationRequired": true,
"design": {
"defaultDesignId": "ID1",
"allowedDesignIds": [
"string"
]
},
"pricing": {
"defaultPriceListCode": "DEFAULT-PRICE-1",
"allowedPriceListCodes": [
"string"
]
},
"limitGroups": {
"upperGroupName": "GROUP1",
"defaultGroupName": "string",
"allowedGroupNames": [
"string"
]
},
"usageGroups": {
"upperGroupName": "GROUP1",
"defaultGroupName": "string",
"allowedGroupNames": [
"string"
]
},
"mccGroups": {
"defaultGroupName": "MCC_GROUP",
"allowedGroupNames": [
"string"
]
},
"panStockWarningThreshold": 0,
"panThresholdReached": true
}
}CARD_PRODUCT_PAN_STOCK_DEPLETED
The card API triggers the CARD_PRODUCT_PAN_STOCK_DEPLETED notification when PAN stock exceeds the threshold.
Event parameters are eventTypeCode/routing_code:
ext.cards.products.pan-stock.depleted.
{
"notificationId": "ID-9999",
"notificationTypeCode": "CARD_PRODUCT_PAN_STOCK_DEPLETED",
"destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
"originalMessageDateTime": "2024-07-17T13:34:39.059Z",
"data": {
"accountOwnerTypeCode": "PRIVATE",
"applicationStatusCode": "WAITING",
"bin": "483312",
"binAdditional": "12",
"cardDeliveryMethod": "POST",
"cardVendorId": "11",
"creditTypeCode": "REVOLVING_MONTHLY",
"currencyCode": "EUR",
"defaultExpiryMonths": 5,
"additionalCardAllowed": true,
"avsRequired": true,
"cardAccount": true,
"closedLoop": true,
"renewable": true,
"replaceable": true,
"usableBeforeDelivery": true,
"xpaysAllowed": true,
"issuingCountryCode": "EE",
"orderPlasticAutomatically": true,
"panLength": 16,
"panNumberRange": {
"startValue": 0,
"endValue": 0
},
"panServiceCode": "201",
"pinDeliveryMethod": "DIGIPIN",
"productClass": "DEBIT",
"productCode": "PRODUCT-1",
"productName": "Example product",
"productScheme": "MASTERCARD",
"productType": "PHYSICAL",
"profileId": "ID-1",
"reportingProductCode": "CCP001",
"settlementCurrencyCode": "EUR",
"statusCode": "ACTIVE",
"tenantCode": "TUUM.BRANCH1",
"tokenisationAuthenticationRequired": true,
"design": {
"defaultDesignId": "ID1",
"allowedDesignIds": [
"string"
]
},
"pricing": {
"defaultPriceListCode": "DEFAULT-PRICE-1",
"allowedPriceListCodes": [
"string"
]
},
"limitGroups": {
"upperGroupName": "GROUP1",
"defaultGroupName": "string",
"allowedGroupNames": [
"string"
]
},
"usageGroups": {
"upperGroupName": "GROUP1",
"defaultGroupName": "string",
"allowedGroupNames": [
"string"
]
},
"mccGroups": {
"defaultGroupName": "MCC_GROUP",
"allowedGroupNames": [
"string"
]
},
"panStockWarningThreshold": 0,
"panThresholdReached": true
}
}Card management
CARD_CHANGED
The card API triggers the CARD_CHANGED notification when a card is created, renewed, or settings changed.
Event parameters are eventTypeCode/routing_code:
ext.cards.cards.changed.
{
"notificationId": "ID-9999",
"notificationTypeCode": "CARD_CHANGED",
"destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
"data": {
"activationDate": "2023-07-21",
"cardId": "string",
"panReference": "string",
"changedByUserId": "string",
"changedByUsername": "string",
"changedTime": "2023-07-21T07:58:57.639Z",
"contactlessAllowed": true,
"designCode": "string",
"oldCardId": "string",
"personId": "string",
"productClass": "string",
"productCode": "string",
"statusChangeReasonCode": "string",
"statusCode": "string",
"tokenisationAuthenticationRequired": true,
"xpaysAllowed": true
}
}CARD_RENEWAL_CREATED
The card API triggers the CARD_RENEWAL_CREATED notification when a card renewal event has been created.
Event parameters are eventTypeCode/routing_code:
ext.cards.card-renewals.created.
{
"notificationId": "ID-9999",
"notificationTypeCode": "CARD_RENEWAL_CREATED",
"destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
"data": {
"cardRenewalId": "C000000100001",
"cardId": "C000000100008",
"productCode": "VISA_STUDENT",
"productScheme": "VISA",
"productClass": "DEBIT",
"productType": "STANDARD",
"accountId": "C000000100008",
"personId": "ID-1000",
"statusCode": "ACTIVE",
"expiryDate": "2023-07-21",
"designCode": "Design_1",
"mainCardId": "C000000100001",
"accountOwnerPersonId": "ID-1000",
"countryCode": "EE",
"addressId": "C000000100001",
"cardDeliveryMethod": "POST",
"tenantCode": "TUUM",
"hasTransactions": true
}
}MASTERCARD_TOKEN_ACTIVATION_CODE_DELIVERED
The mastercard API triggers the MASTERCARD_TOKEN_ACTIVATION_CODE_DELIVERED notification when it receives the Mastercard-generated Activation Code from the MDES deliverActivationCode API.
Event parameters are eventTypeCode/routing_code:
ext.mastercard.token-activation-codes.delivered.
Card operations
CARD_AUTHORISATION_CREATED
The card API triggers the CARD_AUTHORISATION_CREATED notification with authorisation information (positive or negative outcome) when the card transaction receives the response to the authorisation request.
Event parameters are eventTypeCode/routing_code:
ext.cards. authorisations.created.
CARD_RESERVATION_RESERVED
The card API triggers the CARD_RESERVATION_RESERVED notification when it creates a new card reservation.
Event parameters are eventTypeCode/routing_code:
ext.cards.reservations.reserved.
CARD_ACCOUNT_TRANSACTION_CREATED
The card API triggers the CARD_ACCOUNT_TRANSACTION_CREATED notification when the card account balance changes.
Event parameters are eventTypeCode/routing_code:
ext.cards.accounts.transactions.
CARD_INVOICE_CREATED
The card API triggers the CARD_INVOICE_CREATED notification when it creates a new invoice with receivable lines and card contract details.
Event parameters are eventTypeCode/routing_code:
ext.cards.receivables.receivable.created.
CARD_RECEIVABLE_BALANCE_CHANGED
The card API triggers the CARD_RECEIVABLE_BALANCE_CHANGED notification when the balance of an invoice (invoice line) changes or a credit note is created.
Event parameters are eventTypeCode/routing_code:
ext.cards.receivables.receivable-balances.changed.
CARD_REPAYMENT_CONFIRMED
The card API triggers the CARD_REPAYMENT_CONFIRMED notification when repayment is allocated to an invoice at card credit contract.
Event parameters are eventTypeCode/routing_code:
ext.cards.receivables.cash-events.repayments.confirmed.
Card credit offer
CARD_CREDIT_OFFER_ACCEPTED
The card API triggers the CARD_CREDIT_OFFER_ACCEPTED event when a customer accepts a credit card offer, and the offer status is set to
ACCEPTED.Event parameters are eventTypeCode/routing_code:
ext.cards.offers.accepted.
CARD_CREDIT_OFFER_CHANGED
The card API triggers the CARD_CREDIT_OFFER_CHANGED event when a credit card offer is changed, and the offer status is set to
PRESENTED.Event parameters are eventTypeCode/routing_code:
ext.cards.offers.changed.
CARD_CREDIT_OFFER_CANCELLED
The card API triggers the CARD_CREDIT_OFFER_CANCELLED event when a bank cancels a credit card offer, and the offer status is set to
CANCELLED.Event parameters are eventTypeCode/routing_code:
ext.cards.offers.cancelled.
CARD_CREDIT_OFFER_DECLINED
The card API triggers CARD_CREDIT_OFFER_DECLINED event when a customer declines a credit card offer, and the offer status is set to
DECLINED.Event parameters are eventTypeCode/routing_code:
ext.cards.offers.changed.
Credit card contract
CARD_CREDIT_CONTRACT_ACTIVATED
The card API triggers CARD_CREDIT_CONTRACT_ACTIVATED notification when the card credit contract is activated, and the contract version status is set to
ACTIVE.Event parameters are eventTypeCode/routing_code:
ext.cards.credit-contracts.activated.
CARD_CREDIT_CONTRACT_VERSION_ACTIVATED
The card API triggers the CARD_CREDIT_CONTRACT_VERSION_ACTIVATED notification when the credit contract status is changed from
BLOCKEDtoACTIVE.Event parameters are eventTypeCode/routing_code:
ext.cards.credit-contracts.version-activated.
CARD_CREDIT_CONTRACT_BLOCKED
The card API triggers CARD_CREDIT_CONTRACT_BLOCKED notification when the card credit contract status is set to
BLOCKED.Event parameters are eventTypeCode/routing_code:
ext.cards.credit-contracts.blocked.
CARD_CREDIT_CONTRACT_CLOSED
The card API triggers CARD_CREDIT_CONTRACT_CLOSED notification when the card credit contract status is set to
CLOSED.Event parameters are eventTypeCode/routing_code:
ext.cards.contracts.closed.
CREDIT_CARD_CONTRACT_DEFAULTED
The card API triggers CARD_CREDIT_CONTRACT_DEFAULTED notification when the card credit contract status is set to
DEFAULTED.Event parameters are eventTypeCode/routing_code:
ext.cards.credit-contracts.defaulted.
Card clearing
CARD_CLEARING_SECOND_PRESENTMENT_RECEIVED
CARD_CLEARING_SECOND_PRESENTMENT_RECEIVED notification when it receives a second presentment message within clearing data, and corrective actions will be performed automatically.
Event parameters are eventTypeCode/routing_code:
cards.clearings.second-presentment.received.
CARD_CLEARING_TOTALS_RECEIVED
The card API triggers the CARD_CLEARING_TOTALS_RECEIVED notification when it receives clearing totals within clearing data.
Event parameters are eventTypeCode/routing_code:
ext.cards.clearing-totals.loaded.
CARD_CLEARING_TRANSACTION_COMPLETED
The card API triggers the CARD_CLEARING_TRANSACTION_COMPLETED notification when it receives a clearing transaction and successfully processes it, setting the transaction status_code to
C.Event parameters are eventTypeCode/routing_code:
ext.cards.clearings.transactions.completed.
CARD_CLEARING_TRANSACTION_UNMATCHED
The card API triggers the CARD_CLEARING_TRANSACTION_UNMATCHED notification when it receives a clearing transaction and successfully processes it, setting the transaction status_code to
PROCESSED.Event parameters are eventTypeCode/routing_code:
ext.cards.clearings.transactions.unmatched.
CARD_CLEARING_TRANSACTION_ERROR
The card API triggers the CARD_CLEARING_TRANSACTION_ERROR notification when it receives a clearing transaction and successfully processes it, setting the transaction status_code to
E.Event parameters are eventTypeCode/routing_code:
ext.cards.clearings.transactions.error.
CARD_CHARGEBACK_RECEIVED
The card API triggers the CARD_CHARGEBACK_RECEIVED notification when it receives a chargeback request within clearing data, and the chargeback will be processed automatically.
Event parameters are eventTypeCode/routing_code: ext.cards.chargebacks.received.
Last updated
Was this helpful?