Webhooks

The goal of the webhooks is to give your organization a real time update on the status and events of users, transactions, products, invoices, subscriptions, taxes and common fees so you can automate your next call to action depending of the status of the payments or the occurrence of events.

To enable webhooks you have to open the settings page using the portal.

When a URL is defined, Zūm will send a POST request each time there is a status change or event triggered for:

• Users (only available for customers)

• Transactions (only available for customers)

• Customers (only available for partners)

• Recurrent Transaction (only available for customers)

• Products (only available for customers)

• Invoices (only available for customers)

• Subscriptions (only available for customers)

• Taxes (only available for customers)

• Common Fees (only available for customers)

• Insights (only available for customers)

• Chargeback Action (only available for customers)

• Aggregation Status (only available for customers)

• Aggregation Transaction Events (only available for customers)

Canada

  {
      "Type": "Invoice",
      "Event": "Created",
      "Data": {
          ...
      }
  }

US

INFO

The payload has a property Type to indicate to each entity the webhook status change is coming from and also a property called Event that indicates the type of event that trigger the webhook.

Event

Event	Description	Availability
Created	Entity was created	Invoice, Subscription, Product, Tax Rate, Common Fee
Updated	Entity was updated on some manner	Invoice, Subscription, Product, Tax Rate, Common Fee
Deleted	Entity was deleted	Product
StatusChange	Entity had it's status changed	Invoice, Subscription, Product, Tax Rate, Common Fee
Completed	Entity was ready to use	Insights
Failed	Entity was not ready to use	Insights

NOTE

For now, transactions and user entities does not posses events to be associated with

Type

Type	Description
User	Indicates the webhook call is for a user status change
Transaction	Indicates the webhook call is for a transaction status change
Customer	Indicates the webhook call is for a customer account status change
Recurrent Transaction	Indicates the webhook call is for a recurrent transaction creation
Product	Indicates the webhook call is for a product event
Invoice	Indicates the webhook call is for a invoice event
Subscription	Indicates the webhook call is for a subscription event
TaxRate	Indicates the webhook call is for a tax rate event
CommonFee	Indicates the webhook call is for a common fee event
Insights	Indicates the webhook call is for a insights event

Canada

Type	Description
User	Indicates the webhook call is for a user status change
Transaction	Indicates the webhook call is for a transaction status change
Customer	Indicates the webhook call is for a customer account status change
Recurrent Transaction	Indicates the webhook call is for a recurrent transaction creation
Product	Indicates the webhook call is for a product event
Invoice	Indicates the webhook call is for a invoice event
Subscription	Indicates the webhook call is for a subscription event
TaxRate	Indicates the webhook call is for a tax rate event
CommonFee	Indicates the webhook call is for a common fee event
Insights	Indicates the webhook call is for a insights event

US

The webhook payload uses the same JSON format as the responses for the get User, Transaction, Product, Invoice, Subscription, Tax Rates, Common Fees and Insights.

The Chargeback webhook payload follows the JSON structure shown in the example response.

INFO

If you don't want to receive webhook for a specific status, then you can specify the status in the portal settings.

Verifying authenticity

When Zūm Rails sends data to external services (e.g. when triggering a webhook to a service owned by you), the payload will be authenticated with a hash-based message authentication code (HMAC).

The key used to create the HMAC is your Webhook Secret, and you verify it by running the algorithm yourself with the payload and the key to re-create the HMAC. Your Webhook Secret can be found in the portal under your settings.

The signature is always sent with the webhook in a header named zumrails-signature

You can verify the authenticity of the webhook response by using HMAC. The HMAC verification process is as follows:

1. You receive a POST request via the webhook

2. Your app computes a signature based on payload received, using your Webhook Secret

3. You verify that your signature matches the zumrails-signature in the request

Here are the steps to validate a request coming from Zūm Rails You’ll need the zumrails-signature sent by the webhook and your key (which is your Webhook Secret):

1. Retrieve the zumrails-signature header

2. Retrieve json body of the request. Make sure you are not adding any new spaces or formats.

3. Using HMAC SHA256 implemented in your programming language, calculate the signature in your side. The body is the payload and the secret is your Webhook Secret.

4. Compare your hash with the value provided under the zumrails-signature in the request, they should match.

A few examples on how to calculate HMAC in different languages: https://github.com/danharper/hmac-examples

Canada

INFO

When generating the signature, make sure you are using the body received in the payload, as it is. Some languages might add spaces or tabs.

WE CALCULATE THE SIGNATURE MAKING SURE THE PAYLOAD IS IN UTF-8 CHARSET,

When generating the signature, make sure you are using the body received in the payload, as it is. Some languages might add spaces or tabs.

US

Retry in case of failure

In the event of a failure to deliver the webhook (!= 200) we will try again 3 times every 5 minutes in sandbox. In production we will retry 5 times every 60 minutes.

If you have anything specific in our retry policy, don't hesitate to talk with us, to [e-mail], changes can be made.

Receiving users' financial institution details

Response

{
    "Type": "Transaction",
    "Data": {
        ...
        "InteracDebtorInstitutionNumber": "999",
        "InteracDebtorInstitutionName": "Testing Financial Institution",
        "InteracDebtorFullName": "Debtor Full Name",
        ...
    }
}

For Interac transactions, you can now receive the end users' financial institution name and financial institution number which was used to complete the Interac requests. To receive this information, make sure you have configured the InteracSettledIntoWallet webhook event. (You can set this event by going to settings > webhook and API settings > Interac status change).

NOTE

In some cases the bank may return the same input provided on Zum Rails and not the name on the user’s account for the parameter "InteracDebtorFullName". This will result in the transaction going through successfully even when the name might not be a match. This is rare and the banks are working to improve on their end.

INFO

This information might not be available for all accounts. For any questions contact our support team

Chargeback webhook

Response

  {
      "Type": "ChargebackAction",
      "Event": "Disputed",
      "Data": {
        "Id": "e5ec36c3...5445500db505",
        "TransactionId": "ff116078...eee1a4f399a5",
        "ReceivedDate": "2024-04-10",
        "AuthorizationCode": "OK5234",
        "AcquirerReferenceNumber": "1674915201620667421592979",
        "ChargebackAmount": 9.9131,
        "DisputeCurrencyCode": "USD",
        "DisputeReasonCode": "1350",
        "MemberMessageText": "Misrepresentation",
        "FileId": "685221186",
        "ChargebackControlNumber": "771638347",
        "DueDate": "2024-04-14",
        "ChargebackWorkTypeCode": "1",
        "ChargebackStatus": "Disputed"
      }
  }

The payload has a property Type to indicate to each entity the webhook status change is coming from and also a property called Event that indicates the type of event that trigger the webhook.

Event

Event	Description
AcceptedByUser	Chargeback was accepted by user.
AcceptedByDefault	Chargeback was accepted past due date.
Disputed	Chargeback was disputed by user.

Aggregation Transaction webhook

The webhook is triggered at the end of the aggregation process, once the user’s bank account transactions have been retrieved.

If the process completes successfully, the response payload will include all account and transaction data. In this case, there is no need to call the API to retrieve aggregation details, as all the required information is already provided in the webhook.

If the process fails, the webhook payload will include an error message describing the issue.

Event

Event	Description
Completed	Aggregation transaction scraping has been successfully completed. This event is triggered regardless of whether the process runs synchronously or asynchronously.
Failed	Aggregation transaction scraping has failed. This event is triggered only when the process runs asynchronously.

Response

Untitled

{
    "Type": "AggregationTransaction",
    "Event": "Completed",
    "EventGeneratedAt": "2026-04-23T17:07:27.324644Z",
    "Data": {
        "RequestId": "2986eb0d-ae75-4190-847b-559972cfaf59",
        "CustomerId": "b9f7c096-6fb0-4338-aba3-b59f1da27d46",
        "Card": {
            "Id": "c2b3b4a4-2c5a-499e-a318-6a3c35426abf",
            "UpdatedAt": "2026-04-23T17:07:26.166376",
            "CreatedAt": "0001-01-01T00:00:00Z",
            "Accounts": [
                {
                    "Id": "6a020cee-3147-4b29-a4c0-dd38e142e036",
                    "InstitutionNumber": "900",
                    "TransitNumber": "10000",
                    "AccountNumber": "35317855",
                    "Title": "Zum Chequing",
                    "Balance": 662.64,
                    "Currency": "CAD",
                    "AccountCategory": "Operation",
                    "AccountSubCategory": "Chequing",
                    "Transactions": [
                        {
                            "Id": "b75d43db-e2e8-458d-ad9e-eb912a9730f8",
                            "UpdatedAt": "0001-01-01T00:00:00Z",
                            "Date": "2026-04-23T00:00:00",
                            "Description": "VISA DEBIT PURCHASE REVERSAL Questrade",
                            "Credit": 0.01,
                            "Balance": 662.64,
                            "Category": {
                                "Id": "baeda044-cca9-4da7-8a50-ae6ed78cf547",
                                "Name": "Credit Reversals",
                                "CategoryGroupId": "00000000-0000-0000-0000-000000000000",
                                "InsightsType": "Expense"
                            }
                        },
                        ...
                    ]
                },
                {
                    "Id": "167b866a-e9d6-4851-a44d-c9b53ef245d4",
                    "InstitutionNumber": "900",
                    "TransitNumber": "10000",
                    "AccountNumber": "8806974",
                    "Title": "Savings",
                    "Balance": 662.64,
                    "Currency": "CAD",
                    "AccountCategory": "Operation",
                    "AccountSubCategory": "Savings",
                    "Transactions": [
                        {
                            "Id": "b75d43db-e2e8-458d-ad9e-eb912a9730f8",
                            "UpdatedAt": "0001-01-01T00:00:00Z",
                            "Date": "2026-04-23T00:00:00",
                            "Description": "VISA DEBIT PURCHASE REVERSAL Questrade",
                            "Credit": 0.01,
                            "Balance": 662.64,
                            "Category": {
                                "Id": "baeda044-cca9-4da7-8a50-ae6ed78cf547",
                                "Name": "Credit Reversals",
                                "CategoryGroupId": "00000000-0000-0000-0000-000000000000",
                                "InsightsType": "Expense"
                            }
                        },
                        ...
                    ]
                },
                {
                    "Id": "422be6f9-1198-40f4-bde0-9895f73c77fb",
                    "AccountNumber": "4242424242424242",
                    "Title": "Credit Card",
                    "Balance": 2247.67,
                    "Currency": "CAD",
                    "AccountCategory": "Credit",
                    "AccountSubCategory": "CreditCard",
                    "Transactions": [
                        {
                            "Id": "1aaa80ad-7b2c-49b4-b2e2-8a251329b9c7",
                            "UpdatedAt": "0001-01-01T00:00:00Z",
                            "Date": "2026-04-23T00:00:00",
                            "Description": "Roku for Sirius XM 816-2728107, DE 4500********2426",
                            "Credit": 1.34,
                            "Category": {
                                "Id": "baeda044-cca9-4da7-8a50-ae6ed78cf598",
                                "Name": "Uncategorized Income",
                                "CategoryGroupId": "00000000-0000-0000-0000-000000000000",
                                "InsightsType": "Expense"
                            }
                        },
                        ...
                    ]
                },
                {
                    "Id": "0196cbff-ee96-4969-9bbd-8df326fde7eb",
                    "AccountNumber": "78953",
                    "Title": "Mortgage",
                    "Balance": 9876.0,
                    "Currency": "CAD",
                    "AccountCategory": "Product",
                    "AccountSubCategory": "Mortgage",
                    "Transactions": []
                }
            ],
            "InstitutionId": "2a778283-d87a-4b8c-aa3e-af1ed16bc486",
            "InstitutionName": "Zūm Rails Testing Bank",
            "HolderId": "75924a9c-0023-4418-b870-a06b813ec0be",
            "Holder": {
                "FirstName": "John",
                "LastName": "Doe",
                "FullName": "John Doe",
                "Email": "[e-mail]",
                "PhoneNumber": "8171204182",
                "DateOfBirth": "01-01-1990",
                "AddressCivic": "1st Street",
                "AddressCity": "Toronto",
                "AddressProvince": "ON",
                "AddressCountry": "CA",
                "AddressPostalCode": "A0A0A0"
            },
            "SelectedAccountId": "6a020cee-3147-4b29-a4c0-dd38e142e036"
        }
    }
}

Failed

Prepaid Card User webhook

OnboardIncomplete

{
  "Type": "PrepaidCardUser",
  "Event": "OnboardIncomplete",
  "EventGeneratedAt": "2026-03-31T16:14:53.5639672Z",
  "Data": {
    "CardVerificationStatus": "INCOMPLETE",
    "Warnings": [
      "Face mismatch between document/govern,ent photo and selfie photo.",
      "The given identity document/number has been previously verified.",
      "Selfie photo is not live."
    ],
    "CardOnboardingSession": "https://checkout-master.zumrails.ca/baas/register/21d76d60-559f-48a3-bf17-68878956e2bc/508a2a3f-8cdc-40e9-987c-6d9343a21b9e",
    "User": {
      "FirstName": "Test",
      "LastName": "webhook3",
      "DateOfBirth": "01/01/1990"
    },
    "CardApplicationStatus": "Incomplete",
    "CardRegistrationStatus": "",
    "CustomerId": "21d76d60-559f-48a3-bf17-68878956e2bc",
    "CreatedAt": "2026-03-31T16:13:49.758566",
    "UserCardId": "e4d41dc2-b369-4888-aa18-741fa8c556f1",
    "CardType": "PrepaidCard",
    "UserId": "4a78182b-4958-4f88-a50b-89f15835b81b"
  }
}

OnboardApproval

Card Issued

Event

Type	Event	Description
PrepaidCardUser	OnboardIncomplete	Prepaid card application profile setup completed but did not complete the KYC/IDV step
PrepaidCardUser	OnboardInProgress	Prepaid card application verification started but not finished
PrepaidCardUser	OnboardApproval	Prepaid card application verification is successful and passed
PrepaidCardUser	OnboardDeclined	Prepaid card application is declined (same format as OnboardIncomplete)
PrepaidCardUser	OnboardUnderReview	Prepaid card application is under review (same format as OnboardIncomplete)
PrepaidCardUser	CardIssued	Prepaid card is issued to the approved user
PrepaidCardUser	CardActivated	Prepaid card is activated (same format as CardIssued)
PrepaidCardUser	CardStatusChanged	Prepaid card status change (same format as CardIssued)
PrepaidCardUser	CardProgramChanged	Prepaid card program change (same format as CardIssued)
PrepaidCardUser	CardReissue	Prepaid card is reissued (same format as CardIssued)
PrepaidCardUser	ProfileUpdate	Prepaid card profile change (same format as CardIssued)
PrepaidCardUser	LowBalanceAlert	Prepaid card has a low balance (same format as CardIssued)

Onboard Status

Type	Event	Card Verification Status
PrepaidCardUser	OnboardIncomplete	INCOMPLETE
PrepaidCardUser	OnboardInProgress	IN PROGRESS
PrepaidCardUser	OnboardApproval	APPROVED
PrepaidCardUser	OnboardDeclined	DECLINED
PrepaidCardUser	OnboardUnderReview	UNDER REVIEW

NOTE

The CardOnboardingSession parameter is a URL link to the card applicants IDV session and the link expires after 7 days based on the initial IDV session.

The card applicant can access the CardOnboardingSession URL anytime and after authentication, they will land on where they dropped off if the card application was not finished.

Once the card onboarding link expires, the cardholder's application has expired. The cardholder will need to re-apply from the beginning and a new card onboarding link will be generated.

Secured Credit Card User webhook

OnboardIncomplete

{
  "Type": "SecuredCreditCardUser",
  "Event": "OnboardIncomplete",
  "EventGeneratedAt": "2026-04-30T14:45:23.1203217Z",
  "Data": {
    "CardVerificationStatus": "INCOMPLETE",
    "Warnings": [],
    "CardOnboardingSession": "https://checkout-master.zumrails.ca/baas/register/secured-credit-card/5c6b68c7-225a-4611-be48-b6b338d9f4fe/c5af2fa7-c110-4fe6-8c1d-581c371577db",
    "User": {
      "FirstName": "Test",
      "LastName": "web1",
      "DateOfBirth": "09/23/1987",
      "Email": "[e-mail]",
      "PhoneNumber": "8768768768",
      "Language": "En"
    },
    "CardApplicationStatus": "Incomplete",
    "CardRegistrationStatus": "",
    "CustomerId": "5c6b68c7-225a-4611-be48-b6b338d9f4fe",
    "CreatedAt": "2026-04-30T14:44:37.023242",
    "CreditLimitRequested": 1000,
    "UserCardId": "62cfe658-b5fe-47d7-aea4-36745872ea96",
    "CardType": "SecuredCreditCard",
    "UserId": "f1a816b1-a480-4fd9-b1eb-fff65f24c30d"
  }
}

OnboardApproval

Card Issued

Event

Type	Event	Description
SecuredCreditCardUser	OnboardIncomplete	Card application profile setup completed but did not complete the KYC/IDV step
SecuredCreditCardUser	OnboardInProgress	Card application verification started but not finished
SecuredCreditCardUser	OnboardApproval	Card application verification is successful and passed
SecuredCreditCardUser	OnboardDeclined	Card application is declined (same format as OnboardIncomplete)
SecuredCreditCardUser	OnboardUnderReview	Card application is under review (same format as OnboardIncomplete)
SecuredCreditCardUser	CardIssued	Card is issued to the approved user
SecuredCreditCardUser	CardActivated	Caard is activated (same format as CardIssued)
SecuredCreditCardUser	CardStatusChanged	Card status change (same format as CardIssued)
SecuredCreditCardUser	CardProgramChanged	Card program change (same format as CardIssued)
SecuredCreditCardUser	CardReissue	Card is reissued (same format as CardIssued)
SecuredCreditCardUser	ProfileUpdate	Card profile change (same format as CardIssued)
SecuredCreditCardUser	CardAttributeUpdate	Card related attribute updates such as security deposit and credit limit changes (same format as CardIssued)
SecuredCreditCardUser	LowBalanceAlert	Card has a low available credit (same format as CardIssued)

Onboard Status

Type	Event	Card Verification Status
SecuredCreditCardUser	OnboardIncomplete	INCOMPLETE
SecuredCreditCardUser	OnboardInProgress	IN PROGRESS
SecuredCreditCardUser	OnboardApproval	APPROVED
SecuredCreditCardUser	OnboardDeclined	DECLINED
SecuredCreditCardUser	OnboardUnderReview	UNDER REVIEW

NOTE

The CardOnboardingSession parameter is a URL link to the card applicants IDV session and the link expires after 7 days based on the initial IDV session.

The card applicant can access the CardOnboardingSession URL anytime and after authentication, they will land on where they dropped off if the card application was not finished.

Once the card onboarding link expires, the cardholder's application has expired. The cardholder will need to re-apply from the beginning and a new card onboarding link will be generated.

Card Transaction webhook

NetworkDebit

{
  "Type": "PrepaidCardTransaction",
  "Event": "NetworkDebit",
  "EventGeneratedAt": "2026-03-31T19:46:21.0615358Z",
  "Data": {
    "Transaction": {
      "TransactionId": "511",
      "MessageType": "0200",
      "Date": "2026-03-31",
      "Time": "21:47:27",
      "CardAcceptor": {
        "AcquirerId": "ACQ987",
        "MerchantCode": "MERCH12345",
        "NameAndLocation": "AIR LANKA (ABBR. AIR LANKA). New York NY",
        "MerchantCity": "New York",
        "MerchantState": "NY",
        "MerchantZipCode": "10001",
        "MCC": "3044",
        "DeviceId": "POS001",
        "DeviceType": "Terminal",
        "LocalDateTime": "2026-03-06T11:20:30"
      },
      "TransactionType": "00",
      "TransactionAmount": -3.22,
      "TransactionResponseCode": "00",
      "NetworkId": "mastercard",
      "TransactionDescription": " Network Posted Debit Transaction"
    },
    "CardReferenceId": "599000170193",
    "UserCardId": "4be272ca-81b8-43d5-840a-aa23a514403e",
    "CardType": "PrepaidCard",
    "UserId": "4a78182b-4958-4f88-a50b-89f15835b81b"
  }
}

NonNetworkDebit

InactiveCardFee

WriteOff

Type	Event	Description
PrepaidCardTransaction / SecuredCreditCardTransaction	NetworkDebit	Card network debit related financial transactions
PrepaidCardTransaction / SecuredCreditCardTransaction	NetworkCredit	Card network credit related financial transactions (same format as NetworkDebit)
PrepaidCardTransaction / SecuredCreditCardTransaction	NetworkDecline	Card network decline related financial transactions (same format as NetworkDebit)
PrepaidCardTransaction / SecuredCreditCardTransaction	NonNetworkDebit	Card non-network debit related financial transactions
PrepaidCardTransaction / SecuredCreditCardTransaction	NonNetworkCredit	Card non-network credit related financial transactions (same format as NonNetworkDebit)
PrepaidCardTransaction / SecuredCreditCardTransaction	NonNetworkDecline	Card non-network decline related financial transactions (same format as NonNetworkDebit)
PrepaidCardTransaction / SecuredCreditCardTransaction	TransactionReversal	Card transaction reversals (same format as NonNetworkDebit)
PrepaidCardTransaction / SecuredCreditCardTransaction	InactiveCardFee	Card inactivity fee applied to the card
PrepaidCardTransaction / SecuredCreditCardTransaction	OverdraftFee	Card overdraft fee applied to the card (same format as InactiveCardFee)
PrepaidCardTransaction / SecuredCreditCardTransaction	LatePaymentFee	Card late payment fee applied to the card (same format as InactiveCardFee)
PrepaidCardTransaction / SecuredCreditCardTransaction	MaintenanceFee	Card maintenance fee applied to the card (same format as InactiveCardFee)
PrepaidCardTransaction / SecuredCreditCardTransaction	IssuingCardFee	Card issuing fee applied to the card (same format as InactiveCardFee)
PrepaidCardTransaction / SecuredCreditCardTransaction	ActivatedFee	Card activation fee applied to the card (same format as InactiveCardFee)
PrepaidCardTransaction	WriteOff	Card is written off due to negative balance based on the Negative Balance rule

MessageType

Based on the Transaction object, you can determine the type of transaction based on the following Transaction.MessageType

Value	Description
0200	Posted Transaction Normal
0220	Posted Transaction Force Post
0400	Posted Transaction Reversal
0420	Posted Transaction Reversal
0100	Pending Transaction
0120	Pending Transaction
0720	Fee-based Transaction
0722	Fee-based Transaction

OTP webhook

CardholderPortalOtp

{
  "Type": "CardUserOTP",
  "Event": "CardHolderPortal",
  "EventGeneratedAt": "2026-03-31T15:25:51.9038934Z",
  "Data": {
    "CreateAt": "2026-03-31T15:25:51.9036441Z",
    "OtpMessage": "84059320",
    "OtpExpiry": "10",
    "UserEmail": "[e-mail]",
    "UserId": "007db275-bdfa-4869-b407-501698a52fdd"
  }
}

MobileWalletOtp

ThreeDsOtp

OTP Event

The OtpExpiry parameter is in minutes.

Type	Event	Description
CardUserOTP	CardHolderPortalOtp	OTP for cardholder portal login
PrepaidCardOTP / SecuredCreditCardOTP	MobileWalletOtp	Prepaid card mobile wallet provisioning triggered an OTP request
PrepaidCardOTP / SecuredCreditCardOTP	ThreeDsOtp	Prepaid card online transaction triggered a 3DS OTP request (same format as MobileWalletOtp)

Card Statement webhook

The webhook is triggered when a card statement is generated for a secured credit card User.

CardStatement

{
  "Type": "SecuredCreditCardUser",
  "Event": "CardStatement",
  "EventGeneratedAt": "2026-06-02T19:22:53.1221004Z",
  "Data": {
    "UserId": "691e9d21-9bbe-4f18-91a0-b8e41f82b28c",
    "UserCardId": "3379c595-4136-4861-b373-dd56ad0dba7f",
    "StatementId": "994279e2-48e2-4490-a368-f5e417546f14",
    "StatementStartDate": "2026-05-01",
    "StatementEndDate": "2026-05-31",
    "StatementDate": "2026-05-01",
    "PaymentDueDate": "2026-05-25T00:00:00",
    "PreviousBalance": 146.65,
    "Payments": 0,
    "OtherCredits": 0,
    "Purchases": 0,
    "CashAdvance": 0,
    "InterestCharged": 0.7,
    "FeeCharged": 35,
    "NewBalance": 182.35,
    "MinimumPaymentDue": 0,
    "CreditLimit": 360,
    "AvailableCredit": 177.65,
    "PastDueAmount": 146.65,
    "BalanceTransfers": 0,
    "TotalFeesChargedYtd": 180.22,
    "TotalInterestChargedYtd": 2.13,
    "DaysAccountPastDue": 0,
    "StatementGenerated": true,
    "Transactions": [
      {
        "Id": "f7360548-7080-48a0-b238-a2a7110c5bf8",
        "Type": "Purchase",
        "Description": "Maintenance fee charged",
        "TransactionDate": "2026-05-07T00:00:00",
        "TransactionPostedDate": "2026-05-07T00:00:00",
        "Amount": 2
      },
      {
        "Id": "21d42176-b37e-4066-bcdd-27334075430f",
        "Type": "Credit",
        "Description": "Payment",
        "TransactionDate": "2026-05-07T00:00:00",
        "TransactionPostedDate": "2026-05-07T00:00:00",
        "Amount": -22
      }
    ]
  }
}

Credit Trade Report webhook

The webhook is triggered when a Credit Trade Report record is generated for a secured credit card User.

CreditTradeReport

{
  "Type": "SecuredCreditCardUser",
  "Event": "CreditTradeReport",
  "EventGeneratedAt": "2026-03-31T15:25:51.9038934Z",
  "Data": {
    "ReportId": "d9583779-e523-4816-bc19-450edfa5077a",
    "ReportMonth": "202605",
    "UserId": "d9583779-e523-4816-bc19-450edfa5077a",
    "UserCardId": "d9583779-e523-4816-bc19-450edfa5077a",
    "TransactionMethod": "CreditCardIssuance",
    "CardType": "SecuredCreditCard",
    "CreatedAt": "2026-06-09T19:42:36.612431Z"
  }
}