1. Core Protocol Specification¶
This chapter describes the APIs used in the GNU Taler project. It includes both APIs that are pre-existing as well as APIs specific to the project.
These protocol specifications define the interfaces between the core components of GNU Taler. Most of these interfaces use HTTP-based RESTful protocols using JSON.
- 1.1. Overview
- 1.2. Conventions for Taler RESTful APIs
- 1.3. The Exchange RESTful API
- 1.3.1. Terms of service API
- 1.3.2. Exchange status information
- 1.3.3. Management operations authorized by master key
- 1.3.4. AML operations
- 1.3.5. Auditor actions
- 1.3.6. Withdrawal
- 1.3.7. Reserve History
- 1.3.8. Coin History
- 1.3.9. Deposit
- 1.3.10. Refreshing
- 1.3.11. Recoup
- 1.3.12. Tracking wire transfers
- 1.3.13. Refunds
- 1.3.14. Wallet-to-wallet transfers
- 1.3.15. Wads
- 1.3.16. KYC status updates
- 1.3.17. Reserve control
- 1.4. Merchant Backend RESTful API
- 1.4.1. Base URLs and Instances
- 1.4.2. Authentication
- 1.4.3. Configuration API
- 1.4.4. Wallet API
- 1.4.5. Instance management
- 1.4.6. Bank Accounts
- 1.4.7. Inventory management
- 1.4.8. Payment processing
- 1.4.9. Giving Refunds
- 1.4.10. Tracking Wire Transfers
- 1.4.11. Backend: Giving rewards
- 1.4.12. OTP Devices
- 1.4.13. Templates
- 1.4.14. Webhooks
- 1.4.15. The Contract Terms
- 1.5. Wallet-Core API Documentation
- 1.6. The Auditor RESTful JSON API
- 1.7. Backup and Synchronization RESTful API
- 1.7.1. Terms of service API
- 1.7.2. Receiving Configuration
- 1.7.3. Recovering Backup Data
- 1.7.4. Uploading Backup Data
- 1.7.5. Special constraints for Tor
- 1.7.6. Discovery of backup and synchronization services
- 1.7.7. Synchronization frequency
- 1.7.8. Synchronization user experience
- 1.7.9. Web Security Considerations
- 1.8. Challenger Service API
- 1.9. The TalDir RESTful API
- 1.10. The Mailbox RESTful API
- 1.11. Bank RESTful APIs
- 1.12. The Donau RESTful API