Contains the latest version changes to the API Reference

[2026-04-01]

Release adding Customer update support, expanded filtering, flexible order metadata date formats across payment flows and support for recurring payments.

Added

Customers - Update Customer - PATCH /2026-04-01/customers/{id}

Changed

Customers - List Customers now supports filtering by emailAddress - GET /2026-04-01/customers
Payments - Order metadata line item dates now accept both date and datetime formats - POST /2026-04-01/payment-intent
Payment Links - Order metadata line item dates now accept both date and datetime formats - POST /2026-04-01/payment-links, PUT /2026-04-01/payment-links/{linkId}
Checkout Session - Updated with latest request/response structure - POST /2026-04-01/checkout-sessions, GET /2026-04-01/checkout-sessions/{id}, POST /2026-04-01/checkout-sessions/{id}/proceed
Checkout Session - Customer object added to /2026-04-01/checkout-sessions to support recurring payments
Checkout Session - lineItems object to accept additional Airline data, POST /2026-04-01/checkout-sessions/{id}/proceed

[2025-11-01]

Major release introducing Payment Methods, Settlements, and Transaction reporting APIs, along with structured decline code support across payment and checkout flows.

Added

API - Payment Methods Resource Added
Payment Methods - Create Payment Method - POST /2025-11-01/payment-methods
Payment Methods - List Payment Methods - GET /2025-11-01/payment-methods
Payment Methods - Get Payment Method - GET /2025-11-01/payment-methods/{id}
Payment Methods - Create Setup Intent - POST /2025-11-01/payment-methods/{id}/setup-intents
API - Settlements Resource Added
Settlements - List Settlements - GET /2025-11-01/settlements
Settlements - Get Settlement Detail - GET /2025-11-01/settlements/{settlementId}
Settlements - Get Settlement Reconciliation - GET /2025-11-01/settlements/{settlementId}/reconciliation
API - Transaction Search Added
Transactions - Search Payment Transactions - GET /2025-11-01/payments/search
API - Payment Intent Resource Added
Payments - Create Payment Intent - POST /2025-11-01/payment-intent
Refunds - Create Payout Refund (Restricted) - POST /2025-11-01/refunds/payouts

Changed

Payments - Create Payment Intent now returns 402 responses with structured decline codes (declineCode, declineReason, declineClassification) - POST /2025-11-01/payment-intent
Checkout - Proceed endpoint now returns 402 responses with structured decline codes - POST /2025-11-01/checkout-sessions/{id}/proceed
Customers - Added externalReference as an allowed filter on List Customers - GET /2025-11-01/customers

[2025-06-01]

Breaking change to Authentication mechanism with new API key format new sk_prod... and sktest.... PaymentInitiator now required on payment and checkout session resources_

Added

Payments (breaking) - Now requires paymentInitiatorId for payment creation
Checkout Session (breaking) - Now requires paymentInitiatorId for session creation and proceed requests
API - Payment Links Resource Added
Payment Links - Create Payment Link - POST /2025-06-01/payment-links
Payment Links - Get Payment Link - GET /2025-06-01/payment-links/{linkId}
Payment Links - Update Payment Link - PUT /2025-06-01/payment-links/{linkId}
Payment Links - Delete Payment Link - DELETE /2025-06-01/payment-links/{linkId}
Payment Links - List Payment Links - GET /2025-06-01/payment-links

Changed

API (breaking) - Only supporting the authorization header with new skprod... and sktest... api key format

[2025-02-01]

Refund response now includes a funding breakdown to support reconciliation.

Changed

Refunds: Create Refund response now includes fundingSummary showing the breakdown of how the refund amount is funded across four sources: cashPayableToMerchant, customerFundedAmount, superFundedAmount, and merchantFundedAmount - POST /2025-02-01/refunds

[2024-10-01]

The Embedded Payment product line was introduced.

Added

API - Checkout Session Resource Added
Checkout - Checkout Session Create - POST /2024-10-01/checkout-sessions
Checkout - Checkout Session Query - GET /2024-10-01/checkout-sessions/{id}
Checkout - Checkout Session Proceed - POST /2024-10-01/checkout-sessions/{id}/proceed

[2024-02-01]

The Instant Cashback product has been retired in favour of Cash Rewards, this release removes endpoints only relevant for that product line.

Removed

Instant Cashback (breaking): Cashback Calculation - POST /{version}/offers
Instant Cashback (breaking): Cashback Expiry - POST /{version}/offers/{id}/expiry

Added

Rewards - Reward Calculation - POST /2024-02-01/reward-calculations
API - New calendar based version for the API version
API - Version returned in response headers for all requests to the API
API - API supports Rate limiting
API - Errors returned by the API conform to RFC 9457 - Problem Details for HTTP APIs

[v2] - 2023-01-01

First release.

Added

Instant Cashback Cashback Calculation - POST /v2/offers
Instant Cashback Cashback Expiry - POST /v2/offers/\{id}/expiry
Payments Payment Initiation - POST /v2/payments
Payments Payment Query - GET /v2/payments/\{id}
Payments Payment Search - GET /v2/payments
Refund Refund Initiation - POST /v2/refunds
Refund Refund Query - GET /v2/refunds/\{id}
Refund Refund Search - GET /v2/refunds

Changelog