Versioning policy
The SmartRetry API uses date-based versioning. The current version is 2026-04-01.- Non-breaking changes (new fields, new endpoints) are added without a version bump
- Breaking changes require a new API version with a deprecation period
- Deprecated versions are supported for 12 months after deprecation
Breaking changes are rare. We design the API to be additive - new features won’t break existing integrations.
2026
October 2026
2026-10-21- Breaking path change: Transaction status is now
GET /v1/payments/status/{terminal_friendly_id}/{order_id}/{transaction_id}. Theorder_idis returned by sale and pre-authorization. - New Complete payer actions endpoint to submit the payer’s responses to pending actions.
- Transaction status now returns
payer_action_urlandhosted_page_url. Sale and pre-authorization returnhosted_page_urlforpayment_collection: hosted_page. - Renamed the request field
submission_sessiontotransaction_session. - Risk blocks now use the single status reason
RISK/BLOCKED. Seerisk_decisionfor the blocking policies. - Added the status reason
PROCESSOR/UNAVAILABLE. - Added
payment_instrument.provider_shopper_reference, the AdyenshopperReferencefor aprovider_token. It is required whenprovider_keyisadyen.
April 2026
2026-04-01- Added multi-language code examples (Python, Node.js) to all API reference pages
- New webhooks documentation with signature verification examples
- Added rate limiting guide with exponential backoff examples
March 2026
2026-03-15- Added
Idempotency-Keyheader support for all POST endpoints - New idempotency documentation explaining replay behavior
- Added
X-Idempotency-Replayedresponse header
- Introduced future transactions API for managing scheduled recurring payments
- New endpoints: charge, status, update, cancel
February 2026
2026-02-15- Added
card_profileobject to transaction status responses - New fields:
issuer.name,brand.name,category,cardType - BIN lookup data now included automatically
- Changed amount representation from minor units to major currency units
- Migration: Divide existing amounts by 100 (e.g.,
4999→49.99) - Added support for zero-decimal currencies (JPY, KRW) and three-decimal currencies (KWD, BHD)
January 2026
2026-01-15- New recurring billing endpoints: init, charge, status, update, cancel
- Three management modes:
merchant,our_platform,payment_provider
- Initial public release of SmartRetry API v1
- Core payment endpoints: sale, pre-auth, capture, refund, void, status
- Authentication via
x-api-keyheader - Sandbox environment available
Deprecation notices
Upcoming changes
We announce planned changes here before release:- Q2 2026: Webhook delivery receipts - confirm delivery status via API
- Q2 2026: Bulk transaction export endpoint
- Q3 2026: Additional payment methods (ACH, SEPA)