Balance Check by EPP

Balance check command via EPP was implemented on March 3, 2014, and it is available to use.

Please see below a sample EPP balance check command and response, and the XML schema.

Please note that balance updates are not immediate, there will be a small delay until the balance adjustment occurs at the registry database. 

Balance Check Request

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
  <command>
    <info>
      <finance:info xmlns:finance="http://www.unitedtld.com/epp/finance-1.0">
      </finance:info>
    </info>
  <clTRID>Test</clTRID>
  </command>
</epp>

Balance Check Response

<?xml version="1.0" encoding="utf-8"?>
<epp xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="urn:ietf:params:xml:ns:epp-1.0 epp-1.0.xsd" xmlns="urn:ietf:params:xml:ns:epp-1.0">
  <response>
    <result code="1000">
      <msg>Command completed successfully</msg>
    </result>
    <resData>
      <finance:infData xmlns:finance="http://www.unitedtld.com/epp/finance-1.0">
        <finance:balance>99939047.94</finance:balance>
      </finance:infData>
    </resData>
    <trID>
      <clTRID>Test</clTRID>
      <svTRID>2e438303-259a-4bdc-b0de-e7d62c4b1477:2</svTRID>
    </trID>
  </response>
</epp>

Finance XML Schema

<?xml version="1.0" encoding="utf-8"?>
<schema targetNamespace="http://www.unitedtld.com/epp/finance-1.0"
        xmlns:finance="http://www.unitedtld.com/epp/finance-1.0"
        xmlns="http://www.w3.org/2001/XMLSchema"
        xmlns:eppcom="urn:ietf:params:xml:ns:eppcom-1.0"
        elementFormDefault="qualified">
        
  <annotation>
    <documentation>
      Extensible Provisioning Protocol v1.0
      Mapping for account balance and thresholds.
    </documentation>
  </annotation>
  
  <!-- Child elements found in EPP commands. -->
  <element name="info"/>
  
  <!-- Child response elements. -->
  <element name="infData" type="finance:infRespType"/>
  
  <complexType name="infRespType">
    <sequence>
      <element name="balance" type="decimal"/>
      <element name="threshold" type="finance:thresholdType" minOccurs="0" maxOccurs="unbounded"/>
    </sequence>
  </complexType>
  
  <complexType name="thresholdType">
    <simpleContent>
      <extension base="decimal">
        <attribute name="type" type="token" use="required"/>
      </extension>
    </simpleContent>
  </complexType>
  
</schema>

Related Articles