Transferable Digital Notes Project

TDNSYS API

TDNSYS Global Settings

Banks
Merchants
Maximum Value

Public API Calls
These calls can be executed by any software system on the Internet. The caller must have a valid TDN and the PIN or PKI if set. PIN and PKI are not required if the call is only for TDN public validation.
A call has the following format ???? API Calls available only to the member banks
Banks systems can use these calls to request withdraw or deposit TDNs in their reserve accounts with the Central Bank. API Calls available only to the investigative authorities
In case of fraud or complaints an investigation may be authorized by the Central Bank. In these situations the TDN in question has to be blocked for the duration of the investigation. These calls are implemented in the Case Management system part of TDNSYS.

TDNSYS Global Settings
Banks
Merchants
Maximum Value

Client Server
Begin Transaction

API Calls Syntax
The API calls are not exactly define because at this time an implementation of TDNSYS server site does not exist. The exact calls field lengths and values will be defined during the development of TDNSYS.
The calls are documented in a table with two columns. The left column is the Client side and the right is the Server (CB TDNSYS) side. The request called is highlighted and has a Call ID as the first field. and the right for the server response.
Each API call is defined as a transactions. If a step of the transaction fails the transaction is rolled back.

Keywords
Begin Transaction , End Transaction
If Success, If Failed, Goto End, Roll Back
PIN /PKI Challenge If PIN parameter sent: Server validates against the value set for the TDN
If PKI parameter sent: Server encrypts a string using the public key
Client sends back the decrypted string.
CERT Challenge All Banks and Investigators must always set a PKI for a TDN as the private key of a certificate issued by the Central Bank. PIN security is not accepted. Server encrypts a string using the public key
Client sends back the decrypted string.
Parameter Values
009 Call ID - Always the first field zero padded numerical values
( param ) Optional parameter
| Field Separator
-- Call step ends
TDN TDN Signature
PIN /PKI) is a set of roles, policies, hardware, software and procedures needed to create, manage, distribute, use, store and revoke digital certificates and manage public-key encryption. The purpose of a PKI is to facilitate the secure electronic transfer of information for a range of network activities such as e-commerce, internet banking and confidential email.">PKI PIN or PKI set for TDN
CERT TDN belonging to Banks must always be signed with a Digital Certificate
TDN status Status : 0 = canceled, 1 = active, 2 = blocked
Value TDN associated value in the form $dollars.cents. The Central Bank sets a maximum value for a publicly used TDN. All TDNs with values larger must be signed with a digital certificate issued by the Central Bank.
TDN TDN Signature
XML Field value stored in XML format
0, 1 Failed and Success values


Public API Calls
These calls can be executed by any software system on the Internet. The caller must have a valid TDN and the PIN or PKI ) is a set of roles, policies, hardware, software and procedures needed to create, manage, distribute, use, store and revoke digital certificates and manage public-key encryption. The purpose of a PKI is to facilitate the secure electronic transfer of information for a range of network activities such as e-commerce, internet banking and confidential email.">PKI if set. PIN and PKI are not required if the call is only for TDN validation.

  • Validate TDN
  • This call can be made by any client without the need of a PIN of PKI .

    Client Server
    Begin Transaction
    001 | TDN If Success TDN | status | Value --
    If Failed 0 --
    End Transaction
    (see API calls syntax)

  • Split TDN
  • Client Server
    Begin Transaction
    201 | TDN | PIN /PKI --
    PIN /PKI Challenge
    If Success TDN | Value | XML--
    If Failed 0 --
    End Transaction
    (see API calls syntax)

  • Consolidate TDNs
  • Client Server
    Begin Transaction
    201 | TDN | PIN /PKI --
    PIN /PKI Challenge
    If Success TDN | Value | XML--
    If Failed 0 --
    End Transaction
    (see API calls syntax)

  • Request TDN Ownership
  • Client Server
    Begin Transaction
    201 | TDN | PIN /PKI --
    PIN /PKI Challenge
    If Success TDN | Value | XML--
    If Failed 0 --
    End Transaction
    (see API calls syntax)

  • Set TDN PIN
  • Client Server
    Begin Transaction
    201 | TDN | PIN/ PKI --
    PIN/ PKI Challenge
    If Success TDN | Value | XML--
    If Failed 0 --
    End Transaction
    (see API calls syntax)

  • Set TDN PKI
  • Client Server
    Begin Transaction
    201 | TDN | PIN/ PKI --
    PIN/ PKIChallenge
    If Success TDN | Value | XML--
    If Failed 0 --
    End Transaction
    (see API calls syntax)

API Calls available only to the Member Banks
Banks systems can use these calls to request withdraw or deposit TDNs in their reserve accounts with the Central Bank.

  • Request TDN Data
  • Client Server
    Begin Transaction
    201 | TDN | PIN/ PKI--
    PIN/ PKI Challenge
    If Success TDN | Value | XML--
    If Failed 0 --
    End Transaction
    (see API calls syntax)

  • Initial TDN Issue
  • Client Server
    Begin Transaction
    201 | TDN | PIN / PKI--
    PIN /PKI Challenge
    If Success TDN | Value | XML--
    If Failed 0 --
    End Transaction
    (see API calls syntax)

  • Redeem TDN
  • Client Server
    Begin Transaction
    201 | TDN | PIN / PKI--
    PIN /PKI Challenge
    If Success TDN | Value | XML--
    If Failed 0 --
    End Transaction
    (see API calls syntax)

API Calls available only to the Investigative authorities
In case of fraud or complaints an investigation may be authorized by the Central Bank. In these situations the TDN in question has to be blocked for the duration of the investigation. These calls are implemented in the Case Management system part of TDNSYS.

  • Change TDN status
  • Client Server
    Begin Transaction
    201 | TDN | PIN / PKI --
    PIN /PKI Challenge
    If Success TDN | Value | XML--
    If Failed 0 --
    End Transaction
    (see API calls syntax)