API Reference

Get Services for Client

post https://uat.api.globalpay.convera.com/geo-api/clientServices

Provides a list of services configured for a clientId under the partner account

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:vc="http://www.w3.org/2007/XMLSchema-versioning" xmlns:tns="http://api.globalpay.convera.com" targetNamespace="http://api.globalpay.convera.com" elementFormDefault="qualified" attributeFormDefault="unqualified" vc:minVersion="1.1">
    <xs:include schemaLocation="common.xsd"/>
    <xs:element name="clientServicesRequest" type="tns:ClientServicesRequestType"/>
    <xs:complexType name="ClientServicesRequestType">
        <xs:complexContent>
            <xs:extension base="tns:AbstractInputType">
                <xs:sequence>
                    <xs:element name="clientId" type="xs:long" minOccurs="0" maxOccurs="1"/>
                </xs:sequence>
            </xs:extension>
        </xs:complexContent>
    </xs:complexType>
    <xs:element name="clientServicesResponse" type="tns:ClientServicesResponseType"/>
    <xs:complexType name="ClientServicesResponseType">
        <xs:complexContent>
            <xs:extension base="tns:AbstractOutputType">
                <xs:sequence>
                    <xs:element name="debtorGroups" type="tns:DebtorGroups"/>
                </xs:sequence>
            </xs:extension>
        </xs:complexContent>
    </xs:complexType>
    <xs:complexType name="DebtorGroups">
        <xs:sequence>
            <xs:element name="debtorGroup" type="tns:DebtorGroup" minOccurs="0" maxOccurs="unbounded"/>
        </xs:sequence>
    </xs:complexType>
    <xs:complexType name="DebtorGroup">
        <xs:sequence>
            <xs:element name="serviceItem" type="tns:ServiceItem" minOccurs="0" maxOccurs="unbounded"/>
        </xs:sequence>
        <xs:attribute name="name" type="tns:String30Type"/>
    </xs:complexType>
    <xs:complexType name="ServiceItem">
        <xs:sequence>
            <xs:element name="id" type="tns:String255Type"/>
            <xs:element name="name" type="tns:String255Type"/>
            <xs:element name="description" type="tns:String255Type"/>
            <xs:element name="mandatory" type="xs:boolean"/>
            <xs:element name="amountOwing" type="xs:decimal"/>
            <xs:element name="minAmount" type="xs:decimal" nillable="true"/>
            <xs:element name="maxAmount" type="xs:decimal" nillable="true"/>
            <xs:element name="editable" type="xs:boolean" minOccurs="0"/>
        </xs:sequence>
    </xs:complexType>

</xs:schema>


<clientServicesRequest xmlns="http://api.globalpay.convera.com">
    <clientId>123456789</clientId>
</clientServicesRequest>

<clientServicesResponse xmlns="http://api.globalpay.convera.com" xmlns:tns="http://api.globalpay.convera.com" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <status success="true"/>
    <debtorGroups>
        <debtorGroup>
            <serviceItem>
                <id>100000012345</id>
                <name>Tuition</name>
                <description>Tuition Fee</description>
                <mandatory>false</mandatory>
                <amountOwing>100</amountOwing>
                <minAmount xsi:nil="true"/>
                <maxAmount xsi:nil="true"/>
                <editable>true</editable>
            </serviceItem>
        </debtorGroup>
    </debtorGroups>
</clientServicesResponse>
Language
URL