# Bead Developers ## Bead Developers - [Introduction](https://developers.bead.xyz/introduction.md) - [Quick Start](https://developers.bead.xyz/quick-start.md) - [Testing](https://developers.bead.xyz/testing.md): Choose the right way to validate your integration in Sandbox. - [Test with Klarna (recommended)](https://developers.bead.xyz/testing/test-with-klarna-recommended.md) - [Test with Venmo](https://developers.bead.xyz/testing/test-with-venmo.md) - [Test with PayPal](https://developers.bead.xyz/testing/test-with-paypal.md) - [Test Crypto Payments](https://developers.bead.xyz/testing/test-crypto-payments.md) - [Authentication](https://developers.bead.xyz/authentication.md) - [Payments](https://developers.bead.xyz/payments.md) - [Create Payment](https://developers.bead.xyz/payments/create-payment.md) - [Run a Test Payment in the API Reference](https://developers.bead.xyz/payments/run-a-test-payment-in-the-api-reference.md) - [Payment Statuses](https://developers.bead.xyz/payments/payment-statuses.md) - [Payment Status Response Examples](https://developers.bead.xyz/payments/payment-status-response-examples.md) - [Crypto Wallet Flow and Amounts](https://developers.bead.xyz/payments/crypto-wallet-flow-and-amounts.md) - [Payment Webhooks](https://developers.bead.xyz/payments/payment-webhooks.md) - [Receipts](https://developers.bead.xyz/payments/receipts.md) - [Test Crypto Transactions](https://developers.bead.xyz/payments/test-crypto-transactions.md) - [Testnet Crypto Transactions](https://developers.bead.xyz/payments/testnet-crypto-transactions.md) - [Onboarding](https://developers.bead.xyz/onboarding.md) - [Draft and Submit (Recommended)](https://developers.bead.xyz/onboarding/draft-and-submit.md) - [Submit Application](https://developers.bead.xyz/onboarding/submit-application.md) - [Fee Configuration for Onboarding Applications](https://developers.bead.xyz/onboarding/fee-configuration-for-onboarding-applications.md) - [Application Attachments](https://developers.bead.xyz/onboarding/application-attachments.md) - [Field Validation Rules](https://developers.bead.xyz/onboarding/field-validation-rules.md) - [Test the Full Onboarding Workflow in Sandbox](https://developers.bead.xyz/onboarding/test-the-full-onboarding-workflow-in-sandbox.md) - [Get Status](https://developers.bead.xyz/onboarding/get-status.md) - [List Applications](https://developers.bead.xyz/onboarding/list-applications.md) - [Resend Application](https://developers.bead.xyz/onboarding/resend-application.md) - [Cancel Application](https://developers.bead.xyz/onboarding/cancel-application.md) - [Partner Webhooks](https://developers.bead.xyz/onboarding/partner-webhooks.md) - [Sample Payload](https://developers.bead.xyz/onboarding/sample-payload.md) - [Entity Management](https://developers.bead.xyz/entity-management.md) - [Partner Management](https://developers.bead.xyz/entity-management/partner-management.md) - [Merchant Management](https://developers.bead.xyz/entity-management/merchant-management.md) - [Get Merchant](https://developers.bead.xyz/entity-management/merchant-management/get-merchant.md): Retrieves the complete profile of a single merchant, including company details, tender types, fee settings, and membership list. - [List Merchants](https://developers.bead.xyz/entity-management/merchant-management/list-merchants.md) - [Update Merchant](https://developers.bead.xyz/entity-management/merchant-management/update-merchant.md) - [Location Management](https://developers.bead.xyz/entity-management/location-management.md) - [Create Location](https://developers.bead.xyz/entity-management/location-management/create-location.md) - [Get Location](https://developers.bead.xyz/entity-management/location-management/get-location.md) - [List Locations](https://developers.bead.xyz/entity-management/location-management/list-locations.md) - [Update Location](https://developers.bead.xyz/entity-management/location-management/update-location.md) - [Delete Location](https://developers.bead.xyz/entity-management/location-management/delete-location.md) - [Terminal Management](https://developers.bead.xyz/entity-management/terminal-management.md) - [Terminal Lifecycle (Concepts)](https://developers.bead.xyz/entity-management/terminal-management/terminal-lifecycle-concepts.md) - [Create Terminal](https://developers.bead.xyz/entity-management/terminal-management/create-terminal.md) - [List Terminals](https://developers.bead.xyz/entity-management/terminal-management/list-terminals.md) - [Get Terminal](https://developers.bead.xyz/entity-management/terminal-management/get-terminal.md) - [Reset Terminal API Key](https://developers.bead.xyz/entity-management/terminal-management/reset-terminal-api-key.md) - [Update Terminal](https://developers.bead.xyz/entity-management/terminal-management/update-terminal.md) - [Delete Terminal](https://developers.bead.xyz/entity-management/terminal-management/delete-terminal.md) - [Webhook Management](https://developers.bead.xyz/entity-management/terminal-management/webhook-management.md) - [Managing Tender Types](https://developers.bead.xyz/entity-management/terminal-management/managing-tender-types.md) - [Settlement](https://developers.bead.xyz/settlement.md) - [Settlements](https://developers.bead.xyz/settlement/settlements.md) - [Residual Reporting](https://developers.bead.xyz/settlement/residual-reporting.md) - [Batches](https://developers.bead.xyz/settlement/batches.md) - [Deposits](https://developers.bead.xyz/settlement/deposits.md) - [Payment Settlement Detail](https://developers.bead.xyz/settlement/payment-settlement-detail.md) - [Settlement Reconciliation Patterns](https://developers.bead.xyz/settlement/settlement-reconciliation-patterns.md) - [Testing Settlement in the Test Environment](https://developers.bead.xyz/settlement/testing-settlement-in-the-test-environment.md) - [Reporting](https://developers.bead.xyz/reporting.md) - [Payment History Concepts](https://developers.bead.xyz/reporting/payment-history-concepts.md) - [Pagination and Sorting](https://developers.bead.xyz/reporting/payment-history-concepts/pagination-and-sorting.md) - [Partner Payments](https://developers.bead.xyz/reporting/partner-payments.md) - [Merchant Payments](https://developers.bead.xyz/reporting/merchant-payments.md) - [Terminal Payments](https://developers.bead.xyz/reporting/terminal-payments.md) - [Split Funding](https://developers.bead.xyz/split-funding.md) - [Enable and Send a Split Funding Payment](https://developers.bead.xyz/split-funding/enable-and-send-a-split-funding-payment.md) - [Split Funding Reports](https://developers.bead.xyz/split-funding/reports.md) - [Reference Guide](https://developers.bead.xyz/reference-guide.md) - [Conventions](https://developers.bead.xyz/reference-guide/conventions.md) - [Identifiers and Keys](https://developers.bead.xyz/reference-guide/conventions/identifiers-and-keys.md) - [Core Concepts](https://developers.bead.xyz/reference-guide/core-concepts.md) - [Authentication & OAuth 2.0](https://developers.bead.xyz/reference-guide/core-concepts/authentication-and-oauth-2.0.md) - [Crypto and Wallet Concepts for Integrators](https://developers.bead.xyz/reference-guide/core-concepts/crypto-and-wallet-concepts-for-integrators.md) - [Error Codes](https://developers.bead.xyz/reference-guide/core-concepts/error-codes.md) - [Environments & Base URLs](https://developers.bead.xyz/reference-guide/core-concepts/environments-and-base-urls.md) - [Idempotency](https://developers.bead.xyz/reference-guide/core-concepts/idempotency.md) - [Rate Limits & Throttling](https://developers.bead.xyz/reference-guide/core-concepts/rate-limits-and-throttling.md) - [Advanced Partner Hierarchy](https://developers.bead.xyz/reference-guide/core-concepts/advanced-partner-hierarchy.md) - [Enumerations & Schemas](https://developers.bead.xyz/reference-guide/enumerations-and-schemas.md) - [Common Field Types](https://developers.bead.xyz/reference-guide/enumerations-and-schemas/common-field-types.md) - [Merchant Onboarding Schema](https://developers.bead.xyz/reference-guide/enumerations-and-schemas/merchant-onboarding-schema.md) - [Settlement Currencies](https://developers.bead.xyz/reference-guide/enumerations-and-schemas/settlement-currencies.md) - [Settlement Status Codes](https://developers.bead.xyz/reference-guide/enumerations-and-schemas/settlement-status-codes.md) - [Tender Types](https://developers.bead.xyz/reference-guide/enumerations-and-schemas/tender-types.md) - [Crypto](https://developers.bead.xyz/reference-guide/enumerations-and-schemas/tender-types/crypto.md) - [Alternative Payments](https://developers.bead.xyz/reference-guide/enumerations-and-schemas/tender-types/alternative-payments.md) - [Endpoint Index](https://developers.bead.xyz/reference-guide/endpoint-index.md) - [Table View (All APIs)](https://developers.bead.xyz/reference-guide/endpoint-index/table-view-all-apis.md) - [Download OpenAPI](https://developers.bead.xyz/reference-guide/endpoint-index/download-openapi.md) - [Payment Flows](https://developers.bead.xyz/reference-guide/payment-flows.md) - [Choosing Tender Types by Payment Environment](https://developers.bead.xyz/reference-guide/payment-flows/choosing-tender-types-by-payment-environment.md) - [Reading Tender Availability at Runtime](https://developers.bead.xyz/reference-guide/payment-flows/reading-tender-availability-at-runtime.md) - [In-Person Payments (Physical Terminals)](https://developers.bead.xyz/reference-guide/payment-flows/in-person-payments-physical-terminals.md) - [Payment Scenarios](https://developers.bead.xyz/reference-guide/payment-scenarios.md) - [Under and Over Payment Handling](https://developers.bead.xyz/reference-guide/payment-scenarios/under-and-over-payment-handling.md) - [Reclaiming Unconverted Crypto](https://developers.bead.xyz/reference-guide/payment-scenarios/reclaiming-unconverted-crypto.md) - [Tracking Reclaim Status](https://developers.bead.xyz/reference-guide/payment-scenarios/tracking-reclaim-status.md) - [Refunds for Crypto and Wallet Payments](https://developers.bead.xyz/reference-guide/payment-scenarios/refunds-for-crypto-and-wallet-payments.md) - [Expired Payment Handling](https://developers.bead.xyz/reference-guide/payment-scenarios/expired-payment-handling.md) - [Operational Guides](https://developers.bead.xyz/reference-guide/operational-guides.md) - [Compatible Crypto Wallets](https://developers.bead.xyz/reference-guide/operational-guides/compatible-crypto-wallets.md) - [Merchant Onboarding Guide](https://developers.bead.xyz/reference-guide/operational-guides/merchant-onboarding-guide.md) - [Using an LLM or Agent to Build a Payments POC](https://developers.bead.xyz/reference-guide/operational-guides/using-an-llm-or-agent-to-build-a-payments-poc.md) - [Webhook Event Reference](https://developers.bead.xyz/reference-guide/operational-guides/webhook-event-reference.md) - [Support & Contacts](https://developers.bead.xyz/reference-guide/support-and-contacts.md) - [Integration Support](https://developers.bead.xyz/reference-guide/support-and-contacts/integration-support.md) - [Escalation Contacts](https://developers.bead.xyz/reference-guide/support-and-contacts/escalation-contacts.md) - [FAQs & Troubleshooting](https://developers.bead.xyz/faqs-and-troubleshooting.md) - [Authentication FAQs](https://developers.bead.xyz/faqs-and-troubleshooting/authentication-faqs.md) - [Where do I find the base URLs, realm, and client IDs?](https://developers.bead.xyz/faqs-and-troubleshooting/authentication-faqs/where-do-i-find-the-base-urls-realm-and-client-ids.md) - [Onboarding FAQs](https://developers.bead.xyz/faqs-and-troubleshooting/onboarding-faqs.md) - [How do I create an application in Draft status?](https://developers.bead.xyz/faqs-and-troubleshooting/onboarding-faqs/how-do-i-create-an-application-in-draft-status.md) - [Why am I getting a 403 Forbidden when submitting an application?](https://developers.bead.xyz/faqs-and-troubleshooting/onboarding-faqs/why-am-i-getting-a-403-forbidden-when-submitting-an-application.md) - [Payments FAQs](https://developers.bead.xyz/faqs-and-troubleshooting/payments-faqs.md) - [Crypto Testing and Fees](https://developers.bead.xyz/faqs-and-troubleshooting/payments-faqs/crypto-testing-and-fees.md) - [Resolving “403 Forbidden” When Creating Payments](https://developers.bead.xyz/faqs-and-troubleshooting/payments-faqs/resolving-403-forbidden-when-creating-payments.md) - [Troubleshooting "Couldn't Create Payment" Error](https://developers.bead.xyz/faqs-and-troubleshooting/payments-faqs/troubleshooting-couldnt-create-payment-error.md) - [Can I view payments with a Payment API key?](https://developers.bead.xyz/faqs-and-troubleshooting/payments-faqs/can-i-view-payments-with-a-payment-api-key.md) - [Crypto conversion timing and volatility exposure](https://developers.bead.xyz/faqs-and-troubleshooting/payments-faqs/crypto-conversion-timing-and-volatility-exposure.md) - [Why do BTC (on-chain) payments take longer?](https://developers.bead.xyz/faqs-and-troubleshooting/payments-faqs/why-do-btc-on-chain-payments-take-longer.md) - [Does Bead support a refund API for crypto, wallet, and BNPL payments?](https://developers.bead.xyz/faqs-and-troubleshooting/payments-faqs/does-bead-support-a-refund-api-for-crypto-wallet-and-bnpl-payments.md) - [Why Did My Payment Expire, and What Happens Next?](https://developers.bead.xyz/faqs-and-troubleshooting/payments-faqs/why-did-my-payment-expire-and-what-happens-next.md) - [Which consumers can use Klarna, PayPal, and Venmo?](https://developers.bead.xyz/faqs-and-troubleshooting/payments-faqs/which-consumers-can-use-klarna-paypal-and-venmo.md) - [Consumer Fee Passthrough for Wallet and Crypto Tenders](https://developers.bead.xyz/faqs-and-troubleshooting/payments-faqs/consumer-fee-passthrough-for-wallet-and-crypto-tenders.md) - [Why is the processing status missing for some payments, especially on physical terminals?](https://developers.bead.xyz/faqs-and-troubleshooting/payments-faqs/why-is-the-processing-status-missing-for-some-payments-especially-on-physical-terminals.md) - [Why is my payment still Created or In Progress?](https://developers.bead.xyz/faqs-and-troubleshooting/payments-faqs/why-is-my-payment-still-created-or-in-progress.md) - [Settlement FAQs](https://developers.bead.xyz/faqs-and-troubleshooting/settlement-faqs.md) - [Settlement Timing FAQs](https://developers.bead.xyz/faqs-and-troubleshooting/settlement-faqs/settlement-timing-faqs.md) - [Settlement data and deposit reconciliation](https://developers.bead.xyz/faqs-and-troubleshooting/settlement-faqs/settlement-data-and-deposit-reconciliation.md) - [Where are merchant funds deposited?](https://developers.bead.xyz/faqs-and-troubleshooting/settlement-faqs/where-are-merchant-funds-deposited.md) - [How are fees deducted from settlement?](https://developers.bead.xyz/faqs-and-troubleshooting/settlement-faqs/how-are-fees-deducted-from-settlement.md) - [Settlement Fees](https://developers.bead.xyz/faqs-and-troubleshooting/settlement-faqs/settlement-fees.md) - [How are PayPal clawbacks reflected in settlement?](https://developers.bead.xyz/faqs-and-troubleshooting/settlement-faqs/how-are-paypal-clawbacks-reflected-in-settlement.md) - [Can I filter settlements or batches by terminal ID?](https://developers.bead.xyz/faqs-and-troubleshooting/settlement-faqs/can-i-filter-settlements-or-batches-by-terminal-id.md) - [Entity Management FAQs](https://developers.bead.xyz/faqs-and-troubleshooting/entity-management-faqs.md) - [Can I delete test or submitted applications?](https://developers.bead.xyz/faqs-and-troubleshooting/entity-management-faqs/can-i-delete-test-or-submitted-applications.md) - [Managing Tender Types FAQ](https://developers.bead.xyz/faqs-and-troubleshooting/entity-management-faqs/managing-tender-types-faq.md) - [Environment & Testing](https://developers.bead.xyz/faqs-and-troubleshooting/environment-and-testing.md) - [Sandbox and production URLs](https://developers.bead.xyz/faqs-and-troubleshooting/environment-and-testing/sandbox-and-production-urls.md) - [Test data: uniqueness requirements](https://developers.bead.xyz/faqs-and-troubleshooting/environment-and-testing/test-data-uniqueness-requirements.md) - [Crypto payments, environment and testing](https://developers.bead.xyz/faqs-and-troubleshooting/environment-and-testing/crypto-payments-environment-and-testing.md) - [How to Prepare for USDC Testing](https://developers.bead.xyz/faqs-and-troubleshooting/environment-and-testing/how-to-prepare-for-usdc-testing.md) - [USDC network fees and cost considerations](https://developers.bead.xyz/faqs-and-troubleshooting/environment-and-testing/usdc-network-fees-and-cost-considerations.md) - [How to Test Klarna Payments](https://developers.bead.xyz/faqs-and-troubleshooting/environment-and-testing/how-to-test-klarna-payments.md) - [Why do Sandbox payments over $100 return “payment amount exceeds the terminal’s maximum limit”?](https://developers.bead.xyz/faqs-and-troubleshooting/environment-and-testing/why-do-sandbox-payments-over-usd100-return-payment-amount-exceeds-the-terminals-maximum-limit.md) - [Webhooks & Error Codes](https://developers.bead.xyz/faqs-and-troubleshooting/webhooks-and-error-codes.md) - [Can I send webhook events to multiple URLs?](https://developers.bead.xyz/faqs-and-troubleshooting/webhooks-and-error-codes/can-i-send-webhook-events-to-multiple-urls.md) - [How do I verify that a webhook really came from Bead?](https://developers.bead.xyz/faqs-and-troubleshooting/webhooks-and-error-codes/how-do-i-verify-that-a-webhook-really-came-from-bead.md) - [Why am I not receiving webhook events?](https://developers.bead.xyz/faqs-and-troubleshooting/webhooks-and-error-codes/why-am-i-not-receiving-webhook-events.md) - [How do I resolve a 400 ValidationError?](https://developers.bead.xyz/faqs-and-troubleshooting/webhooks-and-error-codes/how-do-i-resolve-a-400-validationerror.md) - [What does HTTP 429 “Too Many Requests” mean and how do I avoid it?](https://developers.bead.xyz/faqs-and-troubleshooting/webhooks-and-error-codes/what-does-http-429-too-many-requests-mean-and-how-do-i-avoid-it.md) - [Why is my request returning 403 Forbidden?](https://developers.bead.xyz/faqs-and-troubleshooting/webhooks-and-error-codes/why-is-my-request-returning-403-forbidden.md) - [Firewall & IP allowlisting for webhooks](https://developers.bead.xyz/faqs-and-troubleshooting/webhooks-and-error-codes/firewall-and-ip-allowlisting-for-webhooks.md) - [Why is x-webhook-signature missing from some webhook deliveries?](https://developers.bead.xyz/faqs-and-troubleshooting/webhooks-and-error-codes/why-is-x-webhook-signature-missing-from-some-webhook-deliveries.md) - [Upcoming Changes](https://developers.bead.xyz/upcoming-changes.md) - [Consumer Fee Control and Exact Net Settlement](https://developers.bead.xyz/upcoming-changes/consumer-fee-control-and-exact-net-settlement.md) - [Changelog](https://developers.bead.xyz/changelog.md) - [Change Log: 2025](https://developers.bead.xyz/changelog/change-log-2025.md) - [Demos](https://developers.bead.xyz/demos.md) - [Mobile Payments](https://developers.bead.xyz/demos/mobile-payments.md) - [USDC on Phantom (Mobile)](https://developers.bead.xyz/demos/mobile-payments/mobile-usdc-phantom-2026-02.md) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation This site has an agentic ask interface you may use to query the documentation dynamically by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://developers.bead.xyz/index.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.