Changelog

2026 Q1 Changelog

Date (YYYY-MM-DD)	Category	Notes
3/12/2027	Payments Reference Guide	Updated to remove paymentUrlType references. This field is optional and not used, so this is a documentation cleanup only and does not introduce breaking behavior for existing integrations.
2026-03-07	Payments	Updated the Payments documentation set to align authentication and endpoint guidance across overview and workflow pages. Clarified that new Payments integrations use X-Api-Key, preserved legacy OAuth guidance only where applicable, corrected Payments endpoint references to POST /Payments/crypto, added clearer request guidance for terminals with type = virtual versus type = physical, refined Payment Statuses to emphasize operational status handling and reclaim scenarios, and updated Payment Webhooks to reinforce webhook-first event handling and terminal webhook configuration using the supported methods.
2026-03-07	Onboarding	Updated Submit Application to use the plural onboarding endpoints, align request guidance to signerInfo, clarify when to use the full versus minimal application flows, and reinforce that both flows use API-key-based onboarding requests and return identifiers for downstream status tracking.
2026-03-07	FAQs	Updated How to Test Klarna Payments to use X-Api-Key header authentication, corrected Payments endpoint references to POST /Payments/crypto, and clarified Klarna request requirements by terminal type, including different minimum fields for virtual versus physical terminals.
2026-03-07	FAQs	Updated Sandbox and production URLs to clarify environment-specific base URLs and authentication patterns, distinguish Payments and onboarding API key usage from OAuth-based flows, correct the Payments reference to POST /Payments/crypto, and note that payment request field requirements can vary by terminal configuration and tender flow.
2026-03-07	Onboarding	Updated Onboarding to use the plural application endpoints, align onboarding terminology to signerInfo, clarify that API-initiated onboarding emails the merchant signer a secure link, and describe full versus minimal application flows using current API-key-based onboarding guidance.
2026-03-07	Onboarding	Refreshed Get Status to focus on the most important operational response fields such as id, merchantName, status, and onboardedMerchantId, align endpoint references to the plural onboarding paths, and remove unnecessary nested response detail in favor of the spec for full schema coverage.
2026-03-07	Onboarding	Updated Resend Application to use the plural onboarding endpoints, clarify that the resend flow sends an existing application back to the same merchant signer for correction or completion, and position resend as a way to preserve the original application record while continuing the hosted onboarding flow.
2026-03-06	Introduction	Clarified Introduction authentication guidance across API families, aligned onboarding terminology to signerInfo, and noted that API-initiated onboarding emails the merchant signer a secure link.
2026-03-06	Authentication	Updated Authentication to distinguish API key versus OAuth usage, added onboarding API key guidance, and corrected Payments endpoint references to POST /Payments/crypto.
2026-03-06	Entity Management	Refreshed Entity Management to better describe API purpose, align onboarding wording to signerInfo, and clarify authentication guidance for onboarding versus other flows.
2026-03-06	Terminal Management	Updated Terminal Management to correct the terminal update method to PUT /Terminals/{id} and clarify terminal lifecycle guidance, including update, disable, and delete behavior.
2026-02-27	Onboarding	Updated Webhooks for Application Events to include webhook registration and deletion using onboarding API keys (X-Api-Key) with legacy bearer token examples retained, plus request/response samples for endpointUrl, eventTypes, and optional webhookSecret guidance.
2026-02-27	FAQs	Added Can I view payments with a Payment API key? FAQ page with a terminalId-based payment history example (GET /Payments), plus pagination basics and a link to Pagination and sorting.
2026-02-23	Payments	Added a new page: Crypto Wallet Flow and Amounts. Explains when consumers are expected to manually enter the amount after scanning a crypto QR code, and why some rails like Bitcoin Lightning can include the amount in the QR experience.
2026-02-20	Reference Guide	Added Identifiers and Keys guidance covering the expected formats for common IDs (for example merchantId and terminalId) and API keys, including simple format checks to help integrators catch copy paste errors early.
2026-02-10	Onboarding	Updated the Submit Application documentation to match the current onboarding API schema. Revised field names and required fields, added location business type guidance, updated fee requirements to include monthlyMaintenanceFee and isBilledByPartner, corrected seasonality and MCC fields, and refreshed the full and minimal request examples plus cURL samples to validate against the latest spec.
2026-02-10	Payments	Added a new Payments documentation page: Receipts. Provides guidance on extending your existing POS or checkout receipt when supporting Bead payment methods, including which Bead reference value to display and how optional Bead delivered receipts work (emailReceipt, smsReceipt).
2026-01-30	Payments	Updated Payments documentation to clarify underpaid and overpaid behavior, including recommended integrator handling and reclaim outcomes.
2026-01-30	Reference Guide	Updated Payment Scenarios guidance for underpaid, overpaid, and reclaiming unconverted crypto to align with current product behavior and customer reclaim steps.
2026-01-30	Quick Start	Updated Quick Start to include underpayment and overpayment outcomes, reclaim email expectations, and recommended confirmation patterns.
2026-01-27	FAQs	Added Test Data Guidelines: Email Addresses page with guidance for automated testing to use valid, deliverable email addresses and to ensure each application uses a unique email (recommended plus addressing with timestamp or sequence counter) to reduce undeliverable email noise and duplicate email conflicts.
2026-01-19	FAQs	Clarified that applications cannot be deleted once submitted due to compliance requirements. Added guidance on managing test applications. Can I delete test or submitted applications?
2026-01-19	Reference Guide	Removed references to client secrets and client credential grant flows from the documentation to reflect the current authentication models in use.
2026-01-19	Onboarding	Clarified required fields for minimal onboarding applications and updated the Sample Payload documentation to include full fee information, reflecting the minimum data needed for applications sent directly to signing.

2025 Q4 Changelog

Date (YYYY-MM-DD)	Category	Notes
2025-12-30	Entity Management	Added Managing Tender Types documentation to the Terminal Management section to explain how tender types are configured and applied at the terminal level.
2025-12-30	FAQs	Added Entity Management FAQs and Managing Tender Types FAQ to centralize common questions related to entity configuration and tender type inheritance.
2025-12-20	Payments	Updated Payments docs to make terminal API key the preferred auth method for Payments requests. Refreshed Payments landing page plus core flow pages to use X-Api-Key and removed OAuth token language as the primary path (legacy OAuth password grant remains documented for existing integrators).
2025-12-20	Payments	Updated Create Payment and Payment Statuses to clarify that GET /Payments/tracking/{trackingId} uses the same API key model as POST /Payments/crypto, including updated curl examples, headers, and 401/403 troubleshooting guidance.
2025-12-20	FAQs	Updated Payments troubleshooting and testing pages to align with API key auth, including guidance for 401 and 403 outcomes and environment mismatch checks (Sandbox vs Production).
2025-12-20	Reference Guide	Updated Reference Guide and Endpoint Index materials to reflect split auth model: Payments use X-Api-Key, other APIs use OAuth. Updated Download OpenAPI / Postman guidance to include a Payments API key environment variable and example request patterns for Payments.
2025-12-09	FAQs	Aligned the example response with the POST /payments/crypto schema by using paymentUrls as a string array and including paymentPageId. Updated instructions to launch the hosted checkout using the URL from the paymentUrls array instead of the previous object based paymentUrls[0].url pattern. Clarified that Klarna tests follow the same payment creation, hosted page, and status verification flow described in the Payments and Quick Start sections.
2025-12-09	Payments	Updated Create Payment page to use the same response model as the API (trackingId, paymentPageId, paymentUrls as an array of hosted payment URLs) and removed the outdated paymentUrls.type and paymentUrls.url object pattern. Clarified how integrators should use paymentUrls and paymentPageId together, including when to store trackingId and paymentPageId for later status checks or Payment Pages operations. Ensured examples and step text match the OpenAPI specification and the Payment Statuses and Payment Webhooks pages.
2025-12-09	Quick Start	Replaced legacy POST /payments example with POST /payments/crypto using the current CryptoPaymentResponse shape (trackingId, paymentPageId, paymentUrls string array). Aligned authentication snippet with current Identity realms and token URL, and clarified how to use the returned access_token across API calls. Updated status check step to use GET /payments/tracking/{trackingId} with enum statusCode values and clarified when to use polling versus webhooks. Refreshed step descriptions so the end to end Sandbox example matches the Payments section and OpenAPI specification.
2025-12-08	Reference Guide	Added Crypto and Wallet Concepts for Integrators page under Core Concepts to describe how Bead uses crypto assets and wallets, including payment versus fee tokens, USDC on Base and Solana, Bitcoin on chain and Lightning, wallet types, swaps, and common support scenarios. Updated Compatible Crypto Wallets to list Bitcoin, Bitcoin Lightning, USDC on Base, and USDC on Solana with example wallets ordered by typical consumer usage and clarified that USDC testing uses live networks and real coin only.
2025-12-08	FAQs	Added Crypto payments, environment and testing under Environment and Testing to document how crypto tenders map to environments and networks, how to fund wallets safely with small test amounts, and common testing issues with suggested checks. Added Crypto testing and fees under Payments FAQs to answer which tokens are recommended for testing, how many tokens to acquire for fees, and which fee asset is required for each crypto tender.
2025-12-08	Payments	Refreshed Test Crypto Transactions page to focus on running an end to end hosted payment flow with USDC, Bitcoin, and Bitcoin Lightning, aligned examples with the new crypto concepts and wallet matrix, and moved general testing and fee questions into the Payments FAQ so this page stays focused on the test flow itself.
2025-12-04	Entity Management	Updated Terminal Management › Webhook Management to use the url field instead of webhookUrl, align success statuses (200 / 202 / 204) with the API, and refresh examples plus best-practice guidance for terminal webhooks.
2025-12-04	Reference Guide	Updated Webhook Event Reference with terminal webhook behavior, per-payment fan-out, HMAC signature details, status enums, and retry semantics; updated Common Field Types › URL and webhook fields to describe url and webhookUrls consistently with the API.
2025-12-01	FAQs	Added test payment card details to How to Test Klarna Payments.
2025-11-25	Onboarding	Added minimal application flow with POST /merchant-onboarding/application-short so partners can submit a light “empty” application that still includes signer and configured fees.
2025-11-25	Onboarding	Updated GET /merchant-onboarding/application/{applicationId} to return a consolidated onboarding status view, including agreement, compliance, banking, and crypto services in a single response.
2025-11-25	Onboarding	Introduced PUT /merchant-onboarding/application/{applicationId} to resend an existing application back to the same signer using the current data set for full front-door resubmission.
2025-11-23	Settlement	Added Settlement documentation Added Settlement overview page with core settlement concepts and how Settlement relates to Payments and Reporting Added Merchant settlements endpoint reference page describing batch level operations and preview or settle endpoints Added Payment settlements endpoint reference page describing payment level settlement objects and drill down endpoints
2025-11-22	Payments	Updated Payments landing page, Create Payment, Payment Statuses, and Payment Webhooks to use consistent endpoint templates, example structure, and terminology Added explicit references from Payments to Reporting and Settlement so integrators can follow the full flow from payment creation through history and settlement
2025-11-21	Reference Guide	Added Settlement status codes page under Enumerations & Schemas Updated Settlement currencies page to clarify supported currencies, tender types, and to reference the /Currencies endpoint as the source of truth Updated Core Concepts and Authentication pages to align terminology for environments, realms (nonprod and prod), and OAuth clients
2025-11-21	Reporting	Updated Reporting landing page and Payment History Concepts to clarify the relationship between payment history and Settlement Updated Partner Payments, Merchant Payments, and Terminal Payments pages to highlight settlement related fields and link to Settlement pages for batch and payment settlement details
2025-11-21	Entity Management	Refreshed Entity Management and Onboarding overview pages to clarify how onboarding and entity lifecycle feed into Payments, Reporting, and Settlement Standardized headings and best practices sections across Entity Management and Onboarding for consistency with other reference pages
2025-10-30	Changelog	Added Changelog page Consolidated all previous changelog pages and entries into single page Organized changelog entries by quarter, date, section, and type Updated changelog entry formatting for consistency Removed all previous changelog pages

2025 Q3 Changelog

Date (YYYY-MM-DD)	Category	Notes
2025-09-17	Onboarding	Updated documentation Added Onboarding documentation with complete flow: create application, signer email + onboardingUrl, status tracking, resume signing, webhooks, and manual risk feedback. Added Onboarding section to root navigation. Old path under Entity Management will point here going forward. Updated fee units (Submit Application, Sample Payloads) for clarity: transactionRate.sellRate is a percentage (e.g., 2.50 = 2.50%), per-item and fixed fees are USD. Standardized response examples to include applicationId and onboardingUrl. Added webhook event list and example envelope; documented retry behavior and signature validation. Added comprehensive sample payload with randomized values covering signer, merchant data, banking, and tender fees.
2025-09-02	Entity Management	Updated Create Location schema: Removed maxTransactionAmount. Added averageTicketSize and maximumTicketSize. Added optional highestMonthlyVolume. Added externalId. Added required business detail fields (where applicable). Updated documentation: All Location Management pages: Updated error codes and headers for clarity. Possible responses include 400, 401, 403, 404. Some flows can return 409 for duplicates and 422 for business rule failures. Examples include Authorization and Accept headers. Location Management (parent page): Removed mention of maxTransactionAmount. Added lifecycle wording for create, configure, operate, retire. Added tender inheritance note. Get Location, List Locations: Updated read responses: Removed maxTransactionAmount. Added ticket size fields. terminals returned as an array of terminal identifiers. Added immutable fields: id, merchantId, created, updated cannot be changed. Get Location: Added immutable fields: id, merchantId, created, updated cannot be changed. List Locations: Updated and expanded List guidance. Endpoint returns the full array. Recommend client side caching and UI pagination. Update Location: Update semantics clarified. PUT is a full object update. Website is required when business type is virtual. Required field set expanded to include business details and ticket sizes. Documented immutable: id, merchantId, created, updated cannot be changed. Delete Location: Updated delete semantics for clarity. Success returns 204 No Content. Deletion requires zero terminals under the location.
2025-09-02	Reporting	Updated documentation: Partner Payments: Partner history endpoint corrected to GET /Partners/{id}/payments. Model aligned with Merchant. Merchant Payments: Merchant history endpoint corrected to GET /Merchants/{id}/payments. Query parameters and response envelope standardized.
2025-09-02	Reference Guide	Updated documentation: Reference Guide (parent page): Refreshed Reference Guide landing. Unified conventions for pagination and the error envelope. Added environment snippet. Authentication & OAuth: Unified authentication content. Standardized token URL. Added lifetimes and refresh policy. Updated Postman quick start for correctness and clarity. Tender Types › Crypto: Updated Crypto tender strings to be more authoritative. Updated current Crypto tender types to usdcBase and usdcSolana. Added future entries for planning. Common Field Types: Updated Common Field Types for correctness and clarity. Added address, contact, identifiers, monetary fields, pagination envelope, headers, and unified error object. Endpoint Index: Corrected Endpoint Index. Updated Merchant and Partner history method to GET. Updated terminal webhook paths to standard. Added webhookUrl body field. Added locations terminals listing. Download OpenAPI / Postman: Updated downloads page with aligned hosts and token URL plus environment variables. Environments & Base URLs: Updated base URLs and token endpoint for correctness. Updated sandbox retention to 180 days.
2025-07-24	Reporting	Updated Payment-history endpoints: Now use GET (breaking) /Partners/{id}/payments, /Merchants/{id}/payments, and /Terminals/{id}/payments all switch from POST to GET. No request body—filters stay in the query string. Updated documentation: All Reporting pages: Added cURL / code samples. Reporting (parent page): Updated “How it works” step 1 to “sends a GET request.” Pagination & Sorting General updates
2025-07-24	Reference Guide	Updated documentation: Updated methods for partner, merchant, and terminal payments from POST to GET. Updated Index and OpenAPI.
2025-07-09	Payments	Updated per-payment webhook override: Added webhookUrls (string array) to POST /payments/crypto. Events now fan-out to the terminal’s default webhook plus every URL in the array. Updated redirectUrl: Updated to be optional. If omitted in Create Payment request, Bead shows a “Payment complete / cancelled” screen. Updated hosted page UX: When the customer object is omitted, checkout no longer prompts the shopper for name or address. Updated documentation: Create Payment Updated to ensure extra endpoints are ready to receive callbacks. Removed client-side rule that requires a redirect URL: Collect customer data yourself if required for your flow. Payment Webhooks: Updated to ensure extra endpoints are ready to receive callbacks.
2025-07-09	Entity Management	Updated documentation: Terminal Management › Webhook Management: Updated to explain that a terminal’s default webhook always receives events, even when a webhookUrls array is supplied in POST /payments/crypto. Added best-practice tips, signature-verification reminder, and updated examples (no API change).
2025-07-09	Reference Guide	Updated documentation: Updated Payments schema. Added webhookUrls to crypto create. Updated redirectUrl as optional. Updated status codes to be returned as enum strings.

2025 Q2 Changelog

Date (YYYY-MM-DD)	Category	Notes
2025-06-14	Entity Management	Updated documentation: Added Get Merchant page. Added Update Location page: Removed all PATCH references. Clarified Disable before delete guidance in Best Practices. List Locations: Updated to clarify that current endpoint returns the entire array with no pagination. Added client side caching tips.
2025-06-04	Entity Management	Updated documentation: Added Location Management page: Added parent lifecycle overview plus Create, Get, List, Delete, and section level Changelog pages.
2025-06-04	Reference Guide	Updated documentation: Updated Reference Guide section into Core Concepts, Enumerations & Schemas, Endpoint Index, Operational Guides, Support & Contacts groupings Added Rate Limits, Tender Types, Settlement Currencies, and Common Field Types
2025-06-01	Reference Guide	Updated documentation: Added webhook signing secret and HMAC verification documentation. Added sample payment.status.updated payload.
2025-05-27	Reference Guide	Updated documentation: Formalized default rate limits and documented 429 handling with headers and error object.
2025-05-15	Reference Guide	Updated documentation Added Tender Types: Added Crypto page. Added Alternative Payments page. Added Compatible Crypto Wallets page.
2025-05-13	Payments	Updated Status Code field: statusCode now returns enum strings (e.g., completed, underpaid) instead of numeric values in the Payment Status endpoint. Updated Webhook payload: statusCode now returns enum strings instead of numeric values. Updated documentation Payment Statuses: Updated parsing logic that expects integers. Payment Webhooks: Updated to ensure webhook handlers expect string values.
2025-05-01	Entity Management	Updated Terminal creation: Terminals are now created with POST /Terminals (locationId in the body). Updated documentation: Updated Create Terminal page, Lifecycle Concepts, and Terminal Management overview.
2025-04-24	Entity Management	Updated documentation: Added Terminal Management (initial public release). List Terminals Response trimmed. Updated hierarchy: Documented Partner → Merchant → Location → Terminal → Payment structure.
2025-04-24	Reporting	Added Reporting endpoints (initial public release) Added /Partners/{id}/payments, /Merchants/{id}/payments Added /Terminals/{id}/payments. Added shared query parameters (page, pageSize, sortBy, sortDirection, fromDate, toDate, status).
2025-04-01	Reference Guide	Updated documentation: Added Reference Guide (initial public release). Added OpenAPI downloads (initial public release). Added Error Codes (initial public release).