Changelog
2025 Q4 Changelog
2025-12-09
Aligned the example response with the
POST /payments/cryptoschema by usingpaymentUrlsas a string array and includingpaymentPageId.Updated instructions to launch the hosted checkout using the URL from the
paymentUrlsarray instead of the previous object basedpaymentUrls[0].urlpattern.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
Updated Create Payment page to use the same response model as the API (
trackingId,paymentPageId,paymentUrlsas an array of hosted payment URLs) and removed the outdatedpaymentUrls.typeandpaymentUrls.urlobject pattern.Clarified how integrators should use
paymentUrlsandpaymentPageIdtogether, including when to storetrackingIdandpaymentPageIdfor 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
Replaced legacy
POST /paymentsexample withPOST /payments/cryptousing the currentCryptoPaymentResponseshape (trackingId,paymentPageId,paymentUrlsstring array).Aligned authentication snippet with current Identity realms and token URL, and clarified how to use the returned
access_tokenacross API calls.Updated status check step to use
GET /payments/tracking/{trackingId}with enumstatusCodevalues 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
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
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
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
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
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-11-25
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
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
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
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
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
Added Settlement status codes page under Enumerations & Schemas
Updated Settlement currencies page to clarify supported currencies, tender types, and to reference the
/Currenciesendpoint as the source of truthUpdated Core Concepts and Authentication pages to align terminology for environments, realms (
nonprodandprod), and OAuth clients
2025-11-21
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
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 Q3 Changelog
2025-09-17
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.sellRateis a percentage (e.g., 2.50 = 2.50%), per-item and fixed fees are USD. Standardized response examples to includeapplicationIdandonboardingUrl.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
Updated Create Location schema:
Removed
maxTransactionAmount.Added
averageTicketSizeandmaximumTicketSize.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
409for duplicates and422for business rule failures. Examples includeAuthorizationandAcceptheaders.
Location Management (parent page):
Removed mention of
maxTransactionAmount.Added lifecycle wording for create, configure, operate, retire.
Added tender inheritance note.
Updated read responses:
Removed
maxTransactionAmount.Added ticket size fields.
terminalsreturned as an array of terminal identifiers.Added immutable fields:
id,merchantId,created,updatedcannot be changed.
Added immutable fields:
id,merchantId,created,updatedcannot be changed.
Updated and expanded List guidance. Endpoint returns the full array. Recommend client side caching and UI pagination.
Update semantics clarified.
PUTis 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,updatedcannot be changed.
Updated delete semantics for clarity.
Success returns
204 No Content.Deletion requires zero terminals under the location.
2025-09-02
Updated documentation:
Partner history endpoint corrected to
GET /Partners/{id}/payments.Model aligned with Merchant.
Merchant history endpoint corrected to
GET /Merchants/{id}/payments.Query parameters and response envelope standardized.
2025-09-02
Updated documentation:
Reference Guide (parent page):
Refreshed Reference Guide landing.
Unified conventions for pagination and the error envelope.
Added environment snippet.
Unified authentication content.
Standardized token URL.
Added lifetimes and refresh policy.
Updated Postman quick start for correctness and clarity.
Updated Crypto tender strings to be more authoritative.
Updated current Crypto tender types to
usdcBaseandusdcSolana.Added future entries for planning.
Updated Common Field Types for correctness and clarity.
Added address, contact, identifiers, monetary fields, pagination envelope, headers, and unified error object.
Corrected Endpoint Index.
Updated Merchant and Partner history method to
GET.Updated terminal webhook paths to standard.
Added
webhookUrlbody field.Added locations terminals listing.
Updated downloads page with aligned hosts and token URL plus environment variables.
Updated base URLs and token endpoint for correctness.
Updated sandbox retention to 180 days.
2025-07-24
Updated Payment-history endpoints:
Now use
GET(breaking)/Partners/{id}/payments,/Merchants/{id}/payments, and/Terminals/{id}/paymentsall switch fromPOSTtoGET.No request body—filters stay in the query string.
2025-07-24
Updated documentation:
Updated methods for partner, merchant, and terminal payments from
POSTtoGET.Updated Index and OpenAPI.
2025-07-09
Updated per-payment webhook override:
Added
webhookUrls(string array) toPOST /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
customerobject is omitted, checkout no longer prompts the shopper for name or address.
Updated documentation:
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.
Updated to ensure extra endpoints are ready to receive callbacks.
2025-07-09
Updated documentation:
Terminal Management › Webhook Management:
Updated to explain that a terminal’s default webhook always receives events, even when a
webhookUrlsarray is supplied in POST /payments/crypto.Added best-practice tips, signature-verification reminder, and updated examples (no API change).
2025-07-09
Updated documentation:
Updated Payments schema.
Added
webhookUrlsto crypto create.Updated
redirectUrlas optional.Updated status codes to be returned as enum strings.
2025 Q2 Changelog
2025-06-14
Updated documentation:
Added Get Merchant page.
Added Update Location page:
Removed all PATCH references. Clarified Disable before delete guidance in Best Practices.
Updated to clarify that current endpoint returns the entire array with no pagination.
Added client side caching tips.
2025-06-04
Updated documentation:
Added Location Management page:
Added parent lifecycle overview plus Create, Get, List, Delete, and section level Changelog pages.
2025-06-04
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
Updated documentation:
Added webhook signing secret and HMAC verification documentation.
Added sample
payment.status.updatedpayload.
2025-05-27
Updated documentation:
Formalized default rate limits and documented 429 handling with headers and error object.
2025-05-15
Updated documentation
Added Tender Types:
Added Crypto page.
Added Alternative Payments page.
Added Compatible Crypto Wallets page.
2025-05-13
Updated Status Code field:
statusCodenow returns enum strings (e.g.,completed,underpaid) instead of numeric values in the Payment Status endpoint.
Updated Webhook payload:
statusCodenow returns enum strings instead of numeric values.
Updated documentation
Updated parsing logic that expects integers.
Updated to ensure webhook handlers expect string values.
2025-05-01
Updated Terminal creation:
Terminals are now created with
POST /Terminals(locationIdin the body).
Updated documentation:
Updated Create Terminal page, Lifecycle Concepts, and Terminal Management overview.
2025-04-24
Updated documentation:
Added Terminal Management (initial public release).
Response trimmed.
Updated hierarchy:
Documented Partner → Merchant → Location → Terminal → Payment structure.
2025-04-24
Added Reporting endpoints (initial public release)
Added
/Partners/{id}/payments,/Merchants/{id}/paymentsAdded
/Terminals/{id}/payments.Added shared query parameters (
page,pageSize,sortBy,sortDirection,fromDate,toDate,status).
2025-04-01
Updated documentation:
Added Reference Guide (initial public release).
Added OpenAPI downloads (initial public release).
Added Error Codes (initial public release).
Last updated