Get Quote for Order

Provides a quote for provided order information. Can be later executed through Log Previously Quoted Order request.

<?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="quoteOrderResponse" type="tns:QuoteOrderResponseType"/>
	<xs:element name="quoteOrderRequest" type="tns:QuoteOrderRequestType"/>
	<xs:complexType name="QuoteOrderRequestType">
		<xs:complexContent>
			<xs:extension base="tns:AbstractInputType">
				<xs:sequence>
					<xs:element name="clientId" type="xs:int"/>
					<xs:element name="foreignOrderId" type="tns:SwiftString"/>
					<xs:element name="settlementCurrencyCode" type="tns:CurrencyCodeType" minOccurs="0"/>
					<xs:element name="item">
						<xs:complexType>
							<xs:sequence>
								<xs:element name="foreignItemId" type="tns:SwiftString"/>
								<xs:element name="paymentTypeCode" type="tns:PaymentCodeType"/>
								<xs:element name="paymentCurrencyCode" type="tns:CurrencyCodeType"/>
								<xs:element name="amount" type="xs:decimal"/>
								<xs:element name="amountType">
									<xs:simpleType>
										<xs:restriction base="xs:string">
											<xs:enumeration value="SETTLEMENT"/>
											<xs:enumeration value="PAYMENT"/>
										</xs:restriction>
									</xs:simpleType>
								</xs:element>
								<xs:element name="notesToWubs" type="tns:SwiftString" minOccurs="0"/>
								<xs:element name="expectedReceiveDate" type="xs:date" minOccurs="0"/>
								<xs:element name="receivedBankRefNo" type="tns:SwiftString" minOccurs="0"/>
								<xs:element name="language" type="xs:string"/>
								<xs:element name="payer" minOccurs="0">
									<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="payerId" type="tns:String255Type" minOccurs="0"/>
											<xs:element name="invoiceId" type="tns:String255Type" minOccurs="0"/>
											<xs:element name="custom" type="tns:String255Type" minOccurs="0" maxOccurs="20"/>
										</xs:sequence>
									</xs:complexType>
								</xs:element>
								<xs:element name="payerBank" 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:element name="remitterBank" type="tns:RemitterBank" minOccurs="0"/>
								<xs:element name="requiresRepair" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
								<xs:element name="repairInfo" type="tns:String1000Type" minOccurs="0" maxOccurs="1"/>
							</xs:sequence>
						</xs:complexType>
					</xs:element>
				</xs:sequence>
			</xs:extension>
		</xs:complexContent>
	</xs:complexType>
	<xs:complexType name="QuoteOrderResponseType">
		<xs:complexContent>
			<xs:extension base="tns:AbstractOutputType">
				<xs:sequence>
					<xs:element name="foreignOrderId" type="tns:String30Type"/>
					<xs:element name="orderId" type="xs:long"/>
					<xs:element name="creationDate" type="xs:dateTime"/>
					<xs:element name="settlementCurrencyCode" type="tns:CurrencyCodeType"/>
					<xs:element name="itemsTotal" type="xs:decimal"/>
					<xs:element name="itemsTotalPrecision" type="xs:int" minOccurs="0"/>
					<xs:element name="serviceChargeTotal" type="xs:decimal"/>
					<xs:element name="serviceChargeTotalPrecision" type="xs:int" minOccurs="0"/>
					<xs:element name="grandTotal" type="xs:decimal"/>
					<xs:element name="grandTotalPrecision" type="xs:int" minOccurs="0"/>
					<xs:element name="item">
						<xs:complexType>
							<xs:sequence>
								<xs:element name="foreignItemId" type="tns:String30Type"/>
								<xs:element name="rateIndicator">
									<xs:simpleType>
										<xs:restriction base="xs:string">
											<xs:enumeration value="CARDED"/>
											<xs:enumeration value="LIVE"/>
										</xs:restriction>
									</xs:simpleType>
								</xs:element>
								<xs:element name="clientRate" type="xs:decimal"/>
								<xs:element name="clientRateFormat">
									<xs:simpleType>
										<xs:restriction base="xs:string">
											<xs:enumeration value="IN"/>
											<xs:enumeration value="PER"/>
										</xs:restriction>
									</xs:simpleType>
								</xs:element>
								<xs:element name="clientRatePrecision" type="xs:int"/>
								<xs:element name="paymentAmount" type="xs:decimal"/>
								<xs:element name="paymentCurrencyCode" type="tns:CurrencyCodeType"/>
								<xs:element name="paymentAmountPrecision" type="xs:int"/>
								<xs:element name="settlementAmount" type="xs:decimal"/>
								<xs:element name="settlementAmountPrecision" type="xs:int"/>
								<xs:element name="feeAmount" type="xs:decimal"/>
								<xs:element name="feeAmountInPaymentCurrency" type="xs:decimal"/>
							</xs:sequence>
						</xs:complexType>
					</xs:element>
				</xs:sequence>
			</xs:extension>
		</xs:complexContent>
	</xs:complexType>
</xs:schema>

<quoteOrderRequest xmlns="http://api.globalpay.convera.com">
    <clientId>123456789</clientId>
    <foreignOrderId>456789</foreignOrderId>
    <settlementCurrencyCode>GBP</settlementCurrencyCode>
    <item>
        <foreignItemId>O12345</foreignItemId>
        <paymentTypeCode>WIRE</paymentTypeCode>
        <paymentCurrencyCode>AUD</paymentCurrencyCode>
        <amount>123.56</amount>
        <amountType>PAYMENT</amountType>
        <language>en_GB</language>
        <payer>
            <firstName>Bob</firstName>
            <lastName>Smith</lastName>
            <address>123 Test Ave</address>
            <city>New York</city>
            <state>NY</state>
            <zip>123567</zip>
            <countryCode>USA</countryCode>
            <email>test_email@company.com</email>
            <payerId>123456789</payerId>
            <custom>01/01/2023</custom>
            <custom>Test Field</custom>
            <custom>Other custom field</custom>
        </payer>
        <payerBank>
            <name>Bank of America</name>
            <address1>123 Banking Ave</address1>
            <address2></address2>
            <city>New York</city>
            <state>NY</state>
            <zip>123567</zip>
            <countryCode>USA</countryCode>
            <accountCurrency>USD</accountCurrency>
            <routingCode>123456</routingCode>
            <swiftCode>ABC12345678</swiftCode>
        </payerBank>
        <remitter>
            <name>Test Remitter</name>
            <address1>123 Remitting Drive</address1>
            <city>New York</city>
            <state>NY</state>
            <countryCode>USA</countryCode>
            <phone>1234567890</phone>
            <remitterType>
                <individual>
                    <occupation>Accountant</occupation>
                    <identification>
                        <document>passport</document>
                        <documentRef>123123</documentRef>
                        <documentCountry>GBR</documentCountry>
                    </identification>
                    <alias>Bill</alias>
                    <dob>1980-01-01</dob>
                    <residentCountry>USA</residentCountry>
                    <employerName>Convera</employerName>
                </individual>
            </remitterType>
        </remitter>
        <remitterBank>
            <name>Bank of America NA</name>
            <address1>123 Remitting Bank Ave</address1>
            <city></city>
            <state></state>
            <countryCode>USA</countryCode>
            <routingCode>123456</routingCode>
            <swiftCode>ABC12345678</swiftCode>
            <branchCode>12345678</branchCode>
            <account>
                <type>checking</type>
                <holders>self</holders>
                <currency>USD</currency>
                <openingDate>2022-12-07</openingDate>
                <accountNumber>123456789</accountNumber>
            </account>
            <bankContact>
                <name>John Smith</name>
                <email>name@company.com</email>
                <phone>1234567890</phone>
            </bankContact>
        </remitterBank>
    </item>
</quoteOrderRequest>

<quoteOrderResponse xmlns="http://api.globalpay.convera.com">
    <status success="true"/>
    <foreignOrderId>123456</foreignOrderId>
    <orderId>123456789</orderId>
    <creationDate>2023-01-01</creationDate>
    <settlementCurrencyCode>GBP</settlementCurrencyCode>
    <itemsTotal>101.78</itemsTotal>
    <itemsTotalPrecision>2</itemsTotalPrecision>
    <serviceChargeTotal>1</serviceChargeTotal>
    <serviceChargeTotalPrecision>0</serviceChargeTotalPrecision>
    <grandTotal>100.78</grandTotal>
    <grandTotalPrecision>2</grandTotalPrecision>
    <item>
        <foreignItemId>123456</foreignItemId>
        <rateIndicator>LIVE</rateIndicator>
        <clientRate>1.5497</clientRate>
        <clientRateFormat>PER</clientRateFormat>
        <clientRatePrecision>4</clientRatePrecision>
        <paymentAmount>157.73</paymentAmount>
        <paymentCurrencyCode>USD</paymentCurrencyCode>
        <paymentAmountPrecision>2</paymentAmountPrecision>
        <settlementAmount>100.78</settlementAmount>
        <settlementAmountPrecision>2</settlementAmountPrecision>
        <feeAmount>1</feeAmount>
        <feeAmountInPaymentCurrency>0</feeAmountInPaymentCurrency>
    </item>
</quoteOrderResponse>

200

200OK

400BadRequest

401Unauthorized