UpSaleSuccess

It's the same as NewSaleSuccess, but with these additional parameters added. UpSaleSuccess has multiple versions; take care to use the appropriate version of that Webhook when coding for this Webhook.

Version 1 Version 2 Version 3 Version 4 Version 5 Version 6 Version 7

Version 1

Supported Formats: URL Encoded

Variable Name	Description	Data Type (Max Length)	Example Value
originalSubscriptionId	The Subscription ID associated with the original subscription, before an upgrade, upsale, or cross sale occurred.	string	0912187401000000099
originalClientAccnum	The Merchant Account Number associated with the original subscription, before an upgrade, upsale, or cross sale occurred.	int	900003
originalClientSubacc	The Merchant Sub Account Number associated with the original subscription, before an upgrade, upsale, or cross sale occurred.	short	0005
source	The source of an upgrade, upsale, cross sale, or cancellation.	string	FORM, API, or PHONE

Version 2

Supported Formats: URL Encoded

Version 2 of UpSaleSuccess includes the flexID variable.

Variable Name	Description	Data Type (Max Length)	Example Value
originalSubscriptionId	The Subscription ID associated with the original subscription, before an upgrade, upsale, or cross sale occurred.	string	0912187401000000099
originalClientAccnum	The Merchant Account Number associated with the original subscription, before an upgrade, upsale, or cross sale occurred.	int	900003
originalClientSubacc	The Merchant Sub Account Number associated with the original subscription, before an upgrade, upsale, or cross sale occurred.	short	0005
source	The source of an upgrade, upsale, cross sale, or cancellation.	string	FORM, API, or PHONE
flexID	Displays the Flex ID of a form if the form used is a FlexForm, does not appear if a FlexForm is not used.	UUID(36)	cb617dcc-8467-49ab-b3a7-735ce1d60ad9

Version 3

Supported Formats: URL Encoded, JSON

The changes to UpSaleSuccess in version 3 released on 2017-05-11 contain all of the previous parameters for version 2, with the addition of the bin variable.

Variable Name	Description	Data Type (Max Length)	Example Value
originalSubscriptionId	The Subscription ID associated with the original subscription, before an upgrade, upsale, or cross sale occurred.	string	0912187401000000099
originalClientAccnum	The Merchant Account Number associated with the original subscription, before an upgrade, upsale, or cross sale occurred.	int	900003
originalClientSubacc	The Merchant Sub Account Number associated with the original subscription, before an upgrade, upsale, or cross sale occurred.	short	0005
source	The source of an upgrade, upsale, cross sale, or cancellation.	string	FORM, API, or PHONE
flexID	Displays the Flex ID of a form if the form used is a FlexForm, does not appear if a FlexForm is not used.	UUID(36)	cb617dcc-8467-49ab-b3a7-735ce1d60ad9
bin	BIN of the Credit Card used	mediumint(6) unsigned	510510

Version 4

Supported Formats: URL Encoded, JSON

Version 4, released on 2019-07-23, added the expDate, last4, and paymentAccount fields.

Variable Name	Description	Data Type (Max Length)	Example Value
originalSubscriptionId	The Subscription ID associated with the original subscription, before an upgrade, upsale, or cross sale occurred.	string	0912187401000000099
originalClientAccnum	The Merchant Account Number associated with the original subscription, before an upgrade, upsale, or cross sale occurred.	int	900003
originalClientSubacc	The Merchant Sub Account Number associated with the original subscription, before an upgrade, upsale, or cross sale occurred.	short	0005
source	The source of an upgrade, upsale, cross sale, or cancellation.	string	FORM, API, or PHONE
flexID	Displays the Flex ID of a form if the form used is a FlexForm, does not appear if a FlexForm is not used.	UUID(36)	cb617dcc-8467-49ab-b3a7-735ce1d60ad9
bin	BIN of the Credit Card used	mediumint(6) unsigned	510510
expDate	Expiration Date for Credit Card or Payment Card provided.	smallint(4) unsigned zerofill	0217 (MMYY)
last4	Last 4 digits of the Credit Card number or Banking Account number.	smallint(4) unsigned zerofill	5100
paymentAccount	Hashed value of the cardId.	alpha-numeric hash	57bc7327b5d721d7d20b240c0357e6ed

Version 5

Supported Formats: URL Encoded, JSON

Version 5, released on 2022-04-21, added the scaResponseStatus field for strong customer authentication.

Variable Name	Description	Data Type (Max Length)	Example Value
originalSubscriptionId	The Subscription ID associated with the original subscription, before an upgrade, upsale, or cross sale occurred.	string	0912187401000000099
originalClientAccnum	The Merchant Account Number associated with the original subscription, before an upgrade, upsale, or cross sale occurred.	int	900003
originalClientSubacc	The Merchant Sub Account Number associated with the original subscription, before an upgrade, upsale, or cross sale occurred.	short	0005
source	The source of an upgrade, upsale, cross sale, or cancellation.	string	FORM, API, or PHONE
flexID	Displays the Flex ID of a form if the form used is a FlexForm, does not appear if a FlexForm is not used.	UUID(36)	cb617dcc-8467-49ab-b3a7-735ce1d60ad9
bin	BIN of the Credit Card used	mediumint(6) unsigned	510510
expDate	Expiration Date for Credit Card or Payment Card provided.	smallint(4) unsigned zerofill	0217 (MMYY)
last4	Last 4 digits of the Credit Card number or Banking Account number.	smallint(4) unsigned zerofill	5100
paymentAccount	Hashed value of the cardId.	alpha-numeric hash	57bc7327b5d721d7d20b240c0357e6ed
scaResponseStatus	Indicates the result of the 3DS enabled transaction.	char(1)	E, Y, N, A, U, R

Version 6

Supported Formats: URL Encoded, JSON

Version 6, released on 2025-02-17, includes optimizations and webhook event message processing improvements. No new parameters have been introduced in this release.

Variable Name	Description	Data Type (Max Length)	Example Value
originalSubscriptionId	The Subscription ID associated with the original subscription, before an upgrade, upsale, or cross sale occurred.	string	0912187401000000099
originalClientAccnum	The Merchant Account Number associated with the original subscription, before an upgrade, upsale, or cross sale occurred.	int	900003
originalClientSubacc	The Merchant Sub Account Number associated with the original subscription, before an upgrade, upsale, or cross sale occurred.	short	0005
source	The source of an upgrade, upsale, cross sale, or cancellation.	string	FORM, API, or PHONE
flexID	Displays the Flex ID of a form if the form used is a FlexForm, does not appear if a FlexForm is not used.	UUID(36)	cb617dcc-8467-49ab-b3a7-735ce1d60ad9
bin	BIN of the Credit Card used	mediumint(6) unsigned	510510
expDate	Expiration Date for Credit Card or Payment Card provided.	smallint(4) unsigned zerofill	0217 (MMYY)
last4	Last 4 digits of the Credit Card number or Banking Account number.	smallint(4) unsigned zerofill	5100
paymentAccount	Hashed value of the cardId.	alpha-numeric hash	57bc7327b5d721d7d20b240c0357e6ed
scaResponseStatus	Indicates the result of the 3DS enabled transaction.	char(1)	E, Y, N, A, U, R

Version 7

Supported Formats: URL Encoded, JSON

Version 7 was released on 2025-04-29 and the cardSubType field was added to specify the card type used in the transaction.

Variable Name	Description	Data Type (Max Length)	Example Value
originalSubscriptionId	The Subscription ID associated with the original subscription, before an upgrade, upsale, or cross sale occurred.	string	0912187401000000099
originalClientAccnum	The Merchant Account Number associated with the original subscription, before an upgrade, upsale, or cross sale occurred.	int	900003
originalClientSubacc	The Merchant Sub Account Number associated with the original subscription, before an upgrade, upsale, or cross sale occurred.	short	0005
source	The source of an upgrade, upsale, cross sale, or cancellation.	string	FORM, API, or PHONE
flexID	Displays the Flex ID of a form if the form used is a FlexForm, does not appear if a FlexForm is not used.	UUID(36)	cb617dcc-8467-49ab-b3a7-735ce1d60ad9
bin	BIN of the Credit Card used	mediumint(6) unsigned	510510
expDate	Expiration Date for Credit Card or Payment Card provided.	smallint(4) unsigned zerofill	0217 (MMYY)
last4	Last 4 digits of the Credit Card number or Banking Account number.	smallint(4) unsigned zerofill	5100
paymentAccount	Hashed value of the cardId.	alpha-numeric hash	57bc7327b5d721d7d20b240c0357e6ed
scaResponseStatus	Indicates the result of the 3DS enabled transaction.	char(1)	E, Y, N, A, U, R
cardSubType	The value specifies the card type used in the transaction	string	CREDIT, DEBIT, or OTHER

Appendix A: Currency Codes

Currency Numeric Code	Currency Letter Code	Currency Name
036	AUD	Australian Dollar
124	CAD	Canadian Dollar
392	JPY	Japanese Yen
826	GBP	United Kingdom Pound
840	USD	United States Dollar
978	EUR	Euro Member Countries

Appendix B: Decline Codes

Decline Code	Decline Text
1	Website is not available for signup
2	Unable to determine website signup requirements
3	Your card type is not accepted, please try another type of credit card
4	Banking System Error
5	The credit card you entered is not valid
6	Please check to ensure you entered your expiration date. Used to show individual corresponding yearly, monthly or daily dates for report data. The date function's format is year-month-day; for example, 2002-01-01. correctly
7	Please check to ensure you entered your bank account number correctly
8	Please check to ensure you entered your bank's routing number correctly
9	Banking System Error, please try again
10	Website has invalid pricing
11	Transaction Declined
12	You currently have a subscription and are unable to signup
13	You have already had a free trial
14	You must enter your CVV2 number on the back of your card
15	Your account is currently being processed, please check the website you are joining to see if you have access. If not, please contact support@ccbill.com
16	Subscription ID Provided is invalid
17	Subscription ID does not exist in system
18	Previous Transaction Attempt in request was declined
19	You are not authorized to signup with the provided credentials
20	No Decline
21	You have already had a trial, please select a normal recurring membership option
22	Error contacting bank, please try again later
23	Invalid Credit Card Provided
24	Transaction Denied by Bank
25	Bank Error
26	Card Processing Setup Incorrect for Merchant
27	System Error, Please Try Again
28	We are unable to process your transaction at this time. Please try again at a later time
29	Card Expired
30	We are unable to bill the telephone number provided for this transaction. Please return to the website and choose an alternate payment method.
31	Insufficient Funds
32	You must provide CVV2 to complete transaction
33	Unable to determine transaction type
34	Error contacting bank, please try again later
35	Card Declined at Pre-Auth SC
36	Unable To Contact Bank
37	We currently do not process for your bank's bin
38	Transaction Refused by Issuing Bank
39	You Have Submitted Too Many Times Today
40	The Card you are using is not accepted by this Merchant
41	Merchant Inactive
42	Incorrect Address Provided
43	We are unable to process your telephone billing transaction because your provider only allows for one charge, per telephone number, per day, and our records show that you have an existing daily charge to this telephone number. Please return to the website and choose an alternative payment method.
44	We're sorry, at this time prepaid cards are not allowed. Please try a different card type.
45	Transaction requires additional approval: please refer to your confirmation e-mail for further instructions.

Changelog

Release 12 - 2025-04-29

The cardSubType parameter was added to specify the card type used in the transaction.

Affected Webhooks

CrossSaleFailure (v5)
CrossSaleSuccess (v6)
NewSaleFailure (v5)
NewSaleSuccess (v8)
RenewalFailure (v5)
RenewalSuccess (v7)
UpgradeFailure (v4)
UpgradeSuccess (v5)
UpSaleFailure (v5)
UpSaleSuccess (v7)

Release 11 - 2025-02-17

Enhancements

Webhook event processing optimized.
No new parameters introduced.

Updated Event Versions

Void (v5)
BillingDateChange (v2)
Cancellation (v2)
Chargeback (v5)
CrossSaleFailure (v4)
CrossSaleSuccess (v5)
CustomerDataUpdate (v5)
Expiration (v2)
ManualAdd (v2)
NewSaleFailure (v4)
NewSaleSuccess (v7)
Refund (v5)
RenewalFailure (v4)
RenewalSuccess (v6)
Return (v5)
UpgradeFailure (v3)
UpgradeSuccess (v4)
UpSaleFailure (v4)
UpSaleSuccess (v6)
UserReactivation (v2)

Release 10 - 2022-04-21

Two new parameters were added to support 3DS authentication results.

New Parameters

paymentAccount
scaResponseStatus

Affected Webhooks

paymentAccount added to:

CrossSaleFailure (v3)
CrossSaleSuccess (v4)
UpSaleFailure (v3)
UpgradeFailure (v2)
UpgradeSuccess (v3)

scaResponseStatus added to:

CrossSaleFailure (v3)
CrossSaleSuccess (v4)
UpSaleFailure (v3)
UpSaleSuccess (v5)
UpgradeFailure (v2)
UpgradeSuccess (v3)

Release 9 - 2020-02-11

Added new parameter for tracking 3DS authentication results.

New Parameter

threeDSecure

Affected Webhooks

NewSaleSuccess (v6)
NewSaleFailure (v3)

Release 8 - 2019-07-23

New Parameters

expDate
last4
paymentAccount

Affected Webhooks

UpSaleSuccess (v4)

Release 7 - 2017-7-19

New Feature

Webhook delivery now supports JSON format in addition to URL Encoded.

Release 6 - 2017-06-01

New Parameters

paymentAccount
accountingCurrency
currency
billedCurrency

Affected Webhooks

paymentAccount added to:

CustomerDataUpdate (v4)
Chargeback (v4)
Refund (v4)
Return (v4)
RenewalSuccess (v5)
Void (v4)

accountingCurrency added to:

Chargeback (all versions)
Refund (all versions)
RenewalSuccess (all versions)
Void (all versions)

currency added to:

Chargeback (all versions)
Refund (all versions)
Void (all versions)

billedCurrency added to:

RenewalSuccess (all versions)

Release 5 - 2017-05-11

Three new parameters were added to enable merchants to track the card BIN, payment method, and type of card used.

New Parameters

bin
paymentType
cardType

Affected Webhooks

bin added to:

NewSaleSuccess (v5)
UpgradeSuccess (v2)
UpSaleSuccess (v3)
CrossSaleSuccess (v3)
CustomerDataUpdate (v3)
Chargeback (v3)

paymentType added to:

Chargeback (v3)
Return (v3)
Refund (v3)
RenewalSuccess (v4)
RenewalFailure (v3)
Void (v3)

cardType added to:

Chargeback (v3)
Refund (v3)
RenewalSuccess (v4)
RenewalFailure (v3)
Void (v3)

Release 4 - 2017-04-13

Security Enhancement

TLS 1.2 support added for secure transmission.

New Parameters

expDate Provides card expiration date.
last4 Returns last 4 digits of card/bank account.

Affected Webhooks

NewSaleSuccess (v4)
CustomerDataUpdate (v2)
Chargeback (v2)
Refund (v2)
RenewalSuccess (v3)
Void (v2)

Release 3 - 2014-04-24

New Feature

Added flexId variable to support FlexForms (Open Beta). The field only appears for FlexForm transactions.

Affected Webhooks

NewSalesSuccess (v3)
NewSalesFailure (v2)
Notes were added to related Webhooks (UpSaleSuccess, UpSaleFailure, CrossSaleSuccess, CrossSaleFailure) to reference the correct base versions.

Release 2 - 2013-10-30

New Features

Introduced versioning support for configurations and events.

Older configurations prompt upgrade option.

New Webhooks Event

Return - Notifies users of check returns.

New Parameters

paymentAccount
renewalDate

Affected Webhooks

paymentAccount field added to:

NewSaleSuccess (v2)

renewalDate field added to:

RenewalSuccess (v2)
RenewalFailure (v2)

Bug Fixes

Fixes a bug that resulted in incorrect POST of the failureCode, failureReason, and transactionId fields in CrossSales, CrossSaleAPI, and Upgrades with specialOffer.
Fixes a bug that resulted in incorrect POST of failureCode, failureReason, and transactionId fields for Upsales.
Fixes a bug that caused the subscriptionTypeId to be incorrectly sent.

Release 1 - Initial Release

No notable changes included.