JiwaAPI

SO_PaymentsQuery

**SO_PaymentsQuery** Parameters:
Name	Parameter	Data Type	Required
PaymentID	query	string	No
PaymentIDStartsWith	query	string	No
PaymentIDEndsWith	query	string	No
PaymentIDContains	query	string	No
PaymentIDLike	query	string	No
PaymentIDBetween	query	string[]	No
PaymentIDIn	query	string[]	No
InvoiceHistoryID	query	string	No
InvoiceHistoryIDStartsWith	query	string	No
InvoiceHistoryIDEndsWith	query	string	No
InvoiceHistoryIDContains	query	string	No
InvoiceHistoryIDLike	query	string	No
InvoiceHistoryIDBetween	query	string[]	No
InvoiceHistoryIDIn	query	string[]	No
InvoiceID	query	string	No
InvoiceIDStartsWith	query	string	No
InvoiceIDEndsWith	query	string	No
InvoiceIDContains	query	string	No
InvoiceIDLike	query	string	No
InvoiceIDBetween	query	string[]	No
InvoiceIDIn	query	string[]	No
PaymentTypeID	query	string	No
PaymentTypeIDStartsWith	query	string	No
PaymentTypeIDEndsWith	query	string	No
PaymentTypeIDContains	query	string	No
PaymentTypeIDLike	query	string	No
PaymentTypeIDBetween	query	string[]	No
PaymentTypeIDIn	query	string[]	No
PaymentRef	query	string	No
PaymentRefStartsWith	query	string	No
PaymentRefEndsWith	query	string	No
PaymentRefContains	query	string	No
PaymentRefLike	query	string	No
PaymentRefBetween	query	string[]	No
PaymentRefIn	query	string[]	No
AmountPaid	query	decimal?	No
AmountPaidGreaterThanOrEqualTo	query	decimal?	No
AmountPaidGreaterThan	query	decimal?	No
AmountPaidLessThan	query	decimal?	No
AmountPaidLessThanOrEqualTo	query	decimal?	No
AmountPaidNotEqualTo	query	decimal?	No
AmountPaidBetween	query	Nullable<Decimal>[]	No
AmountPaidIn	query	Nullable<Decimal>[]	No
PaymentDate	query	DateTime?	No
PaymentDateGreaterThanOrEqualTo	query	DateTime?	No
PaymentDateGreaterThan	query	DateTime?	No
PaymentDateLessThan	query	DateTime?	No
PaymentDateLessThanOrEqualTo	query	DateTime?	No
PaymentDateNotEqualTo	query	DateTime?	No
PaymentDateBetween	query	DateTime[]	No
PaymentDateIn	query	DateTime[]	No
AuthorisationStatus	query	short?	No
AuthorisationStatusGreaterThanOrEqualTo	query	short?	No
AuthorisationStatusGreaterThan	query	short?	No
AuthorisationStatusLessThan	query	short?	No
AuthorisationStatusLessThanOrEqualTo	query	short?	No
AuthorisationStatusNotEqualTo	query	short?	No
AuthorisationStatusBetween	query	short[]	No
AuthorisationStatusIn	query	short[]	No
AuthorisationNumber	query	string	No
AuthorisationNumberStartsWith	query	string	No
AuthorisationNumberEndsWith	query	string	No
AuthorisationNumberContains	query	string	No
AuthorisationNumberLike	query	string	No
AuthorisationNumberBetween	query	string[]	No
AuthorisationNumberIn	query	string[]	No
ProcessPayment	query	bool?	No
Processed	query	bool?	No
DBTransID	query	string	No
DBTransIDStartsWith	query	string	No
DBTransIDEndsWith	query	string	No
DBTransIDContains	query	string	No
DBTransIDLike	query	string	No
DBTransIDBetween	query	string[]	No
DBTransIDIn	query	string[]	No
PaymentGatewayReturnCode	query	int?	No
PaymentGatewayReturnCodeGreaterThanOrEqualTo	query	int?	No
PaymentGatewayReturnCodeGreaterThan	query	int?	No
PaymentGatewayReturnCodeLessThan	query	int?	No
PaymentGatewayReturnCodeLessThanOrEqualTo	query	int?	No
PaymentGatewayReturnCodeNotEqualTo	query	int?	No
PaymentGatewayReturnCodeBetween	query	Nullable<Int32>[]	No
PaymentGatewayReturnCodeIn	query	Nullable<Int32>[]	No
PaymentGatewayReturnMessage	query	string	No
PaymentGatewayReturnMessageStartsWith	query	string	No
PaymentGatewayReturnMessageEndsWith	query	string	No
PaymentGatewayReturnMessageContains	query	string	No
PaymentGatewayReturnMessageLike	query	string	No
PaymentGatewayReturnMessageBetween	query	string[]	No
PaymentGatewayReturnMessageIn	query	string[]	No
AmountTendered	query	decimal?	No
AmountTenderedGreaterThanOrEqualTo	query	decimal?	No
AmountTenderedGreaterThan	query	decimal?	No
AmountTenderedLessThan	query	decimal?	No
AmountTenderedLessThanOrEqualTo	query	decimal?	No
AmountTenderedNotEqualTo	query	decimal?	No
AmountTenderedBetween	query	Nullable<Decimal>[]	No
AmountTenderedIn	query	Nullable<Decimal>[]	No

**QueryBase** Parameters:
Name	Parameter	Data Type	Required
Skip	form	int?	No
Take	form	int?	No
OrderBy	form	string	No
OrderByDesc	form	string	No
Include	form	string	No
Fields	form	string	No
Meta	form	Dictionary<string, string>	No

**SO_Payments** Parameters:
Name	Parameter	Data Type	Required
PaymentID	form	string	No
InvoiceHistoryID	form	string	No
InvoiceID	form	string	No
PaymentTypeID	form	string	No
PaymentRef	form	string	No
AmountPaid	form	decimal?	No
PaymentDate	form	DateTime	No
AuthorisationStatus	form	short	No
AuthorisationNumber	form	string	No
ProcessPayment	form	bool	No
Processed	form	bool	No
DBTransID	form	string	No
PaymentGatewayReturnCode	form	int?	No
PaymentGatewayReturnMessage	form	string	No
AmountTendered	form	decimal?	No

**QueryResponse<T>** Parameters:
Name	Parameter	Data Type	Required
Offset	form	int	No
Total	form	int	No
Results	form	List<T>	No
Meta	form	Dictionary<string, string>	No
ResponseStatus	form	ResponseStatus	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/SO_PaymentsQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SO_PaymentsQuery xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Tables">
  <Fields xmlns="http://schemas.servicestack.net/types">String</Fields>
  <Include xmlns="http://schemas.servicestack.net/types">String</Include>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <OrderBy xmlns="http://schemas.servicestack.net/types">String</OrderBy>
  <OrderByDesc xmlns="http://schemas.servicestack.net/types">String</OrderByDesc>
  <Skip xmlns="http://schemas.servicestack.net/types">0</Skip>
  <Take xmlns="http://schemas.servicestack.net/types">0</Take>
  <AmountPaid>0</AmountPaid>
  <AmountPaidBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </AmountPaidBetween>
  <AmountPaidGreaterThan>0</AmountPaidGreaterThan>
  <AmountPaidGreaterThanOrEqualTo>0</AmountPaidGreaterThanOrEqualTo>
  <AmountPaidIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </AmountPaidIn>
  <AmountPaidLessThan>0</AmountPaidLessThan>
  <AmountPaidLessThanOrEqualTo>0</AmountPaidLessThanOrEqualTo>
  <AmountPaidNotEqualTo>0</AmountPaidNotEqualTo>
  <AmountTendered>0</AmountTendered>
  <AmountTenderedBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </AmountTenderedBetween>
  <AmountTenderedGreaterThan>0</AmountTenderedGreaterThan>
  <AmountTenderedGreaterThanOrEqualTo>0</AmountTenderedGreaterThanOrEqualTo>
  <AmountTenderedIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </AmountTenderedIn>
  <AmountTenderedLessThan>0</AmountTenderedLessThan>
  <AmountTenderedLessThanOrEqualTo>0</AmountTenderedLessThanOrEqualTo>
  <AmountTenderedNotEqualTo>0</AmountTenderedNotEqualTo>
  <AuthorisationNumber>String</AuthorisationNumber>
  <AuthorisationNumberBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </AuthorisationNumberBetween>
  <AuthorisationNumberContains>String</AuthorisationNumberContains>
  <AuthorisationNumberEndsWith>String</AuthorisationNumberEndsWith>
  <AuthorisationNumberIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </AuthorisationNumberIn>
  <AuthorisationNumberLike>String</AuthorisationNumberLike>
  <AuthorisationNumberStartsWith>String</AuthorisationNumberStartsWith>
  <AuthorisationStatus>0</AuthorisationStatus>
  <AuthorisationStatusBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:short>0</d2p1:short>
  </AuthorisationStatusBetween>
  <AuthorisationStatusGreaterThan>0</AuthorisationStatusGreaterThan>
  <AuthorisationStatusGreaterThanOrEqualTo>0</AuthorisationStatusGreaterThanOrEqualTo>
  <AuthorisationStatusIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:short>0</d2p1:short>
  </AuthorisationStatusIn>
  <AuthorisationStatusLessThan>0</AuthorisationStatusLessThan>
  <AuthorisationStatusLessThanOrEqualTo>0</AuthorisationStatusLessThanOrEqualTo>
  <AuthorisationStatusNotEqualTo>0</AuthorisationStatusNotEqualTo>
  <DBTransID>String</DBTransID>
  <DBTransIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DBTransIDBetween>
  <DBTransIDContains>String</DBTransIDContains>
  <DBTransIDEndsWith>String</DBTransIDEndsWith>
  <DBTransIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DBTransIDIn>
  <DBTransIDLike>String</DBTransIDLike>
  <DBTransIDStartsWith>String</DBTransIDStartsWith>
  <InvoiceHistoryID>String</InvoiceHistoryID>
  <InvoiceHistoryIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </InvoiceHistoryIDBetween>
  <InvoiceHistoryIDContains>String</InvoiceHistoryIDContains>
  <InvoiceHistoryIDEndsWith>String</InvoiceHistoryIDEndsWith>
  <InvoiceHistoryIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </InvoiceHistoryIDIn>
  <InvoiceHistoryIDLike>String</InvoiceHistoryIDLike>
  <InvoiceHistoryIDStartsWith>String</InvoiceHistoryIDStartsWith>
  <InvoiceID>String</InvoiceID>
  <InvoiceIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </InvoiceIDBetween>
  <InvoiceIDContains>String</InvoiceIDContains>
  <InvoiceIDEndsWith>String</InvoiceIDEndsWith>
  <InvoiceIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </InvoiceIDIn>
  <InvoiceIDLike>String</InvoiceIDLike>
  <InvoiceIDStartsWith>String</InvoiceIDStartsWith>
  <PaymentDate>0001-01-01T00:00:00</PaymentDate>
  <PaymentDateBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </PaymentDateBetween>
  <PaymentDateGreaterThan>0001-01-01T00:00:00</PaymentDateGreaterThan>
  <PaymentDateGreaterThanOrEqualTo>0001-01-01T00:00:00</PaymentDateGreaterThanOrEqualTo>
  <PaymentDateIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </PaymentDateIn>
  <PaymentDateLessThan>0001-01-01T00:00:00</PaymentDateLessThan>
  <PaymentDateLessThanOrEqualTo>0001-01-01T00:00:00</PaymentDateLessThanOrEqualTo>
  <PaymentDateNotEqualTo>0001-01-01T00:00:00</PaymentDateNotEqualTo>
  <PaymentGatewayReturnCode>0</PaymentGatewayReturnCode>
  <PaymentGatewayReturnCodeBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:int>0</d2p1:int>
  </PaymentGatewayReturnCodeBetween>
  <PaymentGatewayReturnCodeGreaterThan>0</PaymentGatewayReturnCodeGreaterThan>
  <PaymentGatewayReturnCodeGreaterThanOrEqualTo>0</PaymentGatewayReturnCodeGreaterThanOrEqualTo>
  <PaymentGatewayReturnCodeIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:int>0</d2p1:int>
  </PaymentGatewayReturnCodeIn>
  <PaymentGatewayReturnCodeLessThan>0</PaymentGatewayReturnCodeLessThan>
  <PaymentGatewayReturnCodeLessThanOrEqualTo>0</PaymentGatewayReturnCodeLessThanOrEqualTo>
  <PaymentGatewayReturnCodeNotEqualTo>0</PaymentGatewayReturnCodeNotEqualTo>
  <PaymentGatewayReturnMessage>String</PaymentGatewayReturnMessage>
  <PaymentGatewayReturnMessageBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </PaymentGatewayReturnMessageBetween>
  <PaymentGatewayReturnMessageContains>String</PaymentGatewayReturnMessageContains>
  <PaymentGatewayReturnMessageEndsWith>String</PaymentGatewayReturnMessageEndsWith>
  <PaymentGatewayReturnMessageIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </PaymentGatewayReturnMessageIn>
  <PaymentGatewayReturnMessageLike>String</PaymentGatewayReturnMessageLike>
  <PaymentGatewayReturnMessageStartsWith>String</PaymentGatewayReturnMessageStartsWith>
  <PaymentID>String</PaymentID>
  <PaymentIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </PaymentIDBetween>
  <PaymentIDContains>String</PaymentIDContains>
  <PaymentIDEndsWith>String</PaymentIDEndsWith>
  <PaymentIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </PaymentIDIn>
  <PaymentIDLike>String</PaymentIDLike>
  <PaymentIDStartsWith>String</PaymentIDStartsWith>
  <PaymentRef>String</PaymentRef>
  <PaymentRefBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </PaymentRefBetween>
  <PaymentRefContains>String</PaymentRefContains>
  <PaymentRefEndsWith>String</PaymentRefEndsWith>
  <PaymentRefIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </PaymentRefIn>
  <PaymentRefLike>String</PaymentRefLike>
  <PaymentRefStartsWith>String</PaymentRefStartsWith>
  <PaymentTypeID>String</PaymentTypeID>
  <PaymentTypeIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </PaymentTypeIDBetween>
  <PaymentTypeIDContains>String</PaymentTypeIDContains>
  <PaymentTypeIDEndsWith>String</PaymentTypeIDEndsWith>
  <PaymentTypeIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </PaymentTypeIDIn>
  <PaymentTypeIDLike>String</PaymentTypeIDLike>
  <PaymentTypeIDStartsWith>String</PaymentTypeIDStartsWith>
  <ProcessPayment>false</ProcessPayment>
  <Processed>false</Processed>
</SO_PaymentsQuery>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfSO_Payments7kRqkrSv xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Offset>0</Offset>
  <Total>0</Total>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Tables">
    <d2p1:SO_Payments>
      <d2p1:_x003C_AmountPaid_x003E_k__BackingField>0</d2p1:_x003C_AmountPaid_x003E_k__BackingField>
      <d2p1:_x003C_AmountTendered_x003E_k__BackingField>0</d2p1:_x003C_AmountTendered_x003E_k__BackingField>
      <d2p1:_x003C_AuthorisationNumber_x003E_k__BackingField>String</d2p1:_x003C_AuthorisationNumber_x003E_k__BackingField>
      <d2p1:_x003C_AuthorisationStatus_x003E_k__BackingField>0</d2p1:_x003C_AuthorisationStatus_x003E_k__BackingField>
      <d2p1:_x003C_DBTransID_x003E_k__BackingField>String</d2p1:_x003C_DBTransID_x003E_k__BackingField>
      <d2p1:_x003C_InvoiceHistoryID_x003E_k__BackingField>String</d2p1:_x003C_InvoiceHistoryID_x003E_k__BackingField>
      <d2p1:_x003C_InvoiceID_x003E_k__BackingField>String</d2p1:_x003C_InvoiceID_x003E_k__BackingField>
      <d2p1:_x003C_PaymentDate_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_PaymentDate_x003E_k__BackingField>
      <d2p1:_x003C_PaymentGatewayReturnCode_x003E_k__BackingField>0</d2p1:_x003C_PaymentGatewayReturnCode_x003E_k__BackingField>
      <d2p1:_x003C_PaymentGatewayReturnMessage_x003E_k__BackingField>String</d2p1:_x003C_PaymentGatewayReturnMessage_x003E_k__BackingField>
      <d2p1:_x003C_PaymentID_x003E_k__BackingField>String</d2p1:_x003C_PaymentID_x003E_k__BackingField>
      <d2p1:_x003C_PaymentRef_x003E_k__BackingField>String</d2p1:_x003C_PaymentRef_x003E_k__BackingField>
      <d2p1:_x003C_PaymentTypeID_x003E_k__BackingField>String</d2p1:_x003C_PaymentTypeID_x003E_k__BackingField>
      <d2p1:_x003C_ProcessPayment_x003E_k__BackingField>false</d2p1:_x003C_ProcessPayment_x003E_k__BackingField>
      <d2p1:_x003C_Processed_x003E_k__BackingField>false</d2p1:_x003C_Processed_x003E_k__BackingField>
    </d2p1:SO_Payments>
  </Results>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
</QueryResponseOfSO_Payments7kRqkrSv>