Validate Expected Receivable

Returns <status success="true"> if receivable passes API validation or <status success="false"> with relevant error code.

<?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="logExpectedReceivableRequest" type="tns:LogExpectedReceivableRequestType"/>
    <xs:complexType name="LogExpectedReceivableRequestType">
        <xs:complexContent>
            <xs:extension base="tns:AbstractInputType">
                <xs:sequence>
                    <xs:element name="clientId" type="xs:long" minOccurs="0" />
                    <xs:element name="foreignOrderId" type="tns:SwiftString"/>
                    <xs:element name="item" maxOccurs="100">
                        <xs:complexType>
                            <xs:sequence>
                                <xs:element name="foreignItemId" type="tns:SwiftString"/>
                                <xs:element name="payment" type="xs:decimal" minOccurs="1" />
                                <xs:element name="fee" type="xs:decimal" minOccurs="0" />
                                <xs:element name="serviceItems" type="tns:ServiceCatalog" minOccurs="0"/>
                                <xs:element name="receivedBankRefNo" type="tns:SwiftString" minOccurs="0"/>
                                <xs:element name="buyer" >
                                    <xs:complexType>
                                        <xs:sequence>
                                            <xs:element name="firstName" type="tns:String255Type" minOccurs="0"/>
                                            <xs:element name="lastName" type="tns:String255Type" minOccurs="0"/>
                                            <xs:element name="address" type="tns:String255Type" minOccurs="0"/>
                                            <xs:element name="city" type="tns:String255Type" minOccurs="0"/>
                                            <xs:element name="state" type="tns:String255Type" minOccurs="0"/>
                                            <xs:element name="zip" type="tns:String255Type" minOccurs="0"/>
                                            <xs:element name="countryCode" type="tns:CountryCodeType" minOccurs="0"/>
                                            <xs:element name="email" type="tns:EmailType" minOccurs="0"/>
                                            <xs:element name="businessId" type="tns:String255Type" minOccurs="0"/>
                                            <xs:element name="invoiceNumber" type="tns:String255Type" minOccurs="0"/>
                                            <xs:element name="customField" minOccurs="0" maxOccurs="20">
                                                <xs:complexType>
                                                    <xs:sequence>
                                                        <xs:element name="name" type="tns:String30Type"/>
                                                        <xs:element name="value" type="tns:String255Type" />
                                                    </xs:sequence>
                                                </xs:complexType>
                                            </xs:element>
                                        </xs:sequence>
                                    </xs:complexType>
                                </xs:element>
                                <xs:element name="buyerBank" minOccurs="0">
                                    <xs:complexType>
                                        <xs:sequence>
                                            <xs:element name="name" type="tns:SwiftString70"/>
                                            <xs:element name="address1" type="tns:SwiftString60"/>
                                            <xs:element name="address2" type="tns:SwiftString40" minOccurs="0"/>
                                            <xs:element name="city" type="tns:SwiftString40"/>
                                            <xs:element name="state" type="tns:SwiftString40"/>
                                            <xs:element name="zip" type="tns:SwiftString40" minOccurs="0"/>
                                            <xs:element name="countryCode" type="tns:CountryCodeType"/>
                                            <xs:element name="accountCurrency" type="tns:CurrencyCodeType" minOccurs="0"/>
                                            <xs:element name="routingCode" type="tns:SwiftString11" minOccurs="0"/>
                                            <xs:element name="swiftCode" type="tns:SwiftString11" minOccurs="0"/>
                                        </xs:sequence>
                                    </xs:complexType>
                                </xs:element>
                                <xs:element name="remitter" type="tns:Remitter"/>
                            </xs:sequence>
                        </xs:complexType>
                    </xs:element>
                </xs:sequence>
            </xs:extension>
        </xs:complexContent>
    </xs:complexType>
    <xs:complexType name="ServiceCatalog">
        <xs:sequence>
            <xs:element name="item" type="tns:LogServiceItem" maxOccurs="unbounded"/>
        </xs:sequence>
    </xs:complexType>
    <xs:complexType name="LogServiceItem">
        <xs:sequence>
            <xs:element name="id" type="tns:String255Type" />
            <xs:element name="amountOwing" type="xs:decimal" />
        </xs:sequence>
    </xs:complexType>
    <xs:element name="logExpectedReceivableResponse" type="tns:LogExpectedReceivableResponseType"/>
    <xs:complexType name="LogExpectedReceivableResponseType">
        <xs:complexContent>
            <xs:extension base="tns:AbstractOutputType">
                <xs:sequence>
                    <xs:element name="foreignOrderId" type="tns:String30Type" minOccurs="0" />
                    <xs:element name="orderId" type="xs:long"  minOccurs="0"/>
                    <xs:element name="item"  maxOccurs="100" minOccurs="0">
                        <xs:complexType>
                            <xs:sequence>
                                <xs:element name="foreignItemId" type="tns:String30Type"  />
                                <xs:element name="dealReference" type="xs:string"  />
                            </xs:sequence>
                        </xs:complexType>
                    </xs:element>
                </xs:sequence>
            </xs:extension>
        </xs:complexContent>

    </xs:complexType>
</xs:schema>

<logExpectedReceivableRequest xmlns="http://api.globalpay.convera.com">
    <clientId>12345</clientId>
    <foreignOrderId></foreignOrderId>
    <item>
        <foreignItemId>Item123</foreignItemId>
        <payment>100.00</payment>
        <fee>50</fee>
        <serviceItems>
            <item>
                <id>100000084833</id>
                <amountOwing>100.00</amountOwing>
            </item>
        </serviceItems>
        <buyer>
            <firstName>Bob</firstName>
            <lastName>Smith</lastName>
            <address>123 Test Lane</address>
            <countryCode>CAN</countryCode>
            <email>[email protected]</email>
            <businessId>123123</businessId>
        </buyer>
        <buyerBank>
            <name></name>
            <address1></address1>
            <city></city>
            <state></state>
            <countryCode>CAN</countryCode>
            <accountCurrency>GBR</accountCurrency>
            <routingCode></routingCode>
            <swiftCode>ABC99887</swiftCode>
        </buyerBank>
        <remitter>
            <name></name>
            <address1>123 Remitter Lane</address1>
            <address2></address2>
            <city>Peterborough</city>
            <state></state>
            <zip>PE1 1QL</zip>
            <countryCode>GBR</countryCode>
            <email>[email protected]</email>
            <remitterType>
                <individual>
                    <occupation>Lawyer</occupation>
                    <identification>
                        <document>passport</document>
                        <documentRef>123123123</documentRef>
                        <documentCountry>GBR</documentCountry>
                    </identification>
                    <alias>Thomas</alias>
                    <dob>2001-01-01</dob>
                    <residentCountry>IND</residentCountry>
                    <employerName>Convera</employerName>
                </individual>
            </remitterType>
        </remitter>
    </item>
</logExpectedReceivableRequest>
<validateExpectedReceivableResponse 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"/>
</validateExpectedReceivableResponse>
Language
URL
Convera Logo

© 2022 All Rights Reserved