Skip to content

docs: update README to match current DFX API#56

Open
max-tech-bot wants to merge 2 commits intoopenCryptoPay:developfrom
max-tech-bot:docs/update-readme-api-changes
Open

docs: update README to match current DFX API#56
max-tech-bot wants to merge 2 commits intoopenCryptoPay:developfrom
max-tech-bot:docs/update-readme-api-changes

Conversation

@max-tech-bot
Copy link
Contributor

Updates the Open CryptoPay documentation to reflect the current state of the DFX API.

Changes

New recipient fields:

  • registrationNumber, storeType, merchantCategory, goodsType, goodsCategory

Payment methods updated:

  • Added: BinanceSmartChain, Firo, Zano, Tron, Cardano, Spark
  • Renamed: BitcoinOnChainTaprootAsset → TaprootAsset
  • Removed: KuCoinPay

Transaction flow documentation:

  • Added distinct response examples for all 4 transaction types (EVM/Bitcoin/Firo, Monero/Zano/Solana/Tron/Cardano, Lightning, BinancePay)
  • Restructured Step 4 to cover all flows: HEX submission, broadcast-and-report (tx hash), Lightning invoice, BinancePay deep link
  • Clarified hex vs tx query parameter usage per blockchain type

Minor fixes:

  • Country format: "Switzerland""CH" (ISO code)

- Add new recipient fields: registrationNumber, storeType, merchantCategory, goodsType, goodsCategory
- Add new payment methods: BinanceSmartChain, Firo, Zano, Tron, Cardano, Spark
- Rename BitcoinOnChainTaprootAsset to TaprootAsset
- Remove deprecated KuCoinPay method
- Update country format from full name to ISO code (CH)
- Add transaction detail examples for all response types (EVM/Bitcoin/Firo, Monero/Zano/Solana/Tron/Cardano, Lightning, BinancePay)
- Restructure Step 4 to cover all transaction flows including broadcast-and-report (Monero, Zano, Solana, Tron, Cardano) and BinancePay deep link
- Clarify hex vs tx query parameter usage per blockchain type
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant