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_DIGITIZATION_REQUESTED
{
"notificationId": "ID-9999",
"notificationTypeCode": "MASTERCARD_DIGITIZATION_REQUESTED",
"destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
"originalMessageDateTime": "2024-10-18T12:57:22.121Z",
"data": {
"cardId": "C000000100008",
"tokenType": "CLOUD",
"walletId": "123",
"tokenRequestorId": "12345678888",
"decision": "APPROVED",
"tokenId": "MC001718024102",
"token": "512345******5026",
"tokenUniqueReference": "DWSPMC000000000132d72d4fcb2f4136a0532d3093ff1a46",
"tokenExpiry": "2405",
"activationMethods": [
{
"type": "TEXT_TO_CARDHOLDER_NUMBER",
"value": "+3*******05"
}
]
}
}MASTERCARD_TOKEN_UPDATED
{
"notificationId": "ID-9999",
"notificationTypeCode": "MASTERCARD_TOKEN_UPDATED",
"destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
"originalMessageDateTime": "2024-10-18T12:54:35.283Z",
"data": {
"tokenId": "string",
"cardId": "string",
"token": "string",
"tokenUniqueReference": "string",
"tokenExpiry": "string",
"tokenType": "string",
"walletId": "string",
"deviceName": "string",
"tokenRequestorId": "string",
"status": "string",
"reasonCode": "string",
"suspendedBy": "string"
}
}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.
{
"notificationId": "ID-9999",
"notificationTypeCode": "MASTERCARD_TOKEN_ACTIVATION_CODE_DELIVERED",
"destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
"data": {
"cardId": "C000000100008",
"activationCode": "A1B2C3D4",
"expirationDateTime": "2023-07-21T08:51:44.867Z",
"activationMethodType": "TEXT_TO_CARDHOLDER_NUMBER",
"activationMethodValue": "+372555555",
"reasonCodes": [
"string"
],
"consumerFacingEntityName": "My Merchant",
"walletId": "123",
"correlationId": "D98765432104"
}
}MASTERCARD_TOKEN_SERVICE_ACTIVATED
{
"notificationId": "ID-9999",
"notificationTypeCode": "MASTERCARD_TOKEN_SERVICE_ACTIVATED",
"destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
"originalMessageDateTime": "2024-10-18T12:59:34.847Z",
"data": {
"tokenId": "string",
"cardId": "string",
"token": "string",
"tokenUniqueReference": "string",
"tokenExpiry": "string",
"tokenType": "string",
"walletId": "string",
"deviceName": "string",
"tokenRequestorId": "string"
}
}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.
{
"notificationId": "ID-9999",
"notificationTypeCode": "CARD_AUTHORISATION_CREATED",
"destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
"data": {
"transactionId": "string",
"messageType": "string",
"transactionTypeCode": "string",
"accountOwnerPersonId": "string",
"cardholderPersonId": "string",
"cardAcceptorNameLocation": "string",
"purchaseCountryCode": "string",
"posData": "string",
"merchantCategoryCode": "string",
"transactionMoney": {
"amount": 0,
"currencyCode": "str"
},
"dateLocal": "string",
"authorisationTime": "2023-07-21T11:47:17.169Z",
"actionCode": "string",
"cardId": "string",
"panReference": "string"
}
}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.
{
"notificationId": "ID-9999",
"notificationTypeCode": "CARD_RESERVATION_RESERVED",
"destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
"originalMessageDateTime": "2024-07-17T13:47:04.337Z",
"data": {
"reservationId": "C000000001000",
"accountId": "C000000100008",
"directionCode": "OUT",
"amount": {
"amount": 1.22,
"currencyCode": "EUR"
},
"source": {
"sourceName": "PAYMENT",
"sourceRef": "ID-181922"
},
"details": "string",
"merchantInfo": "string",
"additionalInfo": "string",
"reservedTime": "2024-07-17T13:47:04.337Z"
}
}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.
{
"notificationId": "ID-9999",
"notificationTypeCode": "CARD_ACCOUNT_TRANSACTION_CREATED",
"destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
"data": {
"accountGroupCode": "CREDIT",
"accountId": "C000000100008",
"accountTransactionId": "C000000100010",
"accountTypeCode": "CREDIT1",
"additionalInfo": "string",
"amount": {
"amount": 0,
"currencyCode": "str"
},
"componentTypeCode": "string",
"contractSource": {
"sourceName": "string",
"sourceRef": "string",
"sourceLink": "string",
"contractNumber": "string"
},
"counterpartyAccountId": "ID-1000",
"counterpartyBic": "string",
"counterpartyIban": "string",
"counterpartyName": "Dan Ficher",
"countryCode": "EE",
"details": "Details",
"directionCode": "IN",
"groupId": "ID-3000",
"initialBalanceAmount": {
"amount": 10,
"currencyCode": "EUR"
},
"merchantInfo": "string",
"originalDTime": "2020-04-06T14:11:16+01:00",
"postingDate": "2021-05-31",
"productClass": "DEBIT",
"productScheme": "MASTERCARD",
"reportingProductCode": "CCP001",
"reversal": true,
"source": {
"sourceName": "string",
"sourceRef": "string",
"sourceLink": "string"
},
"tenantCode": "TUUM",
"transactionDTime": "2021-05-31T14:11:16Z",
"transactionTypeCode": "CARD_PUR",
"valueDate": "2020-12-21"
}
}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.
{
"notificationId": "ID-9999",
"notificationTypeCode": "CARD_INVOICE_CREATED",
"destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
"data": {
"invoiceHeader": {
"productType": "LOAN_PRODUCT_01",
"contractId": "ID-1000",
"contractNumber": "KWR1044",
"invoiceId": "ID-1000",
"invoiceType": "PERIODIC",
"invoiceNumber": "R000000001105",
"invoiceReason": "PERIODIC",
"language": "en",
"billingDate": "2021-04-30",
"dueDate": "2021-05-21",
"billingPeriodRange": {
"startDate": "2023-07-21",
"endDate": "2023-07-21"
},
"interestPeriodRange": {
"startDate": "2023-07-21",
"endDate": "2023-07-21"
},
"monthlyRepaymentMoney": {
"amount": 0,
"currencyCode": "str"
},
"generationDtime": "2021-02-23T08:32:33.0759819Z",
"additionalData": {
"paymentFreeMonths": [
"FEBRUARY",
"JULY"
]
}
},
"receiverInfo": {
"personId": "ID-1000",
"idNumber": "38802020176",
"givenName": "Markko",
"middleName": "Lee",
"surname": "Martin",
"companyName": "Modular Finance OU",
"deliveryMethodCode": "POST",
"email": "customer@gmail.com",
"phoneNumber": "+3721234123",
"addressInfo": [
{
"addressTypeCode": "R for Registration, C for Contact",
"street1": "Villardi 4-5",
"street2": "Kassisaba",
"cityCounty": "Tallinn",
"stateRegion": "Harjumaa",
"zip": "10136",
"countryCode": "EE"
}
],
"additionalData": {
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
}
},
"paymentInfo": {
"referenceNumber": "00001234561",
"paymentMoney": {
"amount": 0,
"currencyCode": "str"
}
},
"lines": [
{
"lineGroupCode": "INVOICE_LINE",
"lineTypeCode": "PRI",
"lineSubtypeCode": "INTEREST_STATEMENT",
"lineText": "string",
"lineMoney": {
"amount": 0,
"currencyCode": "str"
},
"lineRate": {
"baseRate": -0.254,
"marginRate": 7.265,
"rate": 7.011,
"periodRange": {
"startDate": "2023-07-21",
"endDate": "2023-07-21"
},
"referenceRateType": "EURIBOR-3M"
},
"lineDate": "2021-04-30",
"additionalData": {
"dueInvoiceNumber": "INV-10000234"
}
}
]
}
}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.
{
"notificationId": "ID-9999",
"notificationTypeCode": "CARD_RECEIVABLE_BALANCE_CHANGED",
"destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
"originalMessageDateTime": "2024-07-17T13:37:25.869Z",
"data": {
"receivableId": "R000000001028",
"contractId": "ID-1643361137",
"receivableTypeCode": "PERIODIC",
"receivableNumber": "R000000001028",
"receivableReasonCode": "PERIODIC",
"billingDate": "2022-02-09",
"dueDate": "2022-02-09",
"paidDate": "2022-02-09",
"statusCode": "CREATED",
"receivableLines": [
{
"receivableLineId": "R000000001000",
"creditNoteReceivableId": "string",
"creditedReceivableLineId": "string",
"itemTypeCode": "COF",
"money": {
"amount": 1.22,
"currencyCode": "EUR"
},
"balanceMoney": {
"amount": 1.22,
"currencyCode": "EUR"
},
"debtMoney": {
"amount": 1.22,
"currencyCode": "EUR"
},
"debtStartDate": "2024-07-17",
"paidDate": "2024-07-17",
"source": {
"sourceName": "PAYMENT",
"sourceRef": "ID-181922"
}
}
]
}
}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.
{
"notificationId": "ID-9999",
"notificationTypeCode": "CARD_REPAYMENT_CONFIRMED",
"destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
"originalMessageDateTime": "2024-07-18T10:29:50.557Z",
"data": {
"receivableEventTypeCode": "PREMATURE_REPAYMENT",
"valueDate": "2024-07-18",
"postingDate": "2024-07-18",
"description": "string",
"money": {
"amount": 1.22,
"currencyCode": "EUR"
},
"cashEventId": "string",
"balanceDirectionCode": "string",
"source": {
"sourceName": "PAYMENT",
"sourceRef": "ID-181922"
},
"originalSource": {
"sourceName": "PAYMENT",
"sourceRef": "ID-181922"
},
"cash": {
"contractId": "string",
"referenceNumber": "string",
"cashId": "string",
"statusCode": "string",
"balanceAmount": {
"amount": 1.22,
"currencyCode": "EUR"
},
"source": {
"sourceName": "PAYMENT",
"sourceRef": "ID-181922"
},
"originalSource": {
"sourceName": "PAYMENT",
"sourceRef": "ID-181922"
},
"accountSource": {
"sourceName": "PAYMENT",
"sourceRef": "ID-181922"
},
"endToEndId": "string"
},
"receivableEvent": {
"receivableEventId": "string",
"receivableId": "string",
"receivableLineId": "string",
"itemTypeCode": "string"
}
}
}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.
{
"notificationId": "ID-9999",
"notificationTypeCode": "CARD_CREDIT_OFFER_ACCEPTED",
"destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
"originalMessageDateTime": "2024-07-17T10:24:26.217Z",
"data": {
"offerId": "C000000100018",
"cardApplicationId": "C00000000001",
"contractHeaderId": "C000000100001",
"contractVersionId": "C000000100001",
"creditTypeCode": "REVOLVING_MONTHLY",
"priceListCode": "STANDARD",
"offerTypeCode": "NEW_CREDIT",
"personId": "C000000100001",
"serviceAccount": {
"sourceName": "PAYMENT",
"sourceRef": "ID-181922"
},
"serviceAccountNumber": "MT99123456789012345678"
}
}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.
{
"notificationId": "ID-9999",
"notificationTypeCode": "CARD_CREDIT_OFFER_CHANGED",
"destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
"originalMessageDateTime": "2024-07-17T10:42:59.678Z",
"data": {
"offerId": "C000000100018",
"cardApplicationId": "C00000000001",
"contractHeaderId": "C000000100001",
"contractVersionId": "C000000100001",
"creditTypeCode": "REVOLVING_MONTHLY",
"priceListCode": "STANDARD",
"offerTypeCode": "NEW_CREDIT",
"personId": "C000000100001",
"serviceAccount": {
"sourceName": "PAYMENT",
"sourceRef": "ID-181922"
},
"serviceAccountNumber": "MT99123456789012345678"
}
}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.
{
"notificationId": "ID-9999",
"notificationTypeCode": "CARD_CREDIT_OFFER_CANCELLED",
"destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
"originalMessageDateTime": "2024-07-17T10:37:43.683Z",
"data": {
"offerId": "C000000100018",
"cardApplicationId": "C00000000001",
"contractHeaderId": "C000000100001",
"contractVersionId": "C000000100001",
"creditTypeCode": "REVOLVING_MONTHLY",
"priceListCode": "STANDARD",
"offerTypeCode": "NEW_CREDIT",
"personId": "C000000100001",
"serviceAccount": {
"sourceName": "PAYMENT",
"sourceRef": "ID-181922"
},
"serviceAccountNumber": "MT99123456789012345678"
}
}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.
{
"notificationId": "ID-9999",
"notificationTypeCode": "CARD_CREDIT_OFFER_DECLINED",
"destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
"originalMessageDateTime": "2024-07-17T10:46:53.598Z",
"data": {
"offerId": "C000000100018",
"cardApplicationId": "C00000000001",
"contractHeaderId": "C000000100001",
"contractVersionId": "C000000100001",
"creditTypeCode": "REVOLVING_MONTHLY",
"priceListCode": "STANDARD",
"offerTypeCode": "NEW_CREDIT",
"personId": "C000000100001",
"serviceAccount": {
"sourceName": "PAYMENT",
"sourceRef": "ID-181922"
},
"serviceAccountNumber": "MT99123456789012345678"
}
}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.
{
"notificationId": "ID-9999",
"notificationTypeCode": "CARD_CREDIT_CONTRACT_ACTIVATED",
"destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
"originalMessageDateTime": "2024-07-17T10:53:51.525Z",
"data": {
"contractHeaderId": "C000000100001",
"contractNumber": "CC1643360320",
"creditAccountId": "C000000100001",
"serviceAccountId": "C000000100001",
"personId": "C000000100001",
"currentContractVersionId": "C000000100001",
"firstContractVersionId": "C000000100001",
"creditOfferId": "C000000100001",
"creditTypeCode": "C000000100001",
"tenantCode": "TUUM"
}
}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.
{
"notificationId": "ID-9999",
"notificationTypeCode": "CARD_CREDIT_CONTRACT_VERSION_ACTIVATED",
"destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
"data": {
"contractHeaderId": "C000000100001",
"contractNumber": "CC1643360320",
"creditAccountId": "C000000100001",
"serviceAccountId": "C000000100001",
"personId": "C000000100001",
"currentContractVersionId": "C000000100001",
"firstContractVersionId": "C000000100001",
"creditOfferId": "C000000100001",
"creditTypeCode": "C000000100001",
"tenantCode": "TUUM"
}
}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.
{
"notificationId": "ID-9999",
"notificationTypeCode": "CARD_CREDIT_CONTRACT_BLOCKED",
"destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
"data": {
"contractHeaderId": "C000000100001",
"contractNumber": "CC1643360320",
"creditAccountId": "C000000100001",
"serviceAccountId": "C000000100001",
"personId": "C000000100001",
"currentContractVersionId": "C000000100001",
"firstContractVersionId": "C000000100001",
"creditOfferId": "C000000100001",
"creditTypeCode": "C000000100001",
"tenantCode": "TUUM"
}
}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.
{
"notificationId": "ID-9999",
"notificationTypeCode": "CARD_CREDIT_CONTRACT_CLOSED",
"destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
"data": {
"contractHeaderId": "C000000100001",
"contractNumber": "CC1643360320",
"creditAccountId": "C000000100001",
"serviceAccountId": "C000000100001",
"personId": "C000000100001",
"currentContractVersionId": "C000000100001",
"firstContractVersionId": "C000000100001",
"creditOfferId": "C000000100001",
"creditTypeCode": "C000000100001",
"tenantCode": "TUUM"
}
}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.
{
"notificationId": "ID-9999",
"notificationTypeCode": "CREDIT_CARD_CONTRACT_DEFAULTED",
"destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
"data": {
"contractHeaderId": "C000000100001",
"contractNumber": "CC1643360320",
"creditAccountId": "C000000100001",
"serviceAccountId": "C000000100001",
"personId": "C000000100001",
"currentContractVersionId": "C000000100001",
"firstContractVersionId": "C000000100001",
"creditOfferId": "C000000100001",
"creditTypeCode": "C000000100001",
"tenantCode": "TUUM"
}
}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.
{
"notificationId": "ID-9999",
"notificationTypeCode": "CARD_CLEARING_SECOND_PRESENTMENT_RECEIVED",
"destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
"originalMessageDateTime": "2024-07-17T12:43:15.553Z",
"data": {
"clearingTransactionId": "string",
"presentmentType": "SECOND_PRESENTMENT_FULL",
"transactionTypeCode": "string",
"reasonCode": "string",
"cardId": "C000000100008",
"cardNumber": "5167371003750356",
"panReference": "6195391456662197287",
"cardholderPersonId": "ID-1002",
"acqReferenceNumber": "string",
"approvalCode": "string",
"dateLocal": "string",
"cardAcceptorNameLocation": "string",
"purchaseCountryCode": "EST",
"merchantCategoryCode": "5732",
"transactionMoney": {
"amount": 1.22,
"currencyCode": "EUR"
},
"cardMoney": {
"amount": 1.22,
"currencyCode": "EUR"
},
"statusCode": "string",
"tenantCode": "string",
"mastercardData": {
"messageType": "string",
"funcCode": "string",
"reversal": true,
"reconciliationMoney": {
"amount": 1.22,
"currencyCode": "EUR"
},
"originalAmount": 0
},
"visaData": {
"usageCode": "string"
}
}
}
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.
{
"notificationId": "ID-9999",
"notificationTypeCode": "CARD_CLEARING_TOTALS_RECEIVED",
"destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
"originalMessageDateTime": "2024-07-17T12:50:47.775Z",
"data": {
"financialPositionId": "string",
"fileDate": "2024-07-17",
"fileId": "string",
"message": "string"
}
}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.
{
"notificationId": "ID-9999",
"notificationTypeCode": "CARD_CLEARING_TRANSACTION_COMPLETED",
"destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
"originalMessageDateTime": "2024-07-17T12:58:40.232Z",
"data": {
"clearingTransactionId": "string",
"messageType": "1100",
"transactionTypeCode": "00",
"cardholderPersonId": "ID-1002",
"accountOwnerPersonId": "ID-1000",
"cardNumber": "5167371003750356",
"panReference": "6195391456662197287",
"cardId": "C000000100008",
"cardAcceptorNameLocation": "string",
"cardAcceptorId": "10379733",
"cardAcceptorTerminalId": "QTR20233",
"purchaseCountryCode": "EE",
"merchantCategoryCode": "5732",
"transactionMoney": {
"amount": 1.22,
"currencyCode": "EUR"
},
"cardMoney": {
"amount": 1.22,
"currencyCode": "EUR"
},
"posLocalTime": "string",
"posData22": "500301610000",
"retrievalReferenceNumber": "string",
"processedDTime": "2024-07-17T12:58:40.232Z",
"tenantCode": "string",
"reversal": true,
"feeAmount": 0,
"conversionFee": 0,
"approvalCode": "string",
"statusCode": "string",
"errorCode": "string",
"presentmentType": "FIRST_PRESENTMENT",
"acqReferenceNumber": "string"
}
}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.
{
"notificationId": "ID-9999",
"notificationTypeCode": "CARD_CLEARING_TRANSACTION_UNMATCHED",
"destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
"originalMessageDateTime": "2024-07-17T13:14:44.224Z",
"data": {
"clearingTransactionId": "string",
"messageType": "1100",
"transactionTypeCode": "00",
"cardholderPersonId": "ID-1002",
"accountOwnerPersonId": "ID-1000",
"cardNumber": "5167371003750356",
"panReference": "6195391456662197287",
"cardId": "C000000100008",
"cardAcceptorNameLocation": "string",
"cardAcceptorId": "10379733",
"cardAcceptorTerminalId": "QTR20233",
"purchaseCountryCode": "EE",
"merchantCategoryCode": "5732",
"transactionMoney": {
"amount": 1.22,
"currencyCode": "EUR"
},
"cardMoney": {
"amount": 1.22,
"currencyCode": "EUR"
},
"posLocalTime": "string",
"posData22": "500301610000",
"retrievalReferenceNumber": "string",
"processedDTime": "2024-07-17T13:14:44.224Z",
"tenantCode": "string",
"reversal": true,
"feeAmount": 0,
"conversionFee": 0,
"approvalCode": "string",
"statusCode": "string",
"errorCode": "string",
"presentmentType": "FIRST_PRESENTMENT",
"acqReferenceNumber": "string"
}
}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.
{
"notificationId": "ID-9999",
"notificationTypeCode": "CARD_CLEARING_TRANSACTION_ERROR",
"destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
"originalMessageDateTime": "2024-07-17T13:10:40.828Z",
"data": {
"clearingTransactionId": "string",
"messageType": "1100",
"transactionTypeCode": "00",
"cardholderPersonId": "ID-1002",
"accountOwnerPersonId": "ID-1000",
"cardNumber": "5167371003750356",
"panReference": "6195391456662197287",
"cardId": "C000000100008",
"cardAcceptorNameLocation": "string",
"cardAcceptorId": "10379733",
"cardAcceptorTerminalId": "QTR20233",
"purchaseCountryCode": "EE",
"merchantCategoryCode": "5732",
"transactionMoney": {
"amount": 1.22,
"currencyCode": "EUR"
},
"cardMoney": {
"amount": 1.22,
"currencyCode": "EUR"
},
"posLocalTime": "string",
"posData22": "500301610000",
"retrievalReferenceNumber": "string",
"processedDTime": "2024-07-17T13:10:40.828Z",
"tenantCode": "string",
"reversal": true,
"feeAmount": 0,
"conversionFee": 0,
"approvalCode": "string",
"statusCode": "string",
"errorCode": "string",
"presentmentType": "FIRST_PRESENTMENT",
"acqReferenceNumber": "string"
}
}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.
{
"notificationId": "ID-9999",
"notificationTypeCode": "CARD_CHARGEBACK_RECEIVED",
"destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
"originalMessageDateTime": "2024-07-17T12:28:13.300Z",
"data": {
"transactionId": "string",
"presentmentType": "FIRST_CHARGEBACK_FULL",
"transactionTypeCode": "00",
"reasonCode": "string",
"cardId": "C000000100008",
"cardNumber": "5167371003750356",
"panReference": "6195391456662197287",
"cardholderPersonId": "ID-1002",
"arn": "string",
"approvalCode": "string",
"dateLocal": "string",
"cardAcceptorNameLocation": "string",
"purchaseCountryCode": "EST",
"merchantCategoryCode": "5732",
"transactionMoney": {
"amount": 1.22,
"currencyCode": "EUR"
},
"statusCode": "string",
"tenantCode": "string",
"mastercardData": {
"messageType": "string",
"funcCode": "string",
"reversal": true,
"reconciliationMoney": {
"amount": 1.22,
"currencyCode": "EUR"
},
"originalAmount": 0
},
"visaData": {
"usageCode": "string"
}
}
}CARD_SOURCE_CURRENCY_TOTALS_RECEIVED
The card API triggers the CARD_SOURCE_CURRENCY_TOTALS_RECEIVED notification when it receives a currency summary file within clearing data.
Event parameters are eventTypeCode/routing_code:
ext.cards.source-currency-totals.loaded.
{
"notificationId": "ID-9999",
"notificationTypeCode": "CARD_SOURCE_CURRENCY_TOTALS_RECEIVED",
"destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
"originalMessageDateTime": "2024-07-18T05:57:19.735Z",
"data": {
"financialPositionId": "string",
"fileDate": "2024-07-18",
"fileId": "string",
"message": "string"
}
}CARD_FEE_COLLECTION_LOADED
The card API triggers the CARD_FEE_COLLECTION_LOADED event when it receives a fee collection message with function code
783within clearing data.Event parameters are eventTypeCode/routing_code:
ext.cards.fee-collection.loaded.
{
"notificationId": "ID-9999",
"notificationTypeCode": "CARD_FEE_COLLECTION_LOADED",
"destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
"originalMessageDateTime": "2024-07-18T10:24:46.701Z",
"data": {
"feeCollectionId": "string",
"fileDate": "2024-07-18",
"fileId": "string",
"message": "string"
}
}Last updated
Was this helpful?