Quick Reference

API Endpoints

Test	https://api.test.devs.beadpay.io
Production	https://api.devs.beadpay.io

Contacts

Developer support	[e-mail]
General inquiries	[e-mail]

Settlement Currencies (Fiat)

Currency	Symbol	Status
United States Dollar	USD	Live
Canadian Dollar	CAD	Pending

Payment Currencies (Crypto)

Name	Symbol (Network)	Status
Bitcoin	BTC (Bitcoin)	Live
⚡Bitcoin Lightning	BTC (Bitcoin)	Live
USD Coin	USDC (ERC-20)	Live

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

Payment Status Definitions

Status	Description
Created	The payment has been successfully created and is ready for processing.
Processing	A transaction for the payment has been observed on the blockchain and is awaiting necessary blockchain confirmations to be considered Completed (or Underpaid, Overpaid, etc.)
Completed	The customer sent the correct amount of cryptocurrency, the transaction has received the minimum necessary blockchain confirmations and the amount sent has been converted to the requested fiat settlement currency (if applicable).
Underpaid	The customer sent less crypto than the requested amount. Funds will not be converted and must be returned to the customer. If the customer did not complete a self-serve return at the time of payment via the Bead Pay payment page, the Refund API can be used or the Merchant can complete the refund from their Dashboard.
Overpaid	The customer sent more crypto than the requested amount. The requested amount will be converted and the payment is considered Completed from the Merchant perspective. The overpaid amount will not be converted and must be returned to the customer. If the customer did not complete a self-serve return at the time of payment via the Bead Pay payment page, the Refund API can be used or the Merchant can complete the refund from their Dashboard.
FullyRefunded	One or more refunds have been issued to the customer and the total of all refunds equal the original payment amount.
PartiallyRefunded	One or more refunds have been issued to the customer and the total of all refunds is less than the original payment amount.
Expired	The payment expiry has elapsed and the payment is no longer accessible.
Invalid	An irregular event has occurred during the payment process. Funds received will not be converted and must be returned to the customer. Examples of Invalid payment scenarios include: a transaction arriving after the quote has expired multiple transactions being received when a transaction(s) cannot be converted for any reason In most cases, funds must be returned to the customer. If the customer did not complete a self-serve return at the time of payment via the Bead Pay payment page, the Refund API can be used or the Merchant can complete the refund from their Dashboard.
Cancelled	The payment has been manually cancelled (e.g. by the Merchant from their Bead Pay Dashboard) and the payment is no longer accessible.

Compatible Wallets

Bead Pay allows for crypto payments from any cryptocurrency wallet.