Transaction Cloud - Webhooks - Documentation v1 | TransactionCloud Documentation

Webhooks

Create Account

TransactionCloud supports integration using webhooks. You can use these webhooks with your backend or third-party systems for updating your database and triggering multiple events.

Set up Webhooks

You can define your webhook URL in the API Set up section of the production or sandbox app. Subsequently, webhooks are sent to this URL as POST requests for all future events.

Please note, our system does automatic retries of the webhook until HTTP status code 200 is received. We recommend designing the script to parse duplicate posts.

Webhook verification & security

IP Verification

You can use the IP address to verify the webhook. All webhooks will arrive from this IP:

IP	Environment
5.161.71.107	Sandbox
3.211.123.73	Production

Security Tag

Additionally in order to verify incoming webhook you can use Webhook Security Tag. You can generate it in the API Set up tab in TransactionCloud Vendor Panel. It will be attached to each incoming webhook message as an HTTP Header X-TC-Security-Tag.

Available webhooks

SUBSCRIPTION_ACTIVATED

Webhook is sent after subscription activation.

Webhook application/json

id string

Unique identification for the transaction.

Example: "TC-TR_xxyyxxx"

transactionType string<transactionType>

Type of product. Possible values:

Value	Description
ONETIME	One-time product transaction.
SUBSCRIPTION	Recurring product transaction.
VAULTED	Vaulted product transaction.

productId string

Unique product identificator.

Example: "TC-PR_yyyyxxxx"

productName string

Name of the product.

payload string | null

Encrypted custom data passed before the checkout process. It's highly recommended to encrypt this data on your end.

Requirements: <5000 characters

transactionStatus string<transactionStatus>

Current status of the transaction. Possible values:

Value	Description
TRANSACTION_STATUS_PENDING	Pending payment.
TRANSACTION_STATUS_REFUNDED	Refunded one-time payment product.
ONE_TIME_PAYMENT_STATUS_PAID	Paid one-time product.
SUBSCRIPTION_STATUS_ACTIVE	Active subscription.
SUBSCRIPTION_STATUS_ACTIVE_TRIAL	Active subscription in trial period.
SUBSCRIPTION_STATUS_CANCELLED_PENDING	Subscription cancellation in progress.
SUBSCRIPTION_STATUS_CANCELLED	Cancelled subscription.
VAULTED_STATUS_ACTIVE	Active vaulted product.
VAULTED_STATUS_INACTIVE	Inactive vaulted product.

createDate string<datetime>

Transaction create date.

Format: YYYY-MM-DDTHH:MM:SS.sZ

lastCharge string<datetime>

Date of the last successful payment.

Format: YYYY-MM-DDTHH:MM:SS.sZ

nextCharge string<datetime>

Date of the next payment.

Format: YYYY-MM-DDTHH:MM:SS.sZ

firstName string

First name of the customer.

lastName string

Last name of the customer.

organization string

Organization of the customer.

email string<email>

Email address used by the customer during purchase.

webhookId string

Unique id of the webhook. If the webhook is retried the same unique id is used again.

Example: "uSKCLf8LOGkouEY"

webhookType string

Information about type of event.

Example: "SUBSCRIPTION_ACTIVATED"

country string<countryCode>

Country where customer completed the payment.

Example: "US"

assignedEmail string<email> | null

Email address used by the customer during website sign-up. It will be null until you set it with the "Assign email" endpoint.

chargeFrequency string<chargeFrequency> | null

Frequency of charges for recurring products. Possible values:

Value	Description
UNKNOWN	Unset charge frequency.
DAILY	Once per day.
WEEKLY	Once per week.
MONTHLY	Once per month.
HALF_YEARLY	Twice per year.
YEARLY	Once per year.

Example

                                
                                    Webhook Request
                                    
                                
                                {
    "webhookId": "NhczrAwugRAiS4K",
    "webhookType": "SUBSCRIPTION_ACTIVATED",
    "transactionId": "TC-TR_XXXYYZZ",
    "transactionType": "SUBSCRIPTION",
    "createDate": "2022-11-23T20:30:03.586Z",
    "nextCharge": "2022-12-23T20:30:03.586Z",
    "lastCharge": "2022-11-23T20:30:03.586Z",
    "chargeFrequency": "MONTHLY",
    "productId": "TC-PR_1112233",
    "productName": "Product",
    "payload": "",
    "transactionStatus": "SUBSCRIPTION_STATUS_ACTIVE",
    "firstName": "customer_first_name",
    "lastName": "customer_last_name",
    "organization": "",
    "email": "customer@domain.com",
    "assignedEmail": "",
    "country": "US"
}

SUBSCRIPTION_CANCELED

Webhook is sent after subscription cancellation.

Webhook application/json

id string

Unique identification for the transaction.

Example: "TC-TR_xxyyxxx"

transactionType string<transactionType>

Type of product. Possible values:

Value	Description
ONETIME	One-time product transaction.
SUBSCRIPTION	Recurring product transaction.
VAULTED	Vaulted product transaction.

productId string

Unique product identificator.

Example: "TC-PR_yyyyxxxx"

productName string

Name of the product.

payload string | null

Encrypted custom data passed before the checkout process. It's highly recommended to encrypt this data on your end.

Requirements: <5000 characters

transactionStatus string<transactionStatus>

Current status of the transaction. Possible values:

Value	Description
TRANSACTION_STATUS_PENDING	Pending payment.
TRANSACTION_STATUS_REFUNDED	Refunded one-time payment product.
ONE_TIME_PAYMENT_STATUS_PAID	Paid one-time product.
SUBSCRIPTION_STATUS_ACTIVE	Active subscription.
SUBSCRIPTION_STATUS_ACTIVE_TRIAL	Active subscription in trial period.
SUBSCRIPTION_STATUS_CANCELLED_PENDING	Subscription cancellation in progress.
SUBSCRIPTION_STATUS_CANCELLED	Cancelled subscription.
VAULTED_STATUS_ACTIVE	Active vaulted product.
VAULTED_STATUS_INACTIVE	Inactive vaulted product.

createDate string<datetime>

Transaction create date.

Format: YYYY-MM-DDTHH:MM:SS.sZ

lastCharge string<datetime>

Date of the last successful payment.

Format: YYYY-MM-DDTHH:MM:SS.sZ

firstName string

First name of the customer.

lastName string

Last name of the customer.

organization string

Organization of the customer.

email string<email>

Email address used by the customer during purchase.

webhookId string

Unique id of the webhook. If the webhook is retried the same unique id is used again.

Example: "uSKCLf8LOGkouEY"

webhookType string

Information about type of event.

Example: "SUBSCRIPTION_ACTIVATED"

country string<countryCode>

Country where customer completed the payment.

Example: "US"

assignedEmail string<email> | null

Email address used by the customer during website sign-up. It will be null until you set it with the "Assign email" endpoint.

chargeFrequency string<chargeFrequency> | null

Frequency of charges for recurring products. Possible values:

Value	Description
UNKNOWN	Unset charge frequency.
DAILY	Once per day.
WEEKLY	Once per week.
MONTHLY	Once per month.
HALF_YEARLY	Twice per year.
YEARLY	Once per year.

Example

                                
                                    Webhook Request
                                    
                                
                                {
    "webhookId": "NhdewwfgRAiS4K",
    "webhookType": "SUBSCRIPTION_CANCELED",
    "transactionId": "TC-TR_XXXYYZZ",
    "transactionType": "SUBSCRIPTION",
    "createDate": "2022-11-23T20:30:03.586Z",
    "lastCharge": "2022-11-23T20:30:03.586Z",
    "chargeFrequency": "MONTHLY",
    "productId": "TC-PR_1112233",
    "productName": "Product",
    "payload": "",
    "transactionStatus": "SUBSCRIPTION_STATUS_ACTIVE",
    "firstName": "customer_first_name",
    "lastName": "customer_last_name",
    "organization": "",
    "email": "customer@domain.com",
    "assignedEmail": "",
    "country": "US"
}

SUBSCRIPTION_FIRST_CHARGE

Webhook is sent after subscription is charged for the first time.

Webhook application/json

id string

Unique identification for the transaction.

Example: "TC-TR_xxyyxxx"

transactionType string<transactionType>

Type of product. Possible values:

Value	Description
ONETIME	One-time product transaction.
SUBSCRIPTION	Recurring product transaction.
VAULTED	Vaulted product transaction.

productId string

Unique product identificator.

Example: "TC-PR_yyyyxxxx"

productName string

Name of the product.

payload string | null

Encrypted custom data passed before the checkout process. It's highly recommended to encrypt this data on your end.

Requirements: <5000 characters

transactionStatus string<transactionStatus>

Current status of the transaction. Possible values:

Value	Description
TRANSACTION_STATUS_PENDING	Pending payment.
TRANSACTION_STATUS_REFUNDED	Refunded one-time payment product.
ONE_TIME_PAYMENT_STATUS_PAID	Paid one-time product.
SUBSCRIPTION_STATUS_ACTIVE	Active subscription.
SUBSCRIPTION_STATUS_ACTIVE_TRIAL	Active subscription in trial period.
SUBSCRIPTION_STATUS_CANCELLED_PENDING	Subscription cancellation in progress.
SUBSCRIPTION_STATUS_CANCELLED	Cancelled subscription.
VAULTED_STATUS_ACTIVE	Active vaulted product.
VAULTED_STATUS_INACTIVE	Inactive vaulted product.

createDate string<datetime>

Transaction create date.

Format: YYYY-MM-DDTHH:MM:SS.sZ

firstName string

First name of the customer.

lastName string

Last name of the customer.

organization string

Organization of the customer.

email string<email>

Email address used by the customer during purchase.

currency string<currency>

Currency code of the transaction.

Example: "USD"

webhookId string

Unique id of the webhook. If the webhook is retried the same unique id is used again.

Example: "uSKCLf8LOGkouEY"

webhookType string

Information about type of event.

Example: "SUBSCRIPTION_ACTIVATED"

whoCanceled string<whoCanceled> | null

Reason for cancellation in case of a canceled subscription or vaulted transaction. Possible values:

Value	Description
TRANSACTION_CLOUD_ADMIN	TransactionCloud.
VENDOR	Vendor.
CUSTOMER	Customer cancellation.
NEXT_CHARGE_FAILED	Failed next charge.

country string<countryCode>

Country where customer completed the payment.

Example: "US"

assignedEmail string<email> | null

Email address used by the customer during website sign-up. It will be null until you set it with the "Assign email" endpoint.

eventId string

Unique event number, helping to identify issues.

Example: "TC-BA_xxxyyyz"

amountTotal string

Total event amount.

taxAmount string

Total tax amount.

income string

Total income amount.

taxRate string

Tax rate for the transaction.

affiliateCommission string

Affiliate commission.

affiliateCommissionCurrency string

Currency of affiliates commission.

Example

                                
                                    Webhook Request
                                    
                                
                                {
    "webhookId": "pmH4KtToca8QjzC",
    "webhookType": "CHARGE",
    "payload": "",
    "whoCanceled": null,
    "transactionId": "TC-TR_XXXYYZZ",
    "transactionType": "SUBSCRIPTION",
    "createDate": "2022-11-23T20:30:03.586Z",
    "productId": "TC-PR_1112233",
    "productName": "Product",
    "firstName": "customer_first_name",
    "lastName": "customer_last_name",
    "organization": "",
    "email": "customer@domain.com",
    "assignedEmail": "",
    "country": "US",
    "eventId": "TC-BA_AAABBCC",
    "currency": "USD",
    "amountTotal": "5400.00",
    "taxAmount": "400.00",
    "income": "4729.50",
    "taxRate": "0.08",
    "affiliateCommission": "0.00",
    "affiliateCommissionCurrency": "USD"
}

SUBSCRIPTION_RENEWAL

Webhook is sent after subscription is renewed.

Webhook application/json

id string

Unique identification for the transaction.

Example: "TC-TR_xxyyxxx"

transactionType string<transactionType>

Type of product. Possible values:

Value	Description
ONETIME	One-time product transaction.
SUBSCRIPTION	Recurring product transaction.
VAULTED	Vaulted product transaction.

productId string

Unique product identificator.

Example: "TC-PR_yyyyxxxx"

productName string

Name of the product.

payload string | null

Encrypted custom data passed before the checkout process. It's highly recommended to encrypt this data on your end.

Requirements: <5000 characters

transactionStatus string<transactionStatus>

Current status of the transaction. Possible values:

Value	Description
TRANSACTION_STATUS_PENDING	Pending payment.
TRANSACTION_STATUS_REFUNDED	Refunded one-time payment product.
ONE_TIME_PAYMENT_STATUS_PAID	Paid one-time product.
SUBSCRIPTION_STATUS_ACTIVE	Active subscription.
SUBSCRIPTION_STATUS_ACTIVE_TRIAL	Active subscription in trial period.
SUBSCRIPTION_STATUS_CANCELLED_PENDING	Subscription cancellation in progress.
SUBSCRIPTION_STATUS_CANCELLED	Cancelled subscription.
VAULTED_STATUS_ACTIVE	Active vaulted product.
VAULTED_STATUS_INACTIVE	Inactive vaulted product.

createDate string<datetime>

Transaction create date.

Format: YYYY-MM-DDTHH:MM:SS.sZ

firstName string

First name of the customer.

lastName string

Last name of the customer.

organization string

Organization of the customer.

email string<email>

Email address used by the customer during purchase.

currency string<currency>

Currency code of the transaction.

Example: "USD"

webhookId string

Unique id of the webhook. If the webhook is retried the same unique id is used again.

Example: "uSKCLf8LOGkouEY"

webhookType string

Information about type of event.

Example: "SUBSCRIPTION_ACTIVATED"

whoCanceled string<whoCanceled> | null

Reason for cancellation in case of a canceled subscription or vaulted transaction. Possible values:

Value	Description
TRANSACTION_CLOUD_ADMIN	TransactionCloud.
VENDOR	Vendor.
CUSTOMER	Customer cancellation.
NEXT_CHARGE_FAILED	Failed next charge.

country string<countryCode>

Country where customer completed the payment.

Example: "US"

assignedEmail string<email> | null

Email address used by the customer during website sign-up. It will be null until you set it with the "Assign email" endpoint.

eventId string

Unique event number, helping to identify issues.

Example: "TC-BA_xxxyyyz"

amountTotal string

Total event amount.

taxAmount string

Total tax amount.

income string

Total income amount.

taxRate string

Tax rate for the transaction.

affiliateCommission string

Affiliate commission.

affiliateCommissionCurrency string

Currency of affiliates commission.

nextCharge string

Date of the next charge for the subscription.

lastCharge string

Date of the latest charge for the subscription.

chargeCount number

A number indicating the order of the payment within the subscription.

Example

                                
                                    Webhook Request
                                    
                                
                                {
    "webhookId": "qtL5LuUpdb9RkzD",
    "webhookType": "CHARGE",
    "transactionId": "TC-TR_XXXYYZZ",
    "transactionType": "SUBSCRIPTION",
    "whoCanceled": null,
    "createDate": "2022-11-23T20:30:03.586Z",
    "productId": "TC-PR_1112233",
    "productName": "Product",
    "payload": "Payload example",
    "firstName": "customer_first_name",
    "lastName": "customer_last_name",
    "organization": "",
    "email": "customer@domain.com",
    "assignedEmail": "",
    "country": "US",
    "eventId": "TC-BA_CCCDDEE",
    "currency": "USD",
    "amountTotal": "5400.00",
    "taxAmount": "400.00",
    "income": "4729.50",
    "taxRate": "0.08",
    "affiliateCommission": "0.00",
    "affiliateCommissionCurrency": "USD",
    "lastCharge": "2024-03-14T12:51:48.630Z",
    "nextCharge": "2024-04-14T12:51:48.413Z",
    "chargeCount": 2
}

PURCHASE_OF_PRODUCT_(ONE_TIME_PAYMENT)

Webhook is sent after purchase of product.

Webhook application/json

id string

Unique identification for the transaction.

Example: "TC-TR_xxyyxxx"

transactionType string<transactionType>

Type of product. Possible values:

Value	Description
ONETIME	One-time product transaction.
SUBSCRIPTION	Recurring product transaction.
VAULTED	Vaulted product transaction.

productId string

Unique product identificator.

Example: "TC-PR_yyyyxxxx"

productName string

Name of the product.

payload string | null

Encrypted custom data passed before the checkout process. It's highly recommended to encrypt this data on your end.

Requirements: <5000 characters

transactionStatus string<transactionStatus>

Current status of the transaction. Possible values:

Value	Description
TRANSACTION_STATUS_PENDING	Pending payment.
TRANSACTION_STATUS_REFUNDED	Refunded one-time payment product.
ONE_TIME_PAYMENT_STATUS_PAID	Paid one-time product.
SUBSCRIPTION_STATUS_ACTIVE	Active subscription.
SUBSCRIPTION_STATUS_ACTIVE_TRIAL	Active subscription in trial period.
SUBSCRIPTION_STATUS_CANCELLED_PENDING	Subscription cancellation in progress.
SUBSCRIPTION_STATUS_CANCELLED	Cancelled subscription.
VAULTED_STATUS_ACTIVE	Active vaulted product.
VAULTED_STATUS_INACTIVE	Inactive vaulted product.

createDate string<datetime>

Transaction create date.

Format: YYYY-MM-DDTHH:MM:SS.sZ

lastCharge string<datetime>

Date of the last successful payment.

Format: YYYY-MM-DDTHH:MM:SS.sZ

firstName string

First name of the customer.

lastName string

Last name of the customer.

organization string

Organization of the customer.

email string<email>

Email address used by the customer during purchase.

webhookId string

Unique id of the webhook. If the webhook is retried the same unique id is used again.

Example: "uSKCLf8LOGkouEY"

webhookType string

Information about type of event.

Example: "SUBSCRIPTION_ACTIVATED"

whoCanceled string<whoCanceled> | null

Reason for cancellation in case of a canceled subscription or vaulted transaction. Possible values:

Value	Description
TRANSACTION_CLOUD_ADMIN	TransactionCloud.
VENDOR	Vendor.
CUSTOMER	Customer cancellation.
NEXT_CHARGE_FAILED	Failed next charge.

country string<countryCode>

Country where customer completed the payment.

Example: "US"

assignedEmail string<email> | null

Email address used by the customer during website sign-up. It will be null until you set it with the "Assign email" endpoint.

chargeFrequency string<chargeFrequency> | null

Frequency of charges for recurring products. Possible values:

Value	Description
UNKNOWN	Unset charge frequency.
DAILY	Once per day.
WEEKLY	Once per week.
MONTHLY	Once per month.
HALF_YEARLY	Twice per year.
YEARLY	Once per year.

Example

                                
                                    Webhook Request
                                    
                                
                                {
    "webhookId": "x20rq2SDMMzdZ1O",
    "webhookType": "ONETIME_PAID",
    "whoCanceled": null,
    "transactionId": "TC-TR_LLLKKJJ",
    "productId": "TC-PR_NNNMMAA",
    "productName": "Product",
    "createDate": "2022-11-23T22:16:05.287Z",
    "payload": "",
    "transactionType": "ONETIME",
    "transactionStatus": "ONE_TIME_PAYMENT_STATUS_PAID",
    "lastCharge": "2022-11-23T22:16:05.287Z",
    "chargeFrequency": "UNKNOWN",
    "email": "customer@domain.com",
    "assignedEmail": "",
    "country": "US",
    "organization": "",
    "firstName": "customer_first_name",
    "lastName": "customer_last_name"
}

ONE_TIME_PAYMENT_CHARGE

Webhook is sent when one time payment is charged.

Webhook application/json

id string

Unique identification for the transaction.

Example: "TC-TR_xxyyxxx"

transactionType string<transactionType>

Type of product. Possible values:

Value	Description
ONETIME	One-time product transaction.
SUBSCRIPTION	Recurring product transaction.
VAULTED	Vaulted product transaction.

productId string

Unique product identificator.

Example: "TC-PR_yyyyxxxx"

productName string

Name of the product.

payload string | null

Encrypted custom data passed before the checkout process. It's highly recommended to encrypt this data on your end.

Requirements: <5000 characters

transactionStatus string<transactionStatus>

Current status of the transaction. Possible values:

Value	Description
TRANSACTION_STATUS_PENDING	Pending payment.
TRANSACTION_STATUS_REFUNDED	Refunded one-time payment product.
ONE_TIME_PAYMENT_STATUS_PAID	Paid one-time product.
SUBSCRIPTION_STATUS_ACTIVE	Active subscription.
SUBSCRIPTION_STATUS_ACTIVE_TRIAL	Active subscription in trial period.
SUBSCRIPTION_STATUS_CANCELLED_PENDING	Subscription cancellation in progress.
SUBSCRIPTION_STATUS_CANCELLED	Cancelled subscription.
VAULTED_STATUS_ACTIVE	Active vaulted product.
VAULTED_STATUS_INACTIVE	Inactive vaulted product.

createDate string<datetime>

Transaction create date.

Format: YYYY-MM-DDTHH:MM:SS.sZ

firstName string

First name of the customer.

lastName string

Last name of the customer.

organization string

Organization of the customer.

email string<email>

Email address used by the customer during purchase.

currency string<currency>

Currency code of the transaction.

Example: "USD"

webhookId string

Unique id of the webhook. If the webhook is retried the same unique id is used again.

Example: "uSKCLf8LOGkouEY"

webhookType string

Information about type of event.

Example: "SUBSCRIPTION_ACTIVATED"

whoCanceled string<whoCanceled> | null

Reason for cancellation in case of a canceled subscription or vaulted transaction. Possible values:

Value	Description
TRANSACTION_CLOUD_ADMIN	TransactionCloud.
VENDOR	Vendor.
CUSTOMER	Customer cancellation.
NEXT_CHARGE_FAILED	Failed next charge.

country string<countryCode>

Country where customer completed the payment.

Example: "US"

assignedEmail string<email> | null

Email address used by the customer during website sign-up. It will be null until you set it with the "Assign email" endpoint.

eventId string

Unique event number, helping to identify issues.

Example: "TC-BA_xxxyyyz"

amountTotal string

Total event amount.

taxAmount string

Total tax amount.

income string

Total income amount.

taxRate string

Tax rate for the transaction.

affiliateCommission string

Affiliate commission.

affiliateCommissionCurrency string

Currency of affiliates commission.

Example

                                
                                    Webhook Request
                                    
                                
                                {
    "webhookId": "BpQlxiBykCpdp2d",
    "webhookType": "CHARGE",
    "whoCanceled": null,
    "transactionId": "TC-TR_LLLKKJJ",
    "transactionType": "ONETIME",
    "createDate": "2022-11-23T22:16:05.287Z",
    "productId": "TC-PR_NNNMMAA",
    "productName": "Product",
    "payload": "",
    "firstName": "customer_first_name",
    "lastName": "customer_last_name",
    "organization": "",
    "email": "customer@domain.com",
    "assignedEmail": "",
    "country": "US",
    "eventId": "TC-BA_ZZZCCVV",
    "currency": "USD",
    "amountTotal": "32.39",
    "taxAmount": "2.40",
    "income": "27.87",
    "taxRate": "0.08",
    "affiliateCommission": "0.00",
    "affiliateCommissionCurrency": "USD"
}

REFUND

Webhook is sent after a refund.

Webhook application/json

id string

Unique identification for the transaction.

Example: "TC-TR_xxyyxxx"

transactionType string<transactionType>

Type of product. Possible values:

Value	Description
ONETIME	One-time product transaction.
SUBSCRIPTION	Recurring product transaction.
VAULTED	Vaulted product transaction.

productId string

Unique product identificator.

Example: "TC-PR_yyyyxxxx"

productName string

Name of the product.

payload string | null

Encrypted custom data passed before the checkout process. It's highly recommended to encrypt this data on your end.

Requirements: <5000 characters

transactionStatus string<transactionStatus>

Current status of the transaction. Possible values:

Value	Description
TRANSACTION_STATUS_PENDING	Pending payment.
TRANSACTION_STATUS_REFUNDED	Refunded one-time payment product.
ONE_TIME_PAYMENT_STATUS_PAID	Paid one-time product.
SUBSCRIPTION_STATUS_ACTIVE	Active subscription.
SUBSCRIPTION_STATUS_ACTIVE_TRIAL	Active subscription in trial period.
SUBSCRIPTION_STATUS_CANCELLED_PENDING	Subscription cancellation in progress.
SUBSCRIPTION_STATUS_CANCELLED	Cancelled subscription.
VAULTED_STATUS_ACTIVE	Active vaulted product.
VAULTED_STATUS_INACTIVE	Inactive vaulted product.

createDate string<datetime>

Transaction create date.

Format: YYYY-MM-DDTHH:MM:SS.sZ

firstName string

First name of the customer.

lastName string

Last name of the customer.

organization string

Organization of the customer.

email string<email>

Email address used by the customer during purchase.

currency string<currency>

Currency code of the transaction.

Example: "USD"

webhookId string

Unique id of the webhook. If the webhook is retried the same unique id is used again.

Example: "uSKCLf8LOGkouEY"

webhookType string

Information about type of event.

Example: "SUBSCRIPTION_ACTIVATED"

whoCanceled string<whoCanceled> | null

Reason for cancellation in case of a canceled subscription or vaulted transaction. Possible values:

Value	Description
TRANSACTION_CLOUD_ADMIN	TransactionCloud.
VENDOR	Vendor.
CUSTOMER	Customer cancellation.
NEXT_CHARGE_FAILED	Failed next charge.

country string<countryCode>

Country where customer completed the payment.

Example: "US"

assignedEmail string<email> | null

Email address used by the customer during website sign-up. It will be null until you set it with the "Assign email" endpoint.

eventId string

Unique event number, helping to identify issues.

Example: "TC-BA_xxxyyyz"

amountTotal string

Total event amount.

taxAmount string

Total tax amount.

income string

Total income amount.

taxRate string

Tax rate for the transaction.

affiliateCommission string

Affiliate commission.

affiliateCommissionCurrency string

Currency of affiliates commission.

Example

                                
                                    Webhook Request
                                    
                                
                                {
    "webhookId": "qn8ixxv6jy4tReQ",
    "webhookType": "REFUND",
    "whoCanceled": null,
    "transactionId": "TC-TR_XXXYYZZ",
    "transactionType": "SUBSCRIPTION",
    "createDate": "2022-11-23T20:30:03.586Z",
    "productId": "TC-PR_1112233",
    "productName": "Product",
    "firstName": "customer_first_name",
    "lastName": "customer_last_name",
    "organization": "",
    "email": "customer@domain.com",
    "assignedEmail": "",
    "country": "US",
    "eventId": "TC-BA_DDDEEFF",
    "currency": "USD",
    "amountTotal": "-5400.00",
    "taxAmount": "-400.00",
    "income": "-5000.00",
    "taxRate": "0.08",
    "affiliateCommission": "0.00",
    "affiliateCommissionCurrency": "USD"
}

CHARGEBACK

Webhook is sent after a chargeback.

Webhook application/json

id string

Unique identification for the transaction.

Example: "TC-TR_xxyyxxx"

transactionType string<transactionType>

Type of product. Possible values:

Value	Description
ONETIME	One-time product transaction.
SUBSCRIPTION	Recurring product transaction.
VAULTED	Vaulted product transaction.

productId string

Unique product identificator.

Example: "TC-PR_yyyyxxxx"

productName string

Name of the product.

payload string | null

Encrypted custom data passed before the checkout process. It's highly recommended to encrypt this data on your end.

Requirements: <5000 characters

transactionStatus string<transactionStatus>

Current status of the transaction. Possible values:

Value	Description
TRANSACTION_STATUS_PENDING	Pending payment.
TRANSACTION_STATUS_REFUNDED	Refunded one-time payment product.
ONE_TIME_PAYMENT_STATUS_PAID	Paid one-time product.
SUBSCRIPTION_STATUS_ACTIVE	Active subscription.
SUBSCRIPTION_STATUS_ACTIVE_TRIAL	Active subscription in trial period.
SUBSCRIPTION_STATUS_CANCELLED_PENDING	Subscription cancellation in progress.
SUBSCRIPTION_STATUS_CANCELLED	Cancelled subscription.
VAULTED_STATUS_ACTIVE	Active vaulted product.
VAULTED_STATUS_INACTIVE	Inactive vaulted product.

createDate string<datetime>

Transaction create date.

Format: YYYY-MM-DDTHH:MM:SS.sZ

firstName string

First name of the customer.

lastName string

Last name of the customer.

organization string

Organization of the customer.

email string<email>

Email address used by the customer during purchase.

currency string<currency>

Currency code of the transaction.

Example: "USD"

webhookId string

Unique id of the webhook. If the webhook is retried the same unique id is used again.

Example: "uSKCLf8LOGkouEY"

webhookType string

Information about type of event.

Example: "SUBSCRIPTION_ACTIVATED"

whoCanceled string<whoCanceled> | null

Reason for cancellation in case of a canceled subscription or vaulted transaction. Possible values:

Value	Description
TRANSACTION_CLOUD_ADMIN	TransactionCloud.
VENDOR	Vendor.
CUSTOMER	Customer cancellation.
NEXT_CHARGE_FAILED	Failed next charge.

country string<countryCode>

Country where customer completed the payment.

Example: "US"

assignedEmail string<email> | null

Email address used by the customer during website sign-up. It will be null until you set it with the "Assign email" endpoint.

eventId string

Unique event number, helping to identify issues.

Example: "TC-BA_xxxyyyz"

amountTotal string

Total event amount.

taxAmount string

Total tax amount.

income string

Total income amount.

taxRate string

Tax rate for the transaction.

affiliateCommission string

Affiliate commission.

affiliateCommissionCurrency string

Currency of affiliates commission.

Example

                                
                                    Webhook Request
                                    
                                
                                {
    "webhookId": "qn8ixxv6jy4tReQ",
    "webhookType": "CHARGEBACK",
    "whoCanceled": null,
    "transactionId": "TC-TR_XXXYYZZ",
    "transactionType": "SUBSCRIPTION",
    "createDate": "2022-11-23T20:30:03.586Z",
    "productId": "TC-PR_1112233",
    "productName": "Product",
    "firstName": "customer_first_name",
    "lastName": "customer_last_name",
    "organization": "",
    "email": "customer@domain.com",
    "assignedEmail": "",
    "country": "US",
    "eventId": "TC-BA_DDDEEFF",
    "currency": "USD",
    "amountTotal": "-30.00",
    "taxAmount": "0.00",
    "income": "-30.00",
    "taxRate": "0.00",
    "affiliateCommission": "0.00",
    "affiliateCommissionCurrency": "USD"
}

VAULTED_SUBSCRIPTION_ACTIVATED

Webhook is sent after a vaulted subscription activated.

Webhook application/json

id string

Unique identification for the transaction.

Example: "TC-TR_xxyyxxx"

transactionType string<transactionType>

Type of product. Possible values:

Value	Description
ONETIME	One-time product transaction.
SUBSCRIPTION	Recurring product transaction.
VAULTED	Vaulted product transaction.

productId string

Unique product identificator.

Example: "TC-PR_yyyyxxxx"

productName string

Name of the product.

payload string | null

Encrypted custom data passed before the checkout process. It's highly recommended to encrypt this data on your end.

Requirements: <5000 characters

transactionStatus string<transactionStatus>

Current status of the transaction. Possible values:

Value	Description
TRANSACTION_STATUS_PENDING	Pending payment.
TRANSACTION_STATUS_REFUNDED	Refunded one-time payment product.
ONE_TIME_PAYMENT_STATUS_PAID	Paid one-time product.
SUBSCRIPTION_STATUS_ACTIVE	Active subscription.
SUBSCRIPTION_STATUS_ACTIVE_TRIAL	Active subscription in trial period.
SUBSCRIPTION_STATUS_CANCELLED_PENDING	Subscription cancellation in progress.
SUBSCRIPTION_STATUS_CANCELLED	Cancelled subscription.
VAULTED_STATUS_ACTIVE	Active vaulted product.
VAULTED_STATUS_INACTIVE	Inactive vaulted product.

createDate string<datetime>

Transaction create date.

Format: YYYY-MM-DDTHH:MM:SS.sZ

firstName string

First name of the customer.

lastName string

Last name of the customer.

organization string

Organization of the customer.

email string<email>

Email address used by the customer during purchase.

currency string<currency>

Currency code of the transaction.

Example: "USD"

webhookId string

Unique id of the webhook. If the webhook is retried the same unique id is used again.

Example: "uSKCLf8LOGkouEY"

webhookType string

Information about type of event.

Example: "SUBSCRIPTION_ACTIVATED"

whoCanceled string<whoCanceled> | null

Reason for cancellation in case of a canceled subscription or vaulted transaction. Possible values:

Value	Description
TRANSACTION_CLOUD_ADMIN	TransactionCloud.
VENDOR	Vendor.
CUSTOMER	Customer cancellation.
NEXT_CHARGE_FAILED	Failed next charge.

country string<countryCode>

Country where customer completed the payment.

Example: "US"

assignedEmail string<email> | null

Email address used by the customer during website sign-up. It will be null until you set it with the "Assign email" endpoint.

eventId string

Unique event number, helping to identify issues.

Example: "TC-BA_xxxyyyz"

amountTotal string

Total event amount.

taxAmount string

Total tax amount.

income string

Total income amount.

taxRate string

Tax rate for the transaction.

affiliateCommission string

Affiliate commission.

affiliateCommissionCurrency string

Currency of affiliates commission.

Example

                                
                                    Webhook Request
                                    
                                
                                {
    "webhookId": "qn8ixxv6jy4tReQ",
    "webhookType": "VAULTED_SUBSCRIPTION_ACTIVATED",
    "whoCanceled": null,
    "transactionId": "TC-TR_XXXYYZZ",
    "transactionType": "ONETIME",
    "createDate": "2022-11-23T20:30:03.586Z",
    "productId": "TC-PR_1112233",
    "productName": "Product",
    "firstName": "customer_first_name",
    "lastName": "customer_last_name",
    "organization": "",
    "email": "customer@domain.com",
    "assignedEmail": "",
    "country": "US",
    "eventId": "TC-BA_DDDEEFF",
    "currency": "USD",
    "amountTotal": "-30.00",
    "taxAmount": "0.00",
    "income": "-30.00",
    "taxRate": "0.00",
    "affiliateCommission": "0.00",
    "affiliateCommissionCurrency": "USD"
}

VAULTED_SUBSCRIPTION_DEACTIVATED

Webhook is sent after a vaulted subscription deactivated.

Webhook application/json

id string

Unique identification for the transaction.

Example: "TC-TR_xxyyxxx"

transactionType string<transactionType>

Type of product. Possible values:

Value	Description
ONETIME	One-time product transaction.
SUBSCRIPTION	Recurring product transaction.
VAULTED	Vaulted product transaction.

productId string

Unique product identificator.

Example: "TC-PR_yyyyxxxx"

productName string

Name of the product.

payload string | null

Encrypted custom data passed before the checkout process. It's highly recommended to encrypt this data on your end.

Requirements: <5000 characters

transactionStatus string<transactionStatus>

Current status of the transaction. Possible values:

Value	Description
TRANSACTION_STATUS_PENDING	Pending payment.
TRANSACTION_STATUS_REFUNDED	Refunded one-time payment product.
ONE_TIME_PAYMENT_STATUS_PAID	Paid one-time product.
SUBSCRIPTION_STATUS_ACTIVE	Active subscription.
SUBSCRIPTION_STATUS_ACTIVE_TRIAL	Active subscription in trial period.
SUBSCRIPTION_STATUS_CANCELLED_PENDING	Subscription cancellation in progress.
SUBSCRIPTION_STATUS_CANCELLED	Cancelled subscription.
VAULTED_STATUS_ACTIVE	Active vaulted product.
VAULTED_STATUS_INACTIVE	Inactive vaulted product.

createDate string<datetime>

Transaction create date.

Format: YYYY-MM-DDTHH:MM:SS.sZ

firstName string

First name of the customer.

lastName string

Last name of the customer.

organization string

Organization of the customer.

email string<email>

Email address used by the customer during purchase.

currency string<currency>

Currency code of the transaction.

Example: "USD"

webhookId string

Unique id of the webhook. If the webhook is retried the same unique id is used again.

Example: "uSKCLf8LOGkouEY"

webhookType string

Information about type of event.

Example: "SUBSCRIPTION_ACTIVATED"

whoCanceled string<whoCanceled> | null

Reason for cancellation in case of a canceled subscription or vaulted transaction. Possible values:

Value	Description
TRANSACTION_CLOUD_ADMIN	TransactionCloud.
VENDOR	Vendor.
CUSTOMER	Customer cancellation.
NEXT_CHARGE_FAILED	Failed next charge.

country string<countryCode>

Country where customer completed the payment.

Example: "US"

assignedEmail string<email> | null

Email address used by the customer during website sign-up. It will be null until you set it with the "Assign email" endpoint.

eventId string

Unique event number, helping to identify issues.

Example: "TC-BA_xxxyyyz"

amountTotal string

Total event amount.

taxAmount string

Total tax amount.

income string

Total income amount.

taxRate string

Tax rate for the transaction.

affiliateCommission string

Affiliate commission.

affiliateCommissionCurrency string

Currency of affiliates commission.

Example

                                
                                    Webhook Request
                                    
                                
                                {
    "webhookId": "qn8ixxv6jy4tReQ",
    "webhookType": "VAULTED_SUBSCRIPTION_DEACTIVATED",
    "whoCanceled": null,
    "transactionId": "TC-TR_XXXYYZZ",
    "transactionType": "ONETIME",
    "createDate": "2022-11-23T20:30:03.586Z",
    "productId": "TC-PR_1112233",
    "productName": "Product",
    "firstName": "customer_first_name",
    "lastName": "customer_last_name",
    "organization": "",
    "email": "customer@domain.com",
    "assignedEmail": "",
    "country": "US",
    "eventId": "TC-BA_xxxyyyz",
    "currency": "USD",
    "amountTotal": "-30.00",
    "taxAmount": "0.00",
    "income": "-30.00",
    "taxRate": "0.00",
    "affiliateCommission": "0.00",
    "affiliateCommissionCurrency": "USD"
}