Choose the Documentation MX Merchant MX Connect

Webhook Event Types

Explore all available webhook events and subscribe to the ones that power your workflows.

Webhook events represent real-time system activities across customers, accounts, cards, transactions, and ledgers.

By subscribing to specific event types, you can:

  • Trigger automated workflows
  • Stay updated on critical changes
  • Build event-driven experiences

Each webhook event includes a structured payload with event metadata and the associated resource details.


Customer

Events related to the operations of creation and updation a Business or Individual customer.

Event TypeDescription
customer.business.create/updateTriggered when a business customer is created or updated
customer.individual.create/updateTriggered when an individual customer is created or updated

threshold defines the minimum trigger condition (default: 0)

Example Payloads

When you subscribe to an event, your endpoint will receive a POST request with a JSON payload. The structure will be similar to the example below, with the data object changing based on the eventType.

{
    "id": 15140,
    "eventType": "customer.individual.create",
    "eventTimeStamp": "05/13/2025 01:03:00",
    "eventId": "0001709618091430001",
    "eventCreated": 1747098180090,
    "payload": [
        {
            "resourceName": "customer",
            "url": "/v1/customer/id/4009402",
            "id": 4009402,
            "tags": [
                "grade A customer"
            ],
            "externalId": "TSC0567890",
            "metaData": {
                "acceptedDraftAmount": "$333.50"
            },
            "type": "INDIVIDUAL",
            "individual": {
                "firstName": "John",
                "middleName": "K",
                "lastName": "Smith",
                "fullName": "John K Smith",
                "last4ssn": "9578",
                "dob": "06/25/2000",
                "homePhone": "573-986-1372",
                "mobilePhone": "235-247-4107",
                "workPhone": "838-900-9290",
                "mailingAddress": [
                    {
                        "resourceName": "address",
                        "url": "/v1/customer/id/4009402/mailingAddress/id/1033532",
                        "id": 1033532,
                        "externalId": "P94567A221",
                        "addressLine1": "999",
                        "addressLine2": "GT1 KMB",
                        "city": "San Jose",
                        "state": "CA",
                        "zip": "95311",
                        "isPrimary": true
                    }
                ],
                "verification": {
                    "ofacStatus": "PENDING_VERIFICATION",
                    "ofacStatusReason": "PENDING_VERIFICATION",
                    "ofacStatusDate": "12/03/2022 07:49:48",
                    "cipStatus": "IGNORED",
                    "cipStatusReason": "IGNORED ON_USER_REQUEST",
                    "cipStatusDate": "12/03/2022 07:49:48"
                },
                "createdOn": "12/03/2022 07:49:48",
                "lastUpdatedOn": "12/03/2022 07:49:48"
            },
            "isPaperless": false,
            "status": "ACTIVE",
            "statusReason": "ON_USER_REQUEST",
            "statusDate": "12/03/2022 07:49:48",
            "account": {
                "resourceName": "account",
                "url": "/v1/customer/id/4009402/account"
            },
            "externalAccount": {
                "resourceName": "externalAccount",
                "url": "/v1/customer/id/4009402/externalAccount"
            },
            "linkedDocument": [
                {
                    "id": 24658,
                    "purpose": "AUTHORIZATION",
                    "status": "PENDING_VERIFICATION",
                    "document": {
                        "resourceName": "document",
                        "url": "/v1/document/id/4023765",
                        "id": 4023765,
                        "type": "SPAA",
                        "name": "abc.pdf"
                    },
                    "linkedOn": "12/03/2022 07:49:48",
                    "linkedBy": {
                        "userType": "API_USER",
                        "username": "[email protected]",
                        "status": "ACTIVE"
                    }
                }
            ],
            "createdOn": "12/03/2022 07:49:48",
            "createdBy": {
                "userType": "API_USER",
                "username": "[email protected]",
                "status": "ACTIVE"
            },
            "lastUpdatedOn": "12/03/2022 07:49:48",
            "lastUpdatedBy": {
                "userType": "API_USER",
                "username": "[email protected]",
                "status": "ACTIVE"
            }
        }
    ]
}
{
    "id": 15140,
    "eventType": "customer.individual.create",
    "eventTimeStamp": "05/13/2025 01:03:00",
    "eventId": "0001709618091430001",
    "eventCreated": 1747098180090,
    "payload": [
        {
            "resourceName": "customer",
            "url": "/v1/customer/id/4009402",
            "id": 4009402,
            "tags": [
                "grade A customer"
            ],
            "externalId": "TSC0567890",
            "metaData": {
                "acceptedDraftAmount": "$333.50"
            },
            "type": "INDIVIDUAL",
            "individual": {
                "firstName": "John",
                "middleName": "K",
                "lastName": "Smith",
                "fullName": "John K Smith",
                "last4ssn": "9578",
                "dob": "06/25/2000",
                "homePhone": "573-986-1372",
                "mobilePhone": "235-247-4107",
                "workPhone": "838-900-9290",
                "mailingAddress": [
                    {
                        "resourceName": "address",
                        "url": "/v1/customer/id/4009402/mailingAddress/id/1033532",
                        "id": 1033532,
                        "externalId": "P94567A221",
                        "addressLine1": "999",
                        "addressLine2": "GT1 KMB",
                        "city": "San Jose",
                        "state": "CA",
                        "zip": "95311",
                        "isPrimary": true
                    }
                ],
                "verification": {
                    "ofacStatus": "PENDING_VERIFICATION",
                    "ofacStatusReason": "PENDING_VERIFICATION",
                    "ofacStatusDate": "12/03/2022 07:49:48",
                    "cipStatus": "IGNORED",
                    "cipStatusReason": "IGNORED ON_USER_REQUEST",
                    "cipStatusDate": "12/03/2022 07:49:48"
                },
                "createdOn": "12/03/2022 07:49:48",
                "lastUpdatedOn": "12/03/2022 07:49:48"
            },
            "isPaperless": false,
            "status": "ACTIVE",
            "statusReason": "ON_USER_REQUEST",
            "statusDate": "12/03/2022 07:49:48",
            "account": {
                "resourceName": "account",
                "url": "/v1/customer/id/4009402/account"
            },
            "externalAccount": {
                "resourceName": "externalAccount",
                "url": "/v1/customer/id/4009402/externalAccount"
            },
            "linkedDocument": [
                {
                    "id": 24658,
                    "purpose": "AUTHORIZATION",
                    "status": "PENDING_VERIFICATION",
                    "document": {
                        "resourceName": "document",
                        "url": "/v1/document/id/4023765",
                        "id": 4023765,
                        "type": "SPAA",
                        "name": "abc.pdf"
                    },
                    "linkedOn": "12/03/2022 07:49:48",
                    "linkedBy": {
                        "userType": "API_USER",
                        "username": "[email protected]",
                        "status": "ACTIVE"
                    }
                }
            ],
            "createdOn": "12/03/2022 07:49:48",
            "createdBy": {
                "userType": "API_USER",
                "username": "[email protected]",
                "status": "ACTIVE"
            },
            "lastUpdatedOn": "12/03/2022 07:49:48",
            "lastUpdatedBy": {
                "userType": "API_USER",
                "username": "[email protected]",
                "status": "ACTIVE"
            }
        }
    ]
}

Authorized User

Events related to authorized user management.

Event TypeDescription
authorizeduser.create/updateTriggered when an authorized user is created or updated

Example Payloads

When you subscribe to an event, your endpoint will receive a POST request with a JSON payload. The structure will be similar to the example below, with the data object changing based on the eventType.

{
    "id": 65819811,
    "eventType": "authorizeduser.create",
    "eventTimeStamp": "06/21/2024 06:52:14",
    "eventId": "0001709618091430001",
    "eventCreated": 1747098180090,
    "payload": [
        {
            "resourceName": "authorizedUser",
            "url": "/v1/customer/id/4225975/authorizedUser/id/53520",
            "id": 53520,
            "firstName": "Ujjwal",
            "lastName": "Patel",
            "last4ssn": "7233",
            "isUSCitizen": true,
            "portalAccess": {
                "role": [
                    {
                        "lastUpdatedBy": {
                            "userType": "INTERNAL",
                            "username": "DEFAULT_USER",
                            "status": "ACTIVE"
                        },
                        "assignedBy": {
                            "userType": "CUSTOMER",
                            "username": "[email protected]",
                            "status": "ACTIVE"
                        },
                        "createdBy": {
                            "userType": "INTERNAL",
                            "username": "DEFAULT_USER",
                            "status": "ACTIVE"
                        },
                        "name": "admin",
                        "lastUpdatedOn": "2024-06-14",
                        "resourceName": "role",
                        "roletype": "NON_ADMIN",
                        "assignedOn": "2024-06-21",
                        "id": 11385,
                        "createdOn": "2024-06-14",
                        "url": "/v1/customer/id/4225975/role"
                    }
                ],
                "grantAccess": true,
                "username": "[email protected]"
            },
            "isBeneficialOwner": false,
            "createdOn": "06/21/2024 06:52:14",
            "userId": 4013084,
            "mobilePhone": "938-726-7860",
            "mailingAddress": [
                {
                    "zip": "66801",
                    "city": "Miami",
                    "isPrimary": true,
                    "usage": {
                        "isPayorAddress": false
                    },
                    "addressLine1": "5505 Blue Lagoon Dr",
                    "resourceName": "address",
                    "addressLine2": "Main St",
                    "id": 1176432,
                    "state": "CT"
                }
            ],
            "createdBy": {
                "username": "[email protected]",
                "status": "ACTIVE"
            },
            "lastUpdatedBy": {
                "username": "[email protected]",
                "status": "ACTIVE"
            },
            "dob": "08/08/1998",
            "countryCode": "91",
            "lastUpdatedOn": "06/21/2024 06:52:14",
            "email": "[email protected]",
            "verification": {
                "ofacStatus": "PENDING_VERIFICATION",
                "cipStatus": "PENDING_VERIFICATION",
                "cipStatusDate": "06/21/2024 06:52:14",
                "cipStatusReason": "PENDING_VERIFICATION",
                "ofacStatusDate": "06/21/2024 06:52:14",
                "ofacStatusReason": "PENDING_VERIFICATION"
            },
            "actAsAuthorizedSignatory": false
        }
    ]
}


Account

Events related to account lifecycle and updates.

Event TypeDescription
account.create/updateTriggered when an account is created or updated

threshold defines trigger conditions (default: 30 for decline-based alerts)

Example Payloads

When you subscribe to an event, your endpoint will receive a POST request with a JSON payload. The structure will be similar to the example below, with the data object changing based on the eventType.

{
    "id": 15140,
    "eventType": "account.create",
    "eventTimeStamp": "06/10/2024 19:08:33",
    "eventId": "0001709618091430001",
    "eventCreated": 1747098180090,
    "payload": [
        {
            "resourceName": "account",
            "url": "v1/customer/id/4007825/account/id/4003513",
            "id": 4003513,
            "externalId": "E22343422234125678654",
            "nickName": "Jhon",
            "accountNumber": "8125001200000346",
            "status": "INACTIVE",
            "statusReason": "PENDING_VERIFICATION",
            "statusDate": "06/08/2023 06:11:10",
            "balance": {
                "amount": "0.00",
                "asOn": "06/08/2023 06:11:26"
            },
            "availableBalance": {
                "amount": "0.00",
                "asOn": "06/08/2023 06:11:26"
            },
            "purpose": "FEE",
            "routableAccount": {
                "accountNumber": "76650000004347",
                "routingNumber": "053101561",
                "wireRoutingNumber": "122287251",
                "wireAccountNumber": "13976650000004347",
                "wireMemo": "Alex Johnson 13976650000004347",
                "memo": "Alex Johnson 76650000004347"
            },
            "linkedDocument": [
                {
                    "id": 15339,
                    "purpose": "AUTHORIZATION",
                    "status": "PENDING_VERIFICATION",
                    "document": {
                        "resourceName": "document",
                        "url": "/v1/document/id/4014696",
                        "id": 4014696,
                        "type": "SPAA",
                        "name": "spaa-blank.pdf"
                    },
                    "linkedOn": "06/08/2023 06:09:06",
                    "linkedBy": {
                        "userType": "API_USER",
                        "username": "[email protected]",
                        "status": "ACTIVE"
                    }
                }
            ],
            "createdOn": "06/08/2023 06:09:05",
            "createdBy": {
                "userType": "API_USER",
                "username": "[email protected]",
                "status": "ACTIVE"
            },
            "lastUpdatedBy": {
                "userType": "INTERNAL",
                "username": "DEFAULT_USER",
                "status": "ACTIVE"
            },
            "lastUpdatedOn": "06/08/2023 06:11:10",
            "isCustomerOwned": true,
            "activationDate": "09/14/2023 06:09:46",
            "isPrimary": false,
            "totalCredit": {
                "amount": "0.00",
                "asOn": "03/13/2024 05:23:47"
            },
            "totalDebit": {
                "amount": "0.00",
                "asOn": "03/13/2024 05:23:47"
            }
        }
    ]
}

Card Issuance

Events related to card lifecycle, activity, and controls.

Event TypeDescription
card.prepaid.create/updatePrepaid card issued or updated
card.prepaid.transaction.declinedPrepaid transaction declined
card.prepaid.transactionactivity.creditFunds added to prepaid card
card.prepaid.transactionactivity.debitSpend or debit from prepaid card
card.prepaid.pin.updatedPIN updated for prepaid card
card.debit.create/updateDebit card issued or updated
card.debit.transaction.declinedDebit transaction declined
card.debit.pin.updatedPIN updated for debit card

Example Payloads

When you subscribe to an event, your endpoint will receive a POST request with a JSON payload. The structure will be similar to the example below, with the data object changing based on the eventType.

Example Payload for Prepaid Cards

{
    "id": 283203,
    "webhookSubscription": {
        "id": 246
    },
    "status": "NEW",
    "statusReason": "NEW",
    "statusDate": "03/18/2026 01:02:10",
    "payload": {
        "resourceName": "Card",
        "url": "v1/customer/id/4006726/issuance/card/id/596",
        "id": 596,
        "externalId": "ExtIdPRDM2265296924",
        "cardHolder": {
            "type": "BENEFICIAL_OWNER",
            "id": 20209,
            "name": "Albert Sangma"
        },
        "cardIssuanceId": "590",
        "cardNumber": "9574614556321864",
        "cvv": "493",
        "cardType": "PREPAID",
        "type": "DIGITAL",
        "status": "ACTIVE",
        "statusReason": "Debit Card activated",
        "statusDate": "03/18/2026 01:02:10",
        "createdOn": "03/18/2026 01:02:10",
        "createdBy": {
            "userType": "API_USER",
            "username": "[email protected]",
            "status": "ACTIVE"
        },
        "lastUpdatedBy": {
            "userType": "API_USER",
            "username": "[email protected]",
            "status": "ACTIVE"
        },
        "lastUpdatedOn": "03/18/2026 01:02:10",
        "isReissuedOnce": false,
        "cardProgram": "ONLY DIGIQXSQe",
        "properties": {
            "isDigitalFirst": false
        },
        "cardLast4": "1864",
        "prn": "935735696699",
        "spendLimit": {
            "url": "v1/customer/id/4006726/issuance/card/id/596/limit"
        },
        "issuanceType": "DIGITAL",
        "availableBalance": 0.0
    },
    "eventName": "card.prepaid.create",
    "createdOn": "03/18/2026 01:02:10",
    "createdBy": {
        "username": "CFT_JOB_USER",
        "status": "ACTIVE",
        "userType": "INTERNAL"
    },
    "lastUpdatedOn": "03/18/2026 01:02:10",
    "lastUpdatedBy": {
        "username": "CFT_JOB_USER",
        "status": "ACTIVE",
        "userType": "INTERNAL"
    },
    "eventEntity": {
        "id": 596
    }
}
{
  "eventId": "0820460000000167810001",
  "payload": [
    {
      "lastUpdatedBy": {
        "userType": "SYSTEM",
        "username": "SYSTEM",
        "status": "ACTIVE"
      },
      "amount": 10.29,
      "statusReason": "Transaction Timeout",
      "createdBy": {
        "userType": "SYSTEM",
        "username": "SYSTEM",
        "status": "ACTIVE"
      },
      "lastUpdatedOn": "03/20/2026 11:44:11",
      "id": 21616,
      "declineCode": "PC-0096",
      "transactionDate": "03/18/2026 05:17:53",
      "merchantDetails": {
        "merchantLocation": "WASHINGTON, DCUS",
        "mcc": {
          "code": "6011",
          "description": "FINANCIAL INST-AUTOMATED CASH DISBUR"
        },
        "merchantName": "PNC BANK"
      },
      "createdOn": "03/20/2026 11:44:11",
      "card": {
        "resourceName": "card",
        "id": 901035003,
        "type": "PREPAID",
        "url": "/v1/customer/id/4224690/issuance/card/id/901035003"
      },
      "status": "DECLINED"
    }
  ],
  "id": 73853488,
  "eventType": "card.prepaid.transaction.declined",
  "eventTimeStamp": "03/20/2026 11:44:11"
}
{
  "eventId": "0820440000004155080001",
  "payload": [
    {
      "data": {
        "lastUpdatedBy": {
          "userType": "API_USER",
          "username": "[email protected]",
          "status": "ACTIVE"
        },
        "amount": 105,
        "ledgerDate": "03/20/2026",
        "method": "BOOK",
        "createdBy": {
          "userType": "API_USER",
          "username": "[email protected]",
          "status": "ACTIVE"
        },
        "narration": "cbp - BOOK Send to load card Ref: 231039451",
        "ledgerType": "SETTLE",
        "lastUpdatedOn": "03/20/2026 11:36:40",
        "id": 5636824,
        "type": "CREDIT",
        "createdOn": "03/20/2026 11:36:40"
      },
      "resourceName": "card",
      "id": 901035003,
      "url": "/v1/customer/id/4224690/issuance/card/id/901035003"
    }
  ],
  "id": 73853480,
  "eventType": "card.prepaid.transactionactivity.credit",
  "eventTimeStamp": "03/20/2026 11:36:40"
}
{
  "eventId": "0820450000001760040001",
  "payload": [
    {
      "data": {
        "lastUpdatedBy": {
          "userType": "SYSTEM",
          "username": "SYSTEM",
          "status": "ACTIVE"
        },
        "amount": 1.06,
        "ledgerDate": "03/20/2026",
        "method": "CARD",
        "createdBy": {
          "userType": "SYSTEM",
          "username": "SYSTEM",
          "status": "ACTIVE"
        },
        "narration": "Pending To *1883 - EXXON PRATTVILLE COOSA PRATTVILLE AL",
        "groupId": "PC-1238940112",
        "ledgerType": "HOLD",
        "lastUpdatedOn": "03/20/2026 11:40:37",
        "id": 5636825,
        "type": "DEBIT",
        "createdOn": "03/20/2026 11:40:37"
      },
      "resourceName": "card",
      "id": 901035003,
      "url": "/v1/customer/id/4224690/issuance/card/id/901035003"
    }
  ],
  "id": 73853486,
  "eventType": "card.prepaid.transactionactivity.debit",
  "eventTimeStamp": "03/20/2026 11:40:37"
}

Example Payload for Debit Cards

{
    "id": 136723,
    "webhookSubscription": {
        "id": 225
    },
    "status": "NEW",
    "statusReason": "NEW",
    "statusDate": "03/17/2026 22:14:35",
    "payload": {
        "resourceName": "Card",
        "url": "v1/customer/id/4006376/issuance/card/id/520",
        "id": 520,
        "externalId": "ExtId7264728143",
        "cardHolder": {
            "type": "AUTHORIZED_USER",
            "id": 19362,
            "name": "AuthUserCPrAH SmithHAVWA"
        },
        "cardIssuanceId": "524",
        "cardNumber": "0009",
        "cardType": "DEBIT",
        "type": "PLASTIC",
        "shippingDetail": {
            "address": {
                "id": 1023718,
                "externalId": "EIDa208193406207176853",
                "addressLine1": "Street 1, lane 102",
                "addressLine2": "Park Street",
                "city": "California",
                "state": "AL",
                "zip": "94408",
                "status": "ACTIVE"
            },
            "expressDelivery": false
        },
        "status": "PENDING",
        "statusReason": "Debit Card Request submitted",
        "statusDate": "03/17/2026 22:14:25",
        "createdOn": "03/17/2026 22:14:25",
        "createdBy": {
            "userType": "API_USER",
            "username": "[email protected]",
            "status": "ACTIVE"
        },
        "lastUpdatedBy": {
            "userType": "SYSTEM",
            "username": "SYSTEM",
            "status": "ACTIVE"
        },
        "lastUpdatedOn": "03/17/2026 22:14:34",
        "isReissuedOnce": false,
        "cardProgram": "PM CORP STD PB PL CARD2eFjwZ",
        "properties": {
            "isDigitalFirst": false
        },
        "cardLast4": "0009",
        "prn": "884079084588"
    },
    "eventName": "card.debit.update",
    "createdOn": "03/17/2026 22:14:35",
    "createdBy": {
        "username": "CFT_JOB_USER",
        "status": "ACTIVE",
        "userType": "INTERNAL"
    },
    "lastUpdatedOn": "03/17/2026 22:14:35",
    "lastUpdatedBy": {
        "username": "CFT_JOB_USER",
        "status": "ACTIVE",
        "userType": "INTERNAL"
    },
    "eventEntity": {
        "id": 520
    }
}
{
  "eventId": "0820460000000167810001",
  "payload": [
    {
      "lastUpdatedBy": {
        "userType": "SYSTEM",
        "username": "SYSTEM",
        "status": "ACTIVE"
      },
      "amount": 10.29,
      "statusReason": "Transaction Timeout",
      "createdBy": {
        "userType": "SYSTEM",
        "username": "SYSTEM",
        "status": "ACTIVE"
      },
      "lastUpdatedOn": "03/20/2026 11:44:11",
      "id": 21616,
      "declineCode": "PC-0096",
      "transactionDate": "03/18/2026 05:17:53",
      "merchantDetails": {
        "merchantLocation": "WASHINGTON, DCUS",
        "mcc": {
          "code": "6011",
          "description": "FINANCIAL INST-AUTOMATED CASH DISBUR"
        },
        "merchantName": "PNC BANK"
      },
      "createdOn": "03/20/2026 11:44:11",
      "card": {
        "resourceName": "card",
        "id": 901035003,
        "type": "DEBIT",
        "url": "/v1/customer/id/4224690/issuance/card/id/901035003"
      },
      "status": "DECLINED"
    }
  ],
  "id": 73853488,
  "eventType": "card.debit.transaction.declined",
  "eventTimeStamp": "03/20/2026 11:44:11"
}


Ledgers

Events related to financial entries and balance changes.

Event TypeDescription
ledger.createTriggered when a ledger entry is created

Example Payloads

When you subscribe to an event, your endpoint will receive a POST request with a JSON payload. The structure will be similar to the example below, with the data object changing based on the eventType.

{
    "id": 570719385,
    "eventType": "ledger.create",
    "eventTimeStamp": "05/28/2025 19:08:51",
    "eventCreated": 1748459331990,
    "eventId": "3934530000003903500002",
    "payload": [
        {
            "id": 14911785,
            "amount": 5,
            "ledgerDate": "05/28/2025",
            "method": "CARD",
            "account": {
                "resourceName": "account",
                "id": 4350958,
                "url": "/v1/customer/id/5686406/account/id/4350958"
            },
            "narration": "Pending To *3440 - BIRD APP* PENDING.BIRD +18662052442 FLUS",
            "groupId": "1030648CET",
            "type": "DEBIT",
            "ledgerType": "HOLD",
            "createdOn": "05/28/2025 19:08:51",
            "createdBy": {
                "userType": "SYSTEM",
                "username": "SYSTEM",
                "status": "ACTIVE"
            },
            "lastUpdatedOn": "05/28/2025 19:08:51",
            "lastUpdatedBy": {
                "userType": "SYSTEM",
                "username": "SYSTEM",
                "status": "ACTIVE"
            }
        }
    ]
}