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.2.1. HTTP Request and Response
  • 1.2.2. Protocol Version Ranges
  • 1.2.3. Error Codes
  • 1.2.4. Common encodings
  • 1.2.5. Binary Formats
• 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. Deposit
  • 1.3.8. Refreshing
  • 1.3.9. Recoup
  • 1.3.10. Tracking wire transfers
  • 1.3.11. Refunds
  • 1.3.12. Wallet-to-wallet transfers
  • 1.3.13. Wads
  • 1.3.14. KYC status updates
  • 1.3.15. 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. Inventory management
  • 1.4.7. Payment processing
  • 1.4.8. Giving Refunds
  • 1.4.9. Tracking Wire Transfers
  • 1.4.10. Backend: Giving tips
  • 1.4.11. Template
  • 1.4.12. Webhooks
  • 1.4.13. The Contract Terms
• 1.5. Wallet-Core API Documentation
  • 1.5.1. Overview
  • 1.5.2. Operation Reference
  • 1.5.3. Common Declarations
• 1.6. The Auditor RESTful JSON API
  • 1.6.1. Obtaining Auditor Version
  • 1.6.2. Obtaining Exchange List
  • 1.6.3. Submitting deposit confirmations
  • 1.6.4. Complaints
• 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.8.1. Terms of service API
  • 1.8.2. Receiving Configuration
  • 1.8.3. Setup
  • 1.8.4. Login
  • 1.8.5. Challenge
  • 1.8.6. Solve
  • 1.8.7. Auth
  • 1.8.8. Info
• 1.9. The TalDir RESTful API
  • 1.9.1. Terms of service API
  • 1.9.2. Configuration information
  • 1.9.3. Address registration
  • 1.9.4. Address lookup
• 1.10. The Mailbox RESTful API
  • 1.10.1. Terms of service API
  • 1.10.2. Configuration information
  • 1.10.3. Sending messages
  • 1.10.4. Receiving messages
• 1.11. Bank RESTful APIs
  • 1.11.1. Taler Wire Gateway HTTP API
  • 1.11.2. Taler Bank Merchant HTTP API
  • 1.11.3. Taler Bank Integration API
  • 1.11.4. Taler Bank Access API
  • 1.11.5. Nexus HTTP API
  • 1.11.6. Sandbox API
  • 1.11.7. Future Sandbox API