Bead Developers
  • Introduction
  • Quick Start
  • Authentication
  • Payments
    • Create Payment
    • Payment Statuses
    • Payment Webhooks
    • Test Transactions - Crypto
    • Changelog
  • Entity Management
    • Onboarding
    • Merchant Management
      • Get Merchant
      • Changelog
    • Location Management
      • Create Location
      • Get Location
      • List Locations
      • Update Location
      • Delete Location
      • Changelog
    • Terminal Management
      • Terminal Lifecycle (Concepts)
      • Create Terminal
      • Get Terminal
      • List Terminals
      • Update Terminal
      • Delete Terminal
      • Webhook Management
      • Changelog
  • Settlement
    • Batches
    • Settlement Details
  • Reporting
    • Payment History Concepts
      • Pagination and Sorting
    • Partner Payments
    • Merchant Payments
    • Terminal Payments
    • Changelog
  • Reference Guide
    • Core Concepts
      • Environments & Base URLs
      • Authentication
      • Error Codes
    • Enumerations & Schemas
      • Tender Types
        • Crypto
        • Alternative Payments
      • Settlement Currencies
      • Common Field Types
    • Endpoint Index
      • Table View (All APIs)
      • Download OpenAPI / Postman
    • Payment Scenarios
      • Under- and Over-Payment Handling
      • Reclaiming Unconverted Crypto
    • Operational Guides
      • Compatible Crypto Wallets
      • Webhook Event Reference
    • Support & Contacts
      • Integration Support
      • Escalation Contacts
    • Changelog
  • FAQs & Troubleshooting
    • Authentication FAQs
    • Payments FAQs
      • Resolving “403 Forbidden” When Creating Payments
    • Environment & Testing
      • How to Test Klarna Payments
      • How to Prepare for USDC Testing
      • How to Test Klarna Payments
    • Webhooks & Error Codes
Powered by GitBook
On this page
  • OpenAPI (Swagger) specifications
  • Postman collections
  1. Reference Guide
  2. Endpoint Index

Download OpenAPI / Postman

OpenAPI (Swagger) specifications

Import these URLs directly into Swagger UI, Postman, Insomnia, or any OpenAPI-compatible code generator.

Environment
OpenAPI JSON URL

Sandbox

https://api.test.devs.beadpay.io/apidocs/v1/api.json

Production

https://api.devs.beadpay.io/apidocs/v1/api.json

Quick-start

  1. In your tool, choose Import from URL and paste the link for the environment you’re targeting.

  2. Set the request base-URL to • https://api.test.devs.beadpay.io for sandbox • https://api.devs.beadpay.io for production

  3. Add the header Authorization: Bearer <access_token> before sending any call.

Versioning

  • The info.version field in every spec is currently "v1".

  • Non-breaking additions (new endpoints or optional fields) are released under the same v1 tag.

  • Breaking changes will trigger a new major version (v2) and will be announced in the changelog.

Postman collections

Coming soon – downloadable Postman collections for both environments will be published here.

In the meantime, you can import either JSON URL above into Postman’s API Importer to generate a collection automatically.

PreviousTable View (All APIs)NextPayment Scenarios

Last updated 10 days ago