JiwaAPI

<back to all web services

SO_PaymentDetailsQuery

Requires Authentication
SO_PaymentDetailsQuery Parameters:
NameParameterData TypeRequiredDescription
PaymentIDquerystringNo
PaymentIDStartsWithquerystringNo
PaymentIDEndsWithquerystringNo
PaymentIDContainsquerystringNo
PaymentIDLikequerystringNo
PaymentIDBetweenquerystring[]No
PaymentIDInquerystring[]No
CardNumberquerystringNo
CardNumberStartsWithquerystringNo
CardNumberEndsWithquerystringNo
CardNumberContainsquerystringNo
CardNumberLikequerystringNo
CardNumberBetweenquerystring[]No
CardNumberInquerystring[]No
CardExpiryqueryDateTime?No
CardExpiryGreaterThanOrEqualToqueryDateTime?No
CardExpiryGreaterThanqueryDateTime?No
CardExpiryLessThanqueryDateTime?No
CardExpiryLessThanOrEqualToqueryDateTime?No
CardExpiryNotEqualToqueryDateTime?No
CardExpiryBetweenqueryNullable<DateTime>[]No
CardExpiryInqueryNullable<DateTime>[]No
CardHolderquerystringNo
CardHolderStartsWithquerystringNo
CardHolderEndsWithquerystringNo
CardHolderContainsquerystringNo
CardHolderLikequerystringNo
CardHolderBetweenquerystring[]No
CardHolderInquerystring[]No
BankNamequerystringNo
BankNameStartsWithquerystringNo
BankNameEndsWithquerystringNo
BankNameContainsquerystringNo
BankNameLikequerystringNo
BankNameBetweenquerystring[]No
BankNameInquerystring[]No
BSBNquerystringNo
BSBNStartsWithquerystringNo
BSBNEndsWithquerystringNo
BSBNContainsquerystringNo
BSBNLikequerystringNo
BSBNBetweenquerystring[]No
BSBNInquerystring[]No
BankAccquerystringNo
BankAccStartsWithquerystringNo
BankAccEndsWithquerystringNo
BankAccContainsquerystringNo
BankAccLikequerystringNo
BankAccBetweenquerystring[]No
BankAccInquerystring[]No
AccountNamequerystringNo
AccountNameStartsWithquerystringNo
AccountNameEndsWithquerystringNo
AccountNameContainsquerystringNo
AccountNameLikequerystringNo
AccountNameBetweenquerystring[]No
AccountNameInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SO_PaymentDetails Parameters:
NameParameterData TypeRequiredDescription
PaymentIDformstringNo
CardNumberformstringNo
CardExpiryformDateTime?No
CardHolderformstringNo
BankNameformstringNo
BSBNformstringNo
BankAccformstringNo
AccountNameformstringNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

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_PaymentDetailsQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SO_PaymentDetailsQuery 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>
  <AccountName>String</AccountName>
  <AccountNameBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </AccountNameBetween>
  <AccountNameContains>String</AccountNameContains>
  <AccountNameEndsWith>String</AccountNameEndsWith>
  <AccountNameIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </AccountNameIn>
  <AccountNameLike>String</AccountNameLike>
  <AccountNameStartsWith>String</AccountNameStartsWith>
  <BSBN>String</BSBN>
  <BSBNBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </BSBNBetween>
  <BSBNContains>String</BSBNContains>
  <BSBNEndsWith>String</BSBNEndsWith>
  <BSBNIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </BSBNIn>
  <BSBNLike>String</BSBNLike>
  <BSBNStartsWith>String</BSBNStartsWith>
  <BankAcc>String</BankAcc>
  <BankAccBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </BankAccBetween>
  <BankAccContains>String</BankAccContains>
  <BankAccEndsWith>String</BankAccEndsWith>
  <BankAccIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </BankAccIn>
  <BankAccLike>String</BankAccLike>
  <BankAccStartsWith>String</BankAccStartsWith>
  <BankName>String</BankName>
  <BankNameBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </BankNameBetween>
  <BankNameContains>String</BankNameContains>
  <BankNameEndsWith>String</BankNameEndsWith>
  <BankNameIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </BankNameIn>
  <BankNameLike>String</BankNameLike>
  <BankNameStartsWith>String</BankNameStartsWith>
  <CardExpiry>0001-01-01T00:00:00</CardExpiry>
  <CardExpiryBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </CardExpiryBetween>
  <CardExpiryGreaterThan>0001-01-01T00:00:00</CardExpiryGreaterThan>
  <CardExpiryGreaterThanOrEqualTo>0001-01-01T00:00:00</CardExpiryGreaterThanOrEqualTo>
  <CardExpiryIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </CardExpiryIn>
  <CardExpiryLessThan>0001-01-01T00:00:00</CardExpiryLessThan>
  <CardExpiryLessThanOrEqualTo>0001-01-01T00:00:00</CardExpiryLessThanOrEqualTo>
  <CardExpiryNotEqualTo>0001-01-01T00:00:00</CardExpiryNotEqualTo>
  <CardHolder>String</CardHolder>
  <CardHolderBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CardHolderBetween>
  <CardHolderContains>String</CardHolderContains>
  <CardHolderEndsWith>String</CardHolderEndsWith>
  <CardHolderIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CardHolderIn>
  <CardHolderLike>String</CardHolderLike>
  <CardHolderStartsWith>String</CardHolderStartsWith>
  <CardNumber>String</CardNumber>
  <CardNumberBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CardNumberBetween>
  <CardNumberContains>String</CardNumberContains>
  <CardNumberEndsWith>String</CardNumberEndsWith>
  <CardNumberIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CardNumberIn>
  <CardNumberLike>String</CardNumberLike>
  <CardNumberStartsWith>String</CardNumberStartsWith>
  <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>
</SO_PaymentDetailsQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfSO_PaymentDetails7kRqkrSv 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_PaymentDetails>
      <d2p1:_x003C_AccountName_x003E_k__BackingField>String</d2p1:_x003C_AccountName_x003E_k__BackingField>
      <d2p1:_x003C_BSBN_x003E_k__BackingField>String</d2p1:_x003C_BSBN_x003E_k__BackingField>
      <d2p1:_x003C_BankAcc_x003E_k__BackingField>String</d2p1:_x003C_BankAcc_x003E_k__BackingField>
      <d2p1:_x003C_BankName_x003E_k__BackingField>String</d2p1:_x003C_BankName_x003E_k__BackingField>
      <d2p1:_x003C_CardExpiry_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_CardExpiry_x003E_k__BackingField>
      <d2p1:_x003C_CardHolder_x003E_k__BackingField>String</d2p1:_x003C_CardHolder_x003E_k__BackingField>
      <d2p1:_x003C_CardNumber_x003E_k__BackingField>String</d2p1:_x003C_CardNumber_x003E_k__BackingField>
      <d2p1:_x003C_PaymentID_x003E_k__BackingField>String</d2p1:_x003C_PaymentID_x003E_k__BackingField>
    </d2p1:SO_PaymentDetails>
  </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_PaymentDetails7kRqkrSv>