What's Changing

As we enhance our data storage engine and streamline reporting we are taking the opportunity to change the type of model and response for some of our API operations to properly classify them as events. This will lead to a more concise and clear API with advanced filtering capabilities to facilitate easier investigation of payment method and transaction activities.

The following transactions will no longer be returned from the get call to /transactions (or by payment method /payment_methods/[token]/transactions) UpdatePaymentMethod, RedactPaymentMethod, AddPaymentMethod, RecacheSensitiveData, RetainPaymentMethod, CardHolderOptOut, ClosePaymentMethod, ContactCardHolder, InvalidReplacePaymentMethod, NoUpdate, NonParticipating, ReplacePaymentMethod, and UnknownToNetwork)

They will be available under a new endpoint and format /payment_methods/events and /payment_methods/[token]/events

To get feature parity of a chronological history of payment method events and associated payment activity you can use the flag ?include_transactions=true which will return you both transactions and events from these new events endpoints.

Similarly FraudControl::Detection, Protection::Check, Sca::Authentication, Inquiry, DeviceBindingTransaction, EnrollDeviceTransaction, SelectCvMethodTransaction, SigningPayloadTransaction, UnbindDeviceTransaction, and ValidateOtpTransaction will no longer be returned from the /transactions or /payment_methods/[token]/transactions get calls but will be available under new endpoints

v1/card_refresher/inquiries
v1/ctf/events
v1/protection/events

The new format for all of these events is described further below in our guide, however we are keeping the format as consistent as possible to avoid requiring reintegration for POST or payment API calls.

There are no changes to receiver based transactions (such as DeliverPaymentMethod) or gateway based transactions (such as Purchase). Additionally, there will be no changes to the transactional API response structure or callback response for any transaction types.

Why?

As Spreedly advances our storage capabilities and streamlines internal and external reporting and debugging capabilities we are taking advantage of underlying technology to provide appropriate APIs for specific classes of events that were historically not broken out clearly and were often grouped inappropriately with payment activity.

What You Need to Do

If you are using the API to retrieve records of the transactions that are moving then please review your integration to ensure it can handle the new event object format and uses the event APIs wherever you are using them for investigation or reporting purposes.

Action Required We strongly recommend using the new APIs for events and transitioning any dependent code to use the new object formats as soon as possible

We will be rolling these changes over a 60 day period starting October 1 to ease the transition and allow customers to test the new endpoints and transition before we finalize the update. Once we finalize the update the data is only available in the new patterns.

Here is a step-by-step guide to get you started on your development.

DURING the transition and testing window Oct 1 - Nov 30:

There will be no API changes to the /transactions or /payment_methods/[token]/transactions route API calls
The new events endpoints will be populated with data and will be callable (get calls only) and will show the new information as described in our API docs above with the new formats described.
We will be allowing the tokens from transactions to be used in the new event APIs so you can test the new APIs and formats while the existing endpoints are left unchanged while customers migrate their integrations.
- We strongly recommend ceasing to use /transactions and /payment_methods/[token]/transactions if you wish to see any of the data classified above
- We will have data parity using the /payment_methods/events?include_transactions=true and /payment_methods/[token]/events?include_transactions=true and we recommend transitioning to these endpoints to continue to receive the full chronological stream of data as we provide it today

AFTER the transition and testing period - Starting Dec 12:

Event data as classified above will cease to be visible on the /transactions and /payment_methods/[token]/transactions endpoints
The tokens returned for the transaction types listed above will be an Event token and not a Transaction token
- You can use the Event token on the /payment_methods/events/[token] endpoint to get it’s full details under the new format described above

If you would like to discuss this further, please reach out to your account manager or our support team.

Endpoints Before and After

Resource	Endpoint	Data types returned DURING the transition and testing window	Data types returned AFTER the transition and testing window	Impacted data types
Events	`v1/events`	AddGateway, RedactGateway, RetainGateway, UpdateGateway, AddPaymentMethodReceiver, RedactPaymentMethodReceiver, UpdatePaymentMethodReceiver, UpdateEnvironment, AddEnvironment, AddAccessSecret, AddCertificate, UpdateCertificate, AddSubMerchant, UpdateSubMerchant, UpdateMerchantProfile, AddMerchantProfile	AddGateway, RedactGateway, RetainGateway, UpdateGateway, AddPaymentMethodReceiver, RedactPaymentMethodReceiver, UpdatePaymentMethodReceiver, UpdateEnvironment, AddEnvironment, AddAccessSecret, AddCertificate, UpdateCertificate, AddSubMerchant, UpdateSubMerchant, UpdateMerchantProfile, AddMerchantProfile, AddScaProvider, AddFraudControlVendor	ADDED: AddFraudControlVendor
Events	`v1/events/[token]`	AddGateway, RedactGateway, RetainGateway, UpdateGateway, AddPaymentMethodReceiver, RedactPaymentMethodReceiver, UpdatePaymentMethodReceiver, UpdateEnvironment, AddEnvironment, AddAccessSecret, AddCertificate, UpdateCertificate, AddSubMerchant, UpdateSubMerchant, UpdateMerchantProfile, AddMerchantProfile	AddGateway, RedactGateway, RetainGateway, UpdateGateway, AddPaymentMethodReceiver, RedactPaymentMethodReceiver, UpdatePaymentMethodReceiver, UpdateEnvironment, AddEnvironment, AddAccessSecret, AddCertificate, UpdateCertificate, AddSubMerchant, UpdateSubMerchant, UpdateMerchantProfile, AddMerchantProfile, AddScaProvider, AddFraudControlVendor	ADDED: AddFraudControlVendor
Gateways	v1/gateways/[gateway_token]/transactions	Authorization, AuthorizationViaReference, Capture, Credit, GeneralCredit, OffsiteAuthorization, OffsiteSynchronousAuthorization, OffsitePurchase, OffsiteSynchronousPurchase, Purchase, PurchaseViaPreauthorization, Store, PurchaseViaReference, RedactPaymentMethod (if TPV), Verification, Void	Authorization, AuthorizationViaReference, Capture, Credit, GeneralCredit, OffsiteAuthorization, OffsiteSynchronousAuthorization, OffsitePurchase, OffsiteSynchronousPurchase, Purchase, PurchaseViaPreauthorization, Store, PurchaseViaReference, Verification, Void	REMOVED: RedactPaymentMethod (if TPV)
Payment Methods	v1/payment_methods/[payment_method_token}]transactions	Authorization, AuthorizationViaReference, Capture, Credit, GeneralCredit, OffsiteAuthorization, OffsiteSynchronousAuthorization, OffsitePurchase, OffsiteSynchronousPurchase, Purchase, PurchaseViaPreauthorization, Store, PurchaseViaReference, RedactPaymentMethod (if TPV), Verification, Void, UpdatePaymentMethod, RedactPaymentMethod, AddPaymentMethod, RecacheSensitiveData, RetainPaymentMethod, CardHolderOptOut, ClosePaymentMethod, ContactCardHolder, InvalidReplacePaymentMethod, NoUpdate, NonParticipating, ReplacePaymentMethod, UnknownToNetwork, FraudControl::Detection, Protection::Check, Sca::Authentication, Inquiry, UpdateTransaction, DeviceBindingTransaction, EnrollDeviceTransaction, SelectCvMethodTransaction, SigningPayloadTransaction UnbindDeviceTransaction, ValidateOtpTransaction	Adjust, Authorization, AuthorizationViaReference, Capture, Credit, GeneralCredit, OffsiteAuthorization, OffsiteSynchronousAuthorization, OffsitePurchase, OffsiteSynchronousPurchase, Purchase, PurchaseViaPreauthorization, Store, PurchaseViaReference, Verification, Void	REMOVED: UpdatePaymentMethod, RedactPaymentMethod, AddPaymentMethod, RecacheSensitiveData, RetainPaymentMethod, CardHolderOptOut, ClosePaymentMethod, ContactCardHolder, InvalidReplacePaymentMethod, NoUpdate, NonParticipating, ReplacePaymentMethod, UnknownToNetwork, FraudControl::Detection, Protection::Check, Sca::Authentication, Inquiry, UpdateTransaction, DeviceBindingTransaction, EnrollDeviceTransaction, SelectCvMethodTransaction, SigningPayloadTransaction UnbindDeviceTransaction, ValidateOtpTransaction
Payment Methods	v1/payment_methods/events	UpdatePaymentMethod, RedactPaymentMethod, AddPaymentMethod, RecacheSensitiveData, RetainPaymentMethod, CardHolderOptOut, ClosePaymentMethod, ContactCardHolder, InvalidReplacePaymentMethod, NoUpdate, NonParticipating, ReplacePaymentMethod, UnknownToNetwork	UpdatePaymentMethod, RedactPaymentMethod, AddPaymentMethod, RecacheSensitiveData, RetainPaymentMethod, CardHolderOptOut, ClosePaymentMethod, ContactCardHolder, InvalidReplacePaymentMethod, NoUpdate, NonParticipating, ReplacePaymentMethod, UnknownToNetwork	NEW
Payment Methods	v1/payment_methods/[payment_method_token]/events	UpdatePaymentMethod, RedactPaymentMethod, AddPaymentMethod, RecacheSensitiveData, RetainPaymentMethod, CardHolderOptOut, ClosePaymentMethod, ContactCardHolder, InvalidReplacePaymentMethod, NoUpdate, NonParticipating, ReplacePaymentMethod, UnknownToNetwork	UpdatePaymentMethod, RedactPaymentMethod, AddPaymentMethod, RecacheSensitiveData, RetainPaymentMethod, CardHolderOptOut, ClosePaymentMethod, ContactCardHolder, InvalidReplacePaymentMethod, NoUpdate, NonParticipating, ReplacePaymentMethod, UnknownToNetwork	NEW
Payment Methods	v1/payment_methods/[payment_method_token]/events?include_transactions=true	Authorization, AuthorizationViaReference, Capture, Credit, GeneralCredit, OffsiteAuthorization, OffsiteSynchronousAuthorization, OffsitePurchase, OffsiteSynchronousPurchase, Purchase, PurchaseViaPreauthorization, Store, PurchaseViaReference, RedactPaymentMethod (if TPV), Verification, Void, UpdatePaymentMethod, RedactPaymentMethod, AddPaymentMethod, RecacheSensitiveData, RetainPaymentMethod, CardHolderOptOut, ClosePaymentMethod, ContactCardHolder, InvalidReplacePaymentMethod, NoUpdate, NonParticipating, ReplacePaymentMethod, UnknownToNetwork, FraudControl::Detection, Protection::Check, Sca::Authentication, Inquiry, UpdateTransaction, DeviceBindingTransaction, EnrollDeviceTransaction, SelectCvMethodTransaction, SigningPayloadTransaction UnbindDeviceTransaction, ValidateOtpTransaction	Authorization, AuthorizationViaReference, Capture, Credit, GeneralCredit, OffsiteAuthorization, OffsiteSynchronousAuthorization, OffsitePurchase, OffsiteSynchronousPurchase, Purchase, PurchaseViaPreauthorization, Store, PurchaseViaReference, RedactPaymentMethod (if TPV), Verification, Void, UpdatePaymentMethod, RedactPaymentMethod, AddPaymentMethod, RecacheSensitiveData, RetainPaymentMethod, CardHolderOptOut, ClosePaymentMethod, ContactCardHolder, InvalidReplacePaymentMethod, NoUpdate, NonParticipating, ReplacePaymentMethod, UnknownToNetwork, FraudControl::Detection, Protection::Check, Sca::Authentication, Inquiry, UpdateTransaction, DeviceBindingTransaction, EnrollDeviceTransaction, SelectCvMethodTransaction, SigningPayloadTransaction UnbindDeviceTransaction, ValidateOtpTransaction	NEW
Transactions	v1/transactions/[transaction_token]	Authorization, AuthorizationViaReference, Capture, Credit, GeneralCredit, OffsiteAuthorization, OffsiteSynchronousAuthorization, OffsitePurchase, OffsiteSynchronousPurchase, Purchase, PurchaseViaPreauthorization, Store, PurchaseViaReference, RedactPaymentMethod (if TPV), Verification, Void, UpdatePaymentMethod, RedactPaymentMethod, AddPaymentMethod, RecacheSensitiveData, RetainPaymentMethod, CardHolderOptOut, ClosePaymentMethod, ContactCardHolder, InvalidReplacePaymentMethod, NoUpdate, NonParticipating, ReplacePaymentMethod, UnknownToNetwork, FraudControl::Detection, Protection::Check, Sca::Authentication, Inquiry, UpdateTransaction, DeviceBindingTransaction, EnrollDeviceTransaction, SelectCvMethodTransaction, SigningPayloadTransaction UnbindDeviceTransaction, ValidateOtpTransaction, DeliverPaymentMethod, ExportPaymentMethod	Authorization, AuthorizationViaReference, Capture, Credit, GeneralCredit, OffsiteAuthorization, OffsiteSynchronousAuthorization, OffsitePurchase, OffsiteSynchronousPurchase, Purchase, PurchaseViaPreauthorization, Store, PurchaseViaReference, Verification, Void, DeliverPaymentMethod, ExportPaymentMethodAdjust, Authorization, AuthorizationViaReference, Capture, Credit, GeneralCredit, OffsiteAuthorization, OffsiteSynchronousAuthorization, OffsitePurchase, OffsiteSynchronousPurchase, Purchase, PurchaseViaPreauthorization, Store, PurchaseViaReference, Verification, Void, DeliverPaymentMethod, ExportPaymentMethod	REMOVED: UpdatePaymentMethod, RedactPaymentMethod, AddPaymentMethod, RecacheSensitiveData, RetainPaymentMethod, CardHolderOptOut, ClosePaymentMethod, ContactCardHolder, InvalidReplacePaymentMethod, NoUpdate, NonParticipating, ReplacePaymentMethod, UnknownToNetwork, FraudControl::Detection, Protection::Check, Sca::Authentication, Inquiry, UpdateTransaction, DeviceBindingTransaction, EnrollDeviceTransaction, SelectCvMethodTransaction, SigningPayloadTransaction UnbindDeviceTransaction, ValidateOtpTransaction
card_refresher	v1/card_refresher/inquiries	Inquiry	Inquiry	NEW
card_refresher	v1/card_refresher/inquiries/[inquiry_key]	Inquiry	Inquiry	NEW
ctf	v1/ctf/event/[event_key]	AuthenticatedTokenEvent	AuthenticatedTokenEvent	NEW
protection	v1/protection/events	FraudControl::Detection, Protection::Check, Sca::Authentications	FraudControl::Detection, Protection::Check, Sca::Authentications	NEW
protection	v1/protection/events/[event_key]	FraudControl::Detection, Protection::Check, Sca::Authentications	FraudControl::Detection, Protection::Check, Sca::Authentications	NEW
protection	v1/protection/events/[event_key]/transcript	raw text of transcript for associated event	raw text of transcript for associated event	NEW

FAQs

Will I be losing any access to data?

No, Spreedly will continue to store and expose the same amount of data but, in an effort to modernize our API, we are re-organizing these data types.

Is anything changing to receiver and gateway transactions such as DeliverPaymentMethod or Purchase?

No, these transaction types will remain untouched

Do I need to update my response handling at transaction, tokenization, or callback delivery time?

No, Spreedly is not changing the response structure for callbacks or at transaction time.

What about historical data?

The old endpoints will continue to show historical data showing information prior to December 12th, 2025. The new endpoints will have data starting October 1st, 2025

Will Spreedly be deprecating the existing transaction search and list endpoints?

No, Spreedly is not deprecating or planning to remove any endpoint, just altering what data types are available within a select few endpoints.