Changelog

2025 Q3 Changelog

Date (YYYY-MM-DD)

Category

Notes

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-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)