Get Order Status

Provides latest status on an order

<?xml version="1.0" encoding="UTF-8"?> <!-- edited with XMLSpy v2014 rel. 2 (x64) (http://www.altova.com) by Meeraj Kunnumpurath (Service Symphony Ltd) --> <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="orderStatusResponse" type="tns:OrderStatusResponseType"/> <xs:element name="orderStatusRequest" type="tns:OrderStatusRequestType"/> <xs:complexType name="OrderStatusRequestType"> <xs:complexContent> <xs:extension base="tns:AbstractInputType"> <xs:sequence> <xs:element name="clientId" type="xs:long" minOccurs="0"/> <xs:element name="orderId" type="xs:long" minOccurs="1" maxOccurs="10"/> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:complexType name="OrderStatusResponseType"> <xs:complexContent> <xs:extension base="tns:AbstractOutputType"> <xs:sequence> <xs:element name="order" maxOccurs="unbounded"> <xs:complexType> <xs:sequence> <xs:element name="orderId" type="xs:long"/> <xs:element name="clientId" type="xs:int"/> <xs:element name="foreignOrderId" type="tns:String30Type"/> <xs:element name="item" maxOccurs="unbounded"> <xs:complexType> <xs:sequence> <xs:element name="dealReference" type="xs:string"/> <xs:element name="status" type="xs:string"/> <xs:element name="statusChangeDate" type="xs:dateTime"/> <xs:element name="foreignItemId" type="tns:String30Type"/> <xs:element name="confirmationNumber" type="xs:string"/> <xs:element name="disbursedDate" type="xs:date" minOccurs="0"/> <xs:element name="itemId" type="xs:long"/> <xs:element name="associatedItemId" type="xs:long" minOccurs="0"/> <xs:element name="expectedReceiveCurrency" type="tns:CurrencyCodeType"/> <xs:element name="expectedReceiveAmount" type="xs:decimal"/> <xs:element name="expectedReceiveAmountPrecision" type="xs:int"/> <xs:element name="expectedPayoutCurrency" type="tns:CurrencyCodeType"/> <xs:element name="expectedPayoutAmount" type="xs:decimal"/> <xs:element name="expectedPayoutAmountPrecision" type="xs:int"/> <xs:element name="actualReceiveCurrency" type="tns:CurrencyCodeType" minOccurs="0"/> <xs:element name="actualReceiveAmount" type="xs:decimal" minOccurs="0"/> <xs:element name="actualReceiveAmountPrecision" type="xs:int" minOccurs="0"/> <xs:element name="actualPayoutCurrency" type="tns:CurrencyCodeType" minOccurs="0"/> <xs:element name="actualPayoutAmount" type="xs:decimal" minOccurs="0"/> <xs:element name="actualPayoutAmountPrecision" type="xs:int" minOccurs="0"/> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> </xs:schema>
<orderStatusRequest xmlns="http://api.globalpay.convera.com"> <orderId>100001234567</orderId> </orderStatusRequest>
<orderStatusResponse xmlns="http://api.globalpay.convera.com"> <status success="true"/> <order> <orderId>100001234567</orderId> <clientId>1000123456</clientId> <foreignOrderId>O12345</foreignOrderId> <item> <dealReference>REF123456</dealReference> <status>DEAL_CREATED</status> <statusChangeDate>2023-06-04T22:32:51.000Z</statusChangeDate> <foreignItemId>I12345</foreignItemId> <confirmationNumber>N/A</confirmationNumber> <itemId>100001234567</itemId> <expectedReceiveCurrency>USD</expectedReceiveCurrency> <expectedReceiveAmount>174.34</expectedReceiveAmount> <expectedReceiveAmountPrecision>2</expectedReceiveAmountPrecision> <expectedPayoutCurrency>GBP</expectedPayoutCurrency> <expectedPayoutAmount>100.19</expectedPayoutAmount> <expectedPayoutAmountPrecision>2</expectedPayoutAmountPrecision> </item> </order> </orderStatusResponse>
Body Params

requestData

int64
int64
required
Responses

Language
URL
Choose an example:
application/xml
Convera Logo

© 2022 All Rights Reserved