<?xml version="1.0" encoding="US-ASCII"?>
<!DOCTYPE rfc SYSTEM "rfc2629.dtd" [
<!-- One method to get references from the online citation libraries.
     There has to be one entity for each item to be referenced. 
     An alternate method (rfc include) is described in the references. -->
<!ENTITY RFC2119 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.2119.xml">
<!ENTITY RFC5730 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.5730.xml">
<!ENTITY I-D.narten-iana-considerations-rfc2434bis SYSTEM "http://xml.resource.org/public/rfc/bibxml3/reference.I-D.narten-iana-considerations-rfc2434bis.xml">
]>
<?xml-stylesheet type='text/xsl' href='rfc2629.xslt' ?>
<!-- used by XSLT processors -->
<!-- For a complete list and description of processing instructions (PIs), 
     please see http://xml.resource.org/authoring/README.html. -->
<!-- Below are generally applicable Processing Instructions (PIs) that most I-Ds might want to use.
     (Here they are set differently than their defaults in xml2rfc v1.32) -->
<?rfc private="VeriSign Inc. Proprietary Information" ?>
<?rfc strict="yes" ?>
<!-- give errors regarding ID-nits and DTD validation -->
<!-- control the table of contents (ToC) -->
<?rfc toc="yes"?>
<!-- generate a ToC -->
<?rfc tocdepth="4"?>
<!-- the number of levels of subsections in ToC. default: 3 -->
<!-- control references -->
<?rfc symrefs="yes"?>
<!-- use symbolic references tags, i.e, [RFC2119] instead of [1] -->
<?rfc sortrefs="yes" ?>
<!-- sort the reference entries alphabetically -->
<!-- control vertical white space 
     (using these PIs as follows is recommended by the RFC Editor) -->
<?rfc compact="yes" ?>
<!-- do not start each main section on a new page -->
<?rfc subcompact="yes"?>
<!-- keep one blank line between list items -->
<?rfc comments="yes" ?>
<!-- show cref output -->
<?rfc inline="yes" ?>
<!-- inline cref output -->
<!-- end of list of popular I-D processing instructions -->
<rfc category="info" docName="verisign_epp-extension_balance_v01" ipr="none">
  <!-- category values: std, bcp, info, exp, and historic
     ipr values: full3667, noModification3667, noDerivatives3667
     you can add the attributes updates="NNNN" and obsoletes="NNNN" 
     they will automatically be output with "(if approved)" -->

  <!-- ***** FRONT MATTER ***** -->

  <front>
    <title abbrev="balance">Balance Mapping for the Extensible Provisioning Protocol (EPP)</title>

    <author fullname="James Gould" initials="J.G" surname="Gould">
      <organization>VeriSign, Inc.</organization>

      <address>
        <postal>
          <street>12061 Bluemont Way</street>

          <city>Reston</city>

          <region>VA</region>

          <code>20190</code>

          <country>US</country>
        </postal>

        <email>jgould@verisign.com</email>

        <uri>http://www.verisigninc.com</uri>
      </address>
    </author>


    <date day="16" month="December" year="2013"/>

    <abstract>
      <t>This document describes an Extensible Provisioning Protocol (EPP)
      mapping for retrieving the client balance and other financial 
      information.</t>
    </abstract>
    
    <note title="Legal Disclaimer">
      <t>COPYRIGHT NOTIFICATION</t>
      <t>Copyright 2013 VeriSign, Inc. All rights reserved. VERISIGN; 
      the Verisign logo; and other trademarks, service marks and Verisign designs are registered or 
      unregistered trademarks of VeriSign Inc. and its subsidiaries in the United States and foreign countries. 
      Copyright laws and international treaties protect this document, and any Verisign product to which it relates.</t>
      
      <t>VERISIGN PROPRIETARY INFORMATION</t>
      <t>This document is the property of VeriSign, Inc. and its subsidiaries (together "Verisign") It may be used by 
      recipient only for the purpose for which it was transmitted and must be returned upon request or when no longer 
      needed by recipient. It may not be copied or communicated without the prior written consent of Verisign.</t>

      <t>NOTICE AND CAUTION</t>
      <t>Concerning U.S. Patent or Trademark Rights</t>
      <t>Verisign and other trademarks, service marks and logos are registered or unregistered trademarks of 
      Verisign and its subsidiaries in the United States and in foreign countries. The inclusion in this 
      document, the associated on-line file or the associated software of any information covered by any 
      other patent, trademark or service mark rights does not constitute nor imply a grant of or authority 
      to exercise, any right or privilege protected by such patent, trademark or service mark. All such 
      rights and privileges are vested in the patent, trademark or service mark owner and no other person 
      may exercise such rights without express permission, authority or license secured from the patent, 
      trademark or service mark owner.</t>    
    </note>
    
  </front>

  <middle>
    <section title="Introduction">
      <t>This document describes an extension mapping for version 1.0 of the
      <xref target="RFC5730">Extensible Provisioning Protocol (EPP)</xref>.
      This EPP mapping enables a client to get their financial information including 
      the balance, credit limit, available credit, and credit threshold.</t>

      <section title="Conventions Used in This Document">
        <t>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
        "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
        document are to be interpreted as described in <xref
        target="RFC2119">RFC 2119</xref>.</t>

        <t>XML is case sensitive. Unless stated otherwise, XML specifications
        and examples provided in this document MUST be interpreted in the
        character case presented in order to develop a conforming
        implementation.</t>
        
        <t>In examples, "C:" represents lines sent by a protocol client and "S:" represents lines returned by a protocol server.  
        Indentation and white space in examples are provided only to illustrate element relationships 
        and are not a REQUIRED feature of this protocol.        
        </t>

        <t>"balance-1.0" is used as an abbreviation for
        "http://www.verisign.com/epp/balance-1.0". The XML namespace prefix "balance"
        is used, but implementations MUST NOT depend on it and instead employ
        a proper namespace-aware XML parser and serializer to interpret and
        output the XML documents.</t>
      </section>
    </section>

    <section anchor="attrs" title="Object Attributes">
    
      <t></t>

      <section anchor="decimal-attribute" title="Decimal Attribute Values">
        <t>All of the EPP Balance currency object attributes use the XML <eref
         target="http://www.w3.org/TR/2004/REC-xmlschema-2-20041028/#decimal">decimal</eref> 
        data type to represent the currency value in the currency of the server.  
        The precision is restricted to 2 fractional digits.</t>
      </section>
         
       <section anchor="dates-times" title="Dates and Times">
        <t>Date and time attribute values MUST be represented in Universal Coordinated Time  
        (UTC) using the Gregorian calendar.  The extended date-time form using upper case "T" 
        and "Z" characters defined in <eref
         target="http://www.w3.org/TR/2004/REC-xmlschema-2-20041028/">XML Schema Part 2</eref> 
         MUST be used to represent date-time values, as 
        XML Schema does not support truncated date-time forms or lower case "T" and "Z" characters.</t>
      </section>
         
    </section>

    <section anchor="commands" title="EPP Command Mapping">
      <t>A detailed description of the EPP syntax and semantics can be found
      in the EPP core protocol specification <xref target="RFC5730"/>. The
      command mappings described here are specifically for use with the 
      Balance object mapping.</t>

      <section anchor="queryCommands" title="EPP Query Commands">
      
        <t><xref target="RFC5730">EPP</xref> provides three commands to retrieve object information: &lt;check&gt; to determine 
        if an object is known to the server, &lt;info&gt; to retrieve detailed information associated 
        with an object, and &lt;transfer&gt; to retrieve object transfer status information.</t>
        
      <section anchor="checkCommand" title="EPP &lt;check&gt; Command">
       <t>Available check semantics do not apply to balance objects, so there is no 
       mapping defined for the EPP &lt;check&gt; command.</t>
               
      </section>

      <!-- end CHECK command -->

      <section anchor="infoCommand" title="EPP &lt;info&gt; Command">
      
       <t>EPP provides the &lt;info&gt; command that is used to retrieve client balance and other financial information.  
       In addition to the standard EPP command elements, the &lt;info&gt; command MUST contain a 
       &lt;balance:info&gt; element that identifies the balance namespace.  
       The &lt;balance:info&gt; element does not contain any child elements.</t>
              
 
       <figure>
            <preamble>Example &lt;info&gt; command:</preamble>

            <artwork><![CDATA[
C:<?xml version="1.0" encoding="UTF-8" standalone="no"?>
C:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
C:  <command>
C:    <info>
C:      <balance:info
C:        xmlns:balance="http://www.verisign.com/epp/balance-1.0"/>
C:    </info>
C:    <clTRID>ABC-12345</clTRID>
C:  </command>
C:</epp>]]></artwork>
       </figure>
       
       <t>When an &lt;info&gt; command has been processed successfully, 
       the EPP &lt;resData&gt; element MUST contain a child &lt;balance:infData&gt; element that 
       identifies the balance namespace.  
       The &lt;balance:infData&gt; element contains the following child elements:</t>
       
      <t><list hangIndent="4" style="hanging">
          <t hangText="&lt;balance:creditLimit&gt;">element that contains the 
          credit limit in the currency of the server.</t>
          <t hangText="&lt;balance:balance&gt;">element that contains the 
          balance in the currency of the server.</t>
          <t hangText="&lt;balance:availableCredit&gt;">element that contains the 
          available credit in the currency of the server.</t>
          <t hangText="&lt;balance:creditThreshold&gt;">element that contains the 
          low available credit threshold to receive a 
          low balance notification message based on the Low Balance EPP Mapping.  
          The &lt;balance:creditThreshold&gt; element contains one of the 
          following child elements:</t>
          <t><list hangIndent="4" style="hanging">
            <t hangText="&lt;balance:fixed&gt;">element that contains a fixed 
            amount low credit threshold in the currency of the server.</t>
            <t hangText="&lt;balance:percent&gt;">element that contains an 
            integer percent value low credit threshold that represents a 
            percentage of the &lt;balance:creditLimit&gt; value.  
            The low credit threshold is calculated by multiplying the 
            &lt;balance:creditLimit&gt; value with the &lt;balance:percent&gt; 
            percentage value.</t>
          </list></t>
       </list></t>
       
       
       <figure>
            <preamble>Example &lt;info&gt; with fixed low credit 
            threshold response:</preamble>

            <artwork><![CDATA[
S:<?xml version="1.0" encoding="UTF-8" standalone="no"?>
S:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
S:  <response>
S:    <result code="1000">
S:      <msg>Command completed successfully</msg>
S:    </result>
S:    <resData>
S:      <balance:infData
S:        xmlns:balance="http://www.verisign.com/epp/balance-1.0">
S:        <balance:creditLimit>1000.00</balance:creditLimit>
S:        <balance:balance>200.00</balance:balance>
S:        <balance:availableCredit>800.00</balance:availableCredit>
S:        <balance:creditThreshold>
S:          <balance:fixed>500.00</balance:fixed>
S:        </balance:creditThreshold>    
S:      </balance:infData>
S:    </resData>
S:    <trID>
S:      <clTRID>ABC-12345</clTRID>
S:      <svTRID>54322-XYZ</svTRID>
S:    </trID>
S:  </response>
S:</epp>]]></artwork>
       </figure>
 
       <figure>
            <preamble>Example &lt;info&gt; with percent low credit 
            threshold response:</preamble>

            <artwork><![CDATA[
S:<?xml version="1.0" encoding="UTF-8" standalone="no"?>
S:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
S:  <response>
S:    <result code="1000">
S:      <msg>Command completed successfully</msg>
S:    </result>
S:    <resData>
S:      <balance:infData
S:        xmlns:balance="http://www.verisign.com/epp/balance-1.0">
S:        <balance:creditLimit>1000.00</balance:creditLimit>
S:        <balance:balance>200.00</balance:balance>
S:        <balance:availableCredit>800.00</balance:availableCredit>
S:        <balance:creditThreshold>
S:          <balance:percent>50</balance:percent>
S:        </balance:creditThreshold>    
S:      </balance:infData>
S:    </resData>
S:    <trID>
S:      <clTRID>ABC-12345</clTRID>
S:      <svTRID>54322-XYZ</svTRID>
S:    </trID>
S:  </response>
S:</epp>]]></artwork>
       </figure>
        
      </section>
      <!-- end INFO command -->

      <section anchor="transferQueryCommand" title="EPP &lt;transfer&gt; Command">
      
       <t>Transfer semantics do not apply to balance objects, so there is no mapping 
       defined for the EPP &lt;transfer&gt; command.</t>
       
      </section>
      <!-- end TRANSFER command -->

      </section>
      
      <section anchor="transformCommands" title="EPP Transform Commands">
      
        <t>EPP provides five commands to transform objects: &lt;create&gt; to create an instance of an object, 
        &lt;delete&gt; to delete an instance of an object, &lt;renew&gt; to extend the validity period of an object,
        &lt;transfer&gt; to manage object sponsorship changes, and &lt;update&gt; to change information associated 
        with an object.</t>
        
      <section anchor="createCommand" title="EPP &lt;create&gt; Command">
      
       <t>Create semantics do not apply to balance objects, so there is no mapping 
       defined for the EPP &lt;create&gt; command.</t>
        
      </section>
      <!-- end CREATE command -->

      <section anchor="deleteCommand" title="EPP &lt;delete&gt; Command">
      
       <t>Delete semantics do not apply to balance objects, so there is no mapping 
       defined for the EPP &lt;delete&gt; command.</t>
         
      </section>
      <!-- end DELETE command -->

      <section anchor="renewCommand" title="EPP &lt;renew&gt; Command">
      
       <t>Renew semantics do not apply to balance objects, so there is no mapping 
       defined for the EPP &lt;renew&gt; command.</t>
       
      </section>
      <!-- end RENEW command -->

      <section anchor="transferCommand" title="EPP &lt;transfer&gt; Command">
      
       <t>Transfer semantics do not apply to balance objects, so there is no mapping 
       defined for the EPP &lt;transfer&gt; command.</t>
       
      </section>
      <!-- end TRANSFER command -->

      <section anchor="updateCommand" title="EPP &lt;update&gt; Command">
      
       <t>Update semantics do not apply to balance objects, so there is no mapping 
       defined for the EPP &lt;update&gt; command.</t>
        
      </section>
      <!-- end UPDATE command -->
      
     </section>
      
    </section>

    <!-- EPP command mapping -->

    <section anchor="syntax" title="Formal Syntax">
    
      <t>One schema is presented here that is the EPP Balance
      schema.</t>
      
      <t>The formal
      syntax presented here is a complete schema representation of the object
      mapping suitable for automated validation of EPP XML instances. The
      BEGIN and END tags are not part of the schema; they are used to note the
      beginning and ending of the schema for URI registration purposes.</t>

    <section title="Balance Mapping Schema">

      <figure>
        <artwork><![CDATA[
BEGIN
<?xml version="1.0" encoding="UTF-8"?>

  <schema 
    targetNamespace="http://www.verisign.com/epp/balance-1.0"
    xmlns:balance="http://www.verisign.com/epp/balance-1.0"
    xmlns="http://www.w3.org/2001/XMLSchema"
    elementFormDefault="qualified">
  
  <annotation>
    <documentation>
      Extensible Provisioning Protocol v1.0
      Verisign mapping for getting account balance and 
      other financial information.
    </documentation>
  </annotation>

<!--
Child elements found in EPP commands.
-->
  <!-- Empty balance:info command element -->
  <element name="info"/>
  
<!--
Child response elements.
-->
  <element name="infData" type="balance:infDataType"/>
  
  <!--Child elements of the balance:infData element -->
  <complexType name="infDataType">
    <sequence>
      <element name="creditLimit" 
        type="balance:currencyValueType"/>
      <element name="balance" 
        type="balance:currencyValueType"/>               
      <element name="availableCredit" 
        type="balance:currencyValueType"/>               
      <element name="creditThreshold" 
        type="balance:thresholdType"/>      
    </sequence>
  </complexType>

  <complexType name="thresholdType">
    <choice> 
      <element name="fixed" 
        type="balance:currencyValueType"/>
      <element name="percent" 
        type="integer"/>
    </choice>
  </complexType>
             
  <simpleType name="currencyValueType">
    <restriction base="decimal">
      <fractionDigits value="2"/>
    </restriction>
  </simpleType>
   
<!-- End of schema.-->   
</schema>
END]]></artwork>
      </figure>
      </section>
    </section>
   
   <section title="Change History">
    <section title="Version 01" anchor="version-01">
      <t><list style="numbers">
        <t>Initial version of Internet-Draft format of the 
        EPP Balance Mapping, version 1.0.</t>
      </list></t>
    </section>
   </section>
    

    <section anchor="Security" title="Security Considerations">
      <t>The mapping extensions described in this document do not provide any
      security services beyond those described by <xref
      target="RFC5730">EPP</xref> and protocol layers used by EPP. The security
      considerations described in these other specifications apply to this
      specification as well.</t>
    </section>

  </middle>

  <!--  *****BACK MATTER ***** -->

  <back>
    <!-- References split into informative and normative -->

    <!-- There are 2 ways to insert reference entries from the citation libraries:
     1. define an ENTITY at the top, and use "ampersand character"RFC2629; here (as shown)
     2. simply use a PI "less than character"?rfc include="reference.RFC.2119.xml"?> here
        (for I-Ds: include="reference.I-D.narten-iana-considerations-rfc2434bis.xml")

     Both are cited textually in the same manner: by using xref elements.
     If you use the PI option, xml2rfc will, by default, try to find included files in the same
     directory as the including file. You can also define the XML_LIBRARY environment variable
     with a value containing a set of directories to search.  These can be either in the local
     filing system or remote ones accessed by http (http://domain/dir/... ).-->

    <references title="Normative References">
       
      &RFC2119;

      &RFC5730;

    </references>
  </back>

  <!-- vim: set ts=2 sw=2 expandtab: -->
</rfc>
