Get Active Clients

Provides a list of active clients configured under partner account for countryCode and clientName search parameters

<?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="clientSearchRequest" type="tns:ClientSearchRequestType"/> <xs:complexType name="ClientSearchRequestType"> <xs:complexContent> <xs:extension base="tns:AbstractInputType"> <xs:sequence> <xs:element name="countryCode" type="tns:CountryCodeType" minOccurs="1" maxOccurs="1"/> <xs:element name="clientName" type="tns:String255Type" minOccurs="0"/> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:element name="clientSearchResponse" type="tns:ClientSearchResponseType"/> <xs:complexType name="ClientSearchResponseType"> <xs:complexContent> <xs:extension base="tns:AbstractOutputType"> <xs:sequence> <xs:element name="clients" type="tns:Client"/> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:complexType name="Client"> <xs:sequence> <xs:element name="client" type="tns:ClientDetails" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType> <xs:complexType name="ClientDetails"> <xs:sequence> <xs:element name="id" type="xs:long"/> <xs:element name="name" type="tns:String255Type"/> <xs:element name="displayName" type="tns:String255Type"/> <xs:element name="defaultSettlementCurrencyCode" type="tns:CurrencyCodeType"/> <xs:element name="defaultLanguage" type="tns:String30Type"/> </xs:sequence> </xs:complexType> </xs:schema>
<clientSearchRequest xmlns="http://api.globalpay.convera.com"> <countryCode>GBR</countryCode> <clientName>CUST</clientName> </clientSearchRequest>
<clientSearchResponse 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"/> <clients> <client> <id>10000123123</id> <name>CUSTOMER_NAME</name> <displayName/> <defaultSettlementCurrencyCode>GBP</defaultSettlementCurrencyCode> <defaultLanguage>en_GB</defaultLanguage> </client> </clients> </clientSearchResponse>
Body Params

requestData

string
required
string
length ≤ 255
Responses

Language
URL
Choose an example:
application/xml
Convera Logo

© 2022 All Rights Reserved