Voucher Trading System Application Programming Interface (VTS-API)
RFC 4154
| Document | Type | RFC - Informational (September 2005; No errata) | |
|---|---|---|---|
| Authors | Masayuki Terada , Ko Fujimura | ||
| Last updated | 2015-10-14 | ||
| Stream | IETF | ||
| Formats | plain text html pdf htmlized bibtex | ||
| Stream | WG state | (None) | |
| Document shepherd | No shepherd assigned | ||
| IESG | IESG state | RFC 4154 (Informational) | |
| Action Holders |
(None)
|
||
| Consensus Boilerplate | Unknown | ||
| Telechat date | |||
| Responsible AD | Scott Hollenbeck | ||
| Send notices to | (None) | ||
Network Working Group M. Terada
Request for Comments: 4154 NTT DoCoMo
Category: Informational K. Fujimura
NTT
September 2005
Voucher Trading System Application Programming Interface (VTS-API)
Status of This Memo
This memo provides information for the Internet community. It does
not specify an Internet standard of any kind. Distribution of this
memo is unlimited.
Copyright Notice
Copyright (C) The Internet Society (2005).
IESG Note
This document is not a candidate for any level of Internet Standard.
This document specifies the Voucher Trading System Application
Programming Interface (VTS-API), which assumes that the VTS plug-in
is trusted by its user. The application making calls to VTS-API
ought to authenticate the VTS plug-in and securely bind the plug-in
with the VTS provider information specified in the Voucher Component.
However, this document does not specify an approach to application
authentication. The VTS-API should not be used without being
augmented by an application authentication mechanism.
Abstract
This document specifies the Voucher Trading System Application
Programming Interface (VTS-API). The VTS-API allows a wallet or
other application to issue, transfer, and redeem vouchers in a
uniform manner independent of the VTS implementation. The VTS is a
system for securely transferring vouchers; e.g., coupons, tickets,
loyalty points, and gift certificates. This process is often
necessary in the course of payment and/or delivery transactions.
Terada & Fujimura Informational [Page 1]
RFC 4154 VTS-API September 2005
Table of Contents
1. Introduction ................................................. 3
2. Processing Model ............................................. 4
3. Design Overview .............................................. 6
4. Concepts ..................................................... 6
5. Interface Definitions ........................................ 8
5.1. VTSManager .............................................. 8
5.1.1. getParticipantRepository ......................... 8
5.1.2. getVoucherComponentRepository .................... 8
5.2. ParticipantRepository ................................... 9
5.2.1. lookup ........................................... 9
5.3. Participant ............................................. 9
5.3.1. getIdentifier .................................... 10
5.3.2. getVTSAgent ...................................... 10
5.4. VTSAgent ................................................ 10
5.4.1. login ............................................ 11
5.4.2. logout ........................................... 12
5.4.3. prepare .......................................... 12
5.4.4. issue ............................................ 13
5.4.5. transfer ......................................... 14
5.4.6. consume .......................................... 15
5.4.7. present .......................................... 16
5.4.8. cancel ........................................... 17
5.4.9. resume ........................................... 18
5.4.10. create .......................................... 18
5.4.11. delete .......................................... 19
5.4.12. getContents ..................................... 19
5.4.13. getSessions ..................................... 19
5.4.14. getLog .......................................... 20
5.4.15. addReceptionListener ............................ 20
5.4.16. removeReceptionListener ......................... 21
5.5. Session ................................................. 21
5.5.1. getIdentifier .................................... 21
5.5.2. getVoucher ....................................... 22
5.5.3. getSender ........................................ 22
5.5.4. getReceiver ...................................... 22
5.5.5. isPrepared ....................................... 22
5.5.6. isActivated ...................................... 23
5.5.7. isSuspended ...................................... 23
5.5.8. isCompleted ...................................... 23
5.6. Voucher ................................................. 23
5.6.1. getIssuer ........................................ 23
5.6.2. getPromise ....................................... 24
Show full document text