GuidesRecipesAPI ReferenceChangelog
Log In
Changelog
Back to All

Version 2026-08-01

1 day ago by Mark Reilly

Release adding dispute search and retrieval, granular payment method saving, shopper contact details on checkout, native 3D Secure handling, and per-segment reward configuration.

Added

  • API - Disputes Resource Added
  • Disputes - Search Disputes - GET /2026-08-01/disputes
  • Disputes - Get Dispute - GET /2026-08-01/disputes/{disputeId}
  • Payment Methods - Update Payment Method - PATCH /2026-08-01/payment-methods/{id}
  • Webhooks - dispute.updated event schema documented (statuses: early_fraud_warning, lost, needs_response, request_for_information, under_review, warning_closed, warning_needs_response, warning_under_review, won)

Changed

  • Checkout - customer.savePaymentMethod (boolean) and customer.paymentMethodMetadata replaced by customer.existingPaymentMethodId for charging a card the customer has already saved - POST /2026-08-01/checkout-sessions, GET /2026-08-01/checkout-sessions/{id}
  • Checkout - Saving a card is now configured at proceed time via customer.savePaymentMethodOptions (futureUsage, externalReference, metadata) rather than at session creation - POST /2026-08-01/checkout-sessions/{id}/proceed
  • Checkout - Create Checkout Session now accepts an optional shopper object (email, phone) on the request and returns it on retrieve - POST /2026-08-01/checkout-sessions, GET /2026-08-01/checkout-sessions/{id}
  • Checkout - Proceed now accepts preferNativeActions to return a nativeNextAction instead of a redirectUrl when a 3D Secure challenge is required; redirectUrl is now nullable - POST /2026-08-01/checkout-sessions/{id}/proceed
  • Payments - customer.savePaymentMethod (boolean) and customer.paymentMethodMetadata replaced by customer.savePaymentMethodOptions (object) for more granular payment method save configuration - POST /2026-08-01/payments
  • Payments - Create Payment now accepts an optional shopper object (email, phone) - POST /2026-08-01/payments
  • Payment Links - Payment links now accept and return a customer object (id, savePaymentMethod, paymentMethodMetadata) to link a link to a customer and save their card - POST /2026-08-01/payment-links, PUT /2026-08-01/payment-links/{linkId}, GET /2026-08-01/payment-links, GET /2026-08-01/payment-links/{linkId}
  • Payment Links - List Payment Links sort parameters renamed from sortBy and sortOrder to by and direction - GET /2026-08-01/payment-links
  • Payment Links - billingAddress and shippingAddress are now nullable on requests and responses - POST /2026-08-01/payment-links, PUT /2026-08-01/payment-links/{linkId}
  • Addresses - Address fields now include stateOrProvince - POST /2026-08-01/payments, POST /2026-08-01/payment-links, PUT /2026-08-01/payment-links/{linkId}, POST /2026-08-01/checkout-sessions/{id}/proceed
  • Payment Methods - Create Payment Method now accepts an optional externalReference - POST /2026-08-01/payment-methods
  • Payment Methods - Payment method responses now include a card object (brand, last4, expiryMonth, expiryYear, holderName, walletType) and externalReference - GET /2026-08-01/payment-methods, GET /2026-08-01/payment-methods/{id}, POST /2026-08-01/payment-methods
  • Payment Methods - usage now includes UNKNOWN alongside OFF_SESSION and ON_SESSION - GET /2026-08-01/payment-methods, GET /2026-08-01/payment-methods/{id}, POST /2026-08-01/customers, GET /2026-08-01/customers/{id}, PATCH /2026-08-01/customers/{id}
  • Customers - Customer endpoints now support filtering by paymentMethodUsage - GET /2026-08-01/customers, GET /2026-08-01/customers/{id}
  • Customers - Customer responses now include the full card object and externalReference on nested payment methods - POST /2026-08-01/customers, GET /2026-08-01/customers/{id}, PATCH /2026-08-01/customers/{id}
  • Rewards - Reward configuration is now a list of per-segment entries, each with a customerSegment (CUSTOMER_NEW, CUSTOMER_EXISTING, MEMBER_NEW, MEMBER_EXISTING), replacing the single flat configuration - GET /2026-08-01/brands/{brandId}/reward-configuration, PUT /2026-08-01/brands/{brandId}/reward-configuration
  • Rewards - currency is now an explicit GBP / USD enum on reward calculations and reward configuration minimum spend - POST /2026-08-01/reward-calculations, PUT /2026-08-01/brands/{brandId}/reward-configuration
  • Payments - currency is now an explicit GBP / USD enum - POST /2026-08-01/payments, POST /2026-08-01/refunds, POST /2026-08-01/checkout-sessions/{id}/proceed
  • Payments - paymentMethodId is now a string rather than an object, and externalReference is nullable on the response - POST /2026-08-01/payments