Bead Developers
  • Introduction
  • Quick Start
  • Authentication
  • Payments
    • Create Payment
    • Payment Statuses
    • Payment Webhooks
    • Test Transactions - Crypto
  • Entity Management
    • Onboarding
    • Merchant Management
    • Location Management
    • 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
Powered by GitBook
On this page
  • API Endpoints
  • Contacts
  • Settlement Currencies (Fiat)
  • Tender Types (Crypto)
  • Payment Scenarios
  • Compatible Crypto Wallets

Reference Guide

API Endpoints

Test

Production


Contacts

Developer support

General inquiries


Settlement Currencies (Fiat)

Currency
Symbol
Status

United States Dollar

USD

Live


Tender Types (Crypto)

Name
Symbol (Network)
Status

Bitcoin Lightning ⚡

BTC (Bitcoin)

Live

Bitcoin

BTC (Bitcoin)

Live

USD Coin - Ethereum

USDC (ERC-20)

Live

USD Coin - Polygon

USDC (Polygon)

Live

⚡Bitcoin (BTC) on the Lightning Network provides near-instant payments at very low costs to customers, making it ideal for in-store transactions. Lightning Network also has fewer payment exceptions for a more reliably smooth payment experience for both merchants and customers.


Payment Scenarios

Status
Description

Completed

The customer sent the requested amount and processing was successful. Crypto is converted to the merchant's settlement currency and credited to their account.

Underpaid

The customer sent less than the requested amount. Funds are not converted and must be reclaimed by the customer. (See note below)

Overpaid

The customer sent more than the requested amount. The requested amount is converted and the payment is considered Completed. The overpaid amount is not converted and must be reclaimed by the customer. (See note below)

Expired

The customer's funds were not received before the payment window expired (varies by tender type). Funds will not be converted and must be reclaimed by the customer. (See note below)

Invalid

An irregular event occurred during processing, such as:

  • detecting multiple transactions

  • detecting a transaction for an incorrect or unsupported asset

  • the customer's wallet was flagged for compliance reasons

  • extreme market activity that will prevent the merchant from receiving the full payment amount

Funds received are not converted and must be reclaimed by the customer. (See note below)

Cancelled

The customer or merchant requested to cancel the payment. If a transaction is detected, crypto will not be converted and may be reclaimed by the customer. (See note below)

Reclaiming Unconverted Crypto

For payment scenarios resulting in unconverted crypto, the customer provides their email address via the Hosted Payment Page (if one was not provided in the payment request) and will receive instructions from Bead detailing how they can reclaim their funds.


Compatible Crypto Wallets

Bead allows for crypto payments from any cryptocurrency wallet that can create a transaction in one or more of our supported crypto tender types. For point of sale transactions, the only requirement is that the customer's device can scan a QR code to get the payment deposit address.

PreviousChangelog

Last updated 1 month ago

https://api.test.devs.beadpay.io
https://api.devs.beadpay.io
developers@bead.xyz
info@bead.xyz