Get Disbursed Orders Report

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Provides details of settlement and disbursements from Holding accounts for the client at a disbursement level

<?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="disbursalReportResponse" type="tns:DisbursalReportResponseType"/>
	<xs:element name="disbursalReportRequest" type="tns:DisbursalReportRequestType"/>
	<xs:complexType name="DisbursalReportRequestType">
		<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"/>
					<xs:element name="endDate" type="xs:date"/>
				</xs:sequence>
			</xs:extension>
		</xs:complexContent>
	</xs:complexType>
	<xs:complexType name="DisbursalReportResponseType">
		<xs:complexContent>
			<xs:extension base="tns:AbstractOutputType">
				<xs:sequence>
					<xs:element name="item" minOccurs="0" maxOccurs="unbounded">
						<xs:complexType>
							<xs:sequence>
								<xs:element name="orderId" type="xs:long"/>
								<xs:element name="dealReference" type="xs:string"/>
								<xs:element name="confirmationNumber" type="xs:string"/>
								<xs:element name="disbursedDate" type="xs:date"/>
								<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"/>
								<xs:element name="actualReceiveAmount" type="xs:decimal"/>
								<xs:element name="actualReceiveAmountPrecision" type="xs:int"/>
								<xs:element name="actualPayoutCurrency" type="tns:CurrencyCodeType"/>
								<xs:element name="actualPayoutAmount" type="xs:decimal"/>
								<xs:element name="actualPayoutAmountPrecision" type="xs:int"/>
							</xs:sequence>
						</xs:complexType>
					</xs:element>
				</xs:sequence>
			</xs:extension>
		</xs:complexContent>
	</xs:complexType>
</xs:schema>
<disbursalReportRequest xmlns="http://api.globalpay.convera.com">
    <startDate>2022-01-01</startDate>
    <endDate>2023-03-01</endDate>
</disbursalReportRequest>
<disbursalReportResponse xmlns="http://api.globalpay.convera.com">
    <status>
        <success>true</success>
    </status>
    <item>
        <orderId>123456789</orderId>
        <dealReference>REF123456789</dealReference>
        <confirmationNumber>123456789</confirmationNumber>
        <itemId>123</itemId>
        <associatedItemId>456</associatedItemId>
        <expectedReceiveCurrency>USD</expectedReceiveCurrency>
        <expectedReceiveAmount>123.12</expectedReceiveAmount>
        <expectedReceiveAmountPrecision>2</expectedReceiveAmountPrecision>
        <expectedPayoutCurrency>USD</expectedPayoutCurrency>
        <expectedPayoutAmount>123.12</expectedPayoutAmount>
        <actualReceiveCurrency>USD</actualReceiveCurrency>
        <actualReceiveAmount>0</actualReceiveAmount>
        <actualReceiveAmountPrecision>0</actualReceiveAmountPrecision>
        <actualPayoutCurrency>USD</actualPayoutCurrency>
        <actualPayoutAmount>0</actualPayoutAmount>
        <actualPayoutAmountPrecision>0</actualPayoutAmountPrecision>
    </item>
</disbursalReportResponse>
Body Params

requestData

int64
string
string
Headers
string
enum
Defaults to application/xml

Generated from available response content types

Allowed:
string
enum
Defaults to application/xml

Generated from available request content types

Allowed:
Responses

Language
URL
LoadingLoading…
Response
Choose an example:
application/xml
Convera Logo

© 2022 All Rights Reserved