API Reference

Get Required Fields V2

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

Buyer fields search - only returns records that are changed within the timeframe specified by inputs startDate and endDate in YYYY-MM-DD format.

<?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="buyerFieldsRequest" type="tns:BuyerFieldsRequestTypeV2"/>
    <xs:complexType name="BuyerFieldsRequestTypeV2">
        <xs:complexContent>
            <xs:extension base="tns:AbstractInputType">
                <xs:sequence>
                    <xs:element name="clientId" type="xs:long" minOccurs="0" />
                    <xs:element name="startDate" type="xs:date" minOccurs="0"/>
                    <xs:element name="endDate" type="xs:date" minOccurs="0"/>
                </xs:sequence>
            </xs:extension>
        </xs:complexContent>
    </xs:complexType>
    <xs:element name="buyerFieldsResponse" type="tns:BuyerFieldsResponseTypeV2"/>
    <xs:complexType name="BuyerFieldsResponseTypeV2">
        <xs:complexContent>
            <xs:extension base="tns:AbstractOutputType">
                <xs:sequence>
                    <xs:element name="fields" type="tns:BuyerFieldsV2" />
                </xs:sequence>
            </xs:extension>
        </xs:complexContent>
    </xs:complexType>

    <xs:complexType name="BuyerFieldsV2">
        <xs:sequence>
            <xs:element name="field" type="tns:FieldV2" minOccurs="0" maxOccurs="unbounded"/>
        </xs:sequence>
    </xs:complexType>

    <xs:complexType name="FieldV2">
        <xs:sequence>
            <xs:element name="labelText" type="tns:String255Type"/>
            <xs:element name="name" type="tns:String255Type" />
            <xs:element name="display" type="xs:boolean" minOccurs="0" />
            <xs:element name="mandatory" type="xs:boolean"  />
            <xs:element name="description" type="tns:String255Type"  />
            <xs:element name="type" type="tns:fieldsTypeRestriction"  />
            <xs:element name="minLength" type="xs:integer" minOccurs="0" />
            <xs:element name="maxLength" type="xs:integer" minOccurs="0" />
            <xs:element name="sequence" type="xs:integer"  />
            <xs:element name="validationExpression" type="tns:String255Type" minOccurs="0" />
            <xs:element name="values" type="tns:FieldValuesV2" minOccurs="0" />
            <xs:element name="action" type="tns:actionType" minOccurs="0"  />
        </xs:sequence>
    </xs:complexType>

    <xs:complexType name="FieldValuesV2">
        <xs:sequence>
            <xs:element name="value" type="tns:String255Type" minOccurs="1" maxOccurs="unbounded"/>
        </xs:sequence>
    </xs:complexType>


</xs:schema>


<buyerFieldsRequest xmlns="http://api.globalpay.convera.com">
    <clientId>123456789</clientId>
    <startDate>2023-01-01</startDate>
    <endDate>2023-03-31</endDate>
</buyerFieldsRequest>

<buyerFieldsResponse 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"/>
    <fields>
        <field>
            <labelText>Country</labelText>
            <name>country</name>
            <display>true</display>
            <mandatory>false</mandatory>
            <description/>
            <type>country</type>
            <sequence>31</sequence>
            <validationExpression/>
            <values>
                <value/>
            </values>
            <action>update</action>
        </field>
    </fields>
</buyerFieldsResponse>
Language
URL